File: configuration.html

package info (click to toggle)
gamgi 0.15.8-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 19,672 kB
  • sloc: ansic: 155,977; xml: 105,764; makefile: 537; perl: 171; sh: 5
file content (164 lines) | stat: -rw-r--r-- 4,782 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">

<head>
<title>GAMGI Installation: Configuration</title>
<link rel="icon" type="image/png" href="../icon/gamgi16.png"/>
<link rel="stylesheet" type="text/css" href="../css/base.css"/>
<link rel="stylesheet" type="text/css" href="../css/board.css"/>
</head>

<body>

<div class="board">
<div>Installation Configuration</div><div>&nbsp;</div>
</div>

<div class="contents">

<h3>Run GAMGI from any directory</h3>

If GAMGI was compiled from source and the GAMGI root directory is, 
for example, <b>/home/carlos/gamgi</b>, then the full path for the 
executable is <b>/home/carlos/gamgi/gamgi_version/src/gamgi</b>.

<p/>

To make GAMGI run from any directory, we suggest making first 
a soft link from <b>gamgi</b> to <b>gamgi_version</b>, 
in the GAMGI root directory:

<pre><b>
cd /home/carlos/gamgi
ln -s gamgi_version gamgi
</b></pre>

and then a second soft link from <b>/usr/local/bin</b>
to the executable, typing as root:

<pre><b>
cd /usr/local/bin
ln -s /home/carlos/gamgi/gamgi/src/gamgi gamgi
</b></pre>

Because <b>/usr/local/bin</b> is one of the standard directories
where Unix systems search for executables, GAMGI will be found 
when called from any directory on the system.

<p/>

Changing to a new version of GAMGI requires only to change
the local link (in <b>/home/carlos/gamgi</b>), while the global
link (in <b>/usr/local/bin</b>), that needs root permission, 
must be done only the first time GAMGI is installed.
  
<h3>Set the GAMGI_HELP environment variable</h3>

To inform GAMGI where the help documentation files are, set the 
<b>GAMGI_HELP</b> environment variable, pointing to the <b>doc/</b> 
directory, where the documentation starts. This can be done by adding 
a line as this, to the user <b>.bashrc</b> file:

<pre>
<b>GAMGI_HELP=/home/carlos/gamgi/gamgi/doc; export GAMGI_HELP</b>
</pre>

Alternatively, this information can abe given directly in GAMGI,
selecting Help->Config, or in a config block in a GAMGI XML file.

<h3>Set the GAMGI_TEXT environment variable</h3>

To inform GAMGI where are the Truetype font files,
set the <b>GAMGI_TEXT</b> environment variable, pointing
to the directory with the files. This can be done by adding
a line as this, to the user <b>.bashrc</b> file:

<pre>
<b>GAMGI_TEXT=/usr/X11R6/lib/X11/fonts/truetype/; export GAMGI_TEXT</b>
</pre>

GAMGI comes with all the needed font files, in the directory
<b>$GAMGI/gamgi_version/src/io/fonts/</b>, in case they
are not available in the system.

<h3>Set the BROWSER environment variable</h3>

GAMGI can be configured to automatically launch a browser
pointing to the adequate help web page. To inform GAMGI which 
browser should be launched, set the <b>BROWSER</b> environment
variable, pointing to the browser executable. This can be done
by adding a line as this, to the user <b>.bashrc</b> file:

<pre>
<b>BROWSER=/usr/X11/bin/mozilla; export BROWSER</b>
</pre>

Alternatively, this data can also be given directly in GAMGI,
selecting Help->Config, or in a config block in a GAMGI XML file.

<h3>Install pnmtopng, pnmtojpeg and pnmtotiff</h3>

These tools come with every Linux distribution and are usually installed
by default. GAMGI uses them to export .png, .jpeg and .tiff files.

<h3>Define automatic default settings</h3>

More experienced users, can define their own default settings
in a XML file and load it automatically everytime GAMGI is called.
This can be done, just adding a line as this, to the user <b>.bashrc</b> file:

<pre>
<b>alias gamgi='gamgi my_defaults.xml'</b>
</pre>

This works even if other files are called. For example, calling:

<pre>
<b>gamgi my_objects.xml</b>
</pre>

would be understood as:

<pre>
<b>gamgi my_defaults.xml my_objects.xml</b>
</pre>

and defaults in my_defaults.xml would be already applied to objects
in my_objects.xml.

<h3>Install the man page</h3>

Go to directory <b>doc/man/</b> in GAMGI documentation, compress 
the man page and copy it to the system <b>man1</b> directory, with
the name <b>gamgi.1.gz</b>:

<pre>
<b>cd /home/carlos/gamgi/gamgi/doc/man
gzip page
cp page.gz /usr/share/man/man1/gamgi.1.gz</b>
</pre>

<h3>Get quick access to the files</h3>

For developers, who need to have quick access to the code,
we suggest creating a few alias in <b>.bashrc</b>
to permit easy navigation through the GAMGI directories,
for example:

<pre>
<b>alias sgi='cd /home/carlos/gamgi/gamgi/src'</b>
</pre>

These alias remain the same when a new GAMGI version is installed, 
if the second symlink described above was made.

</div>

<div id="bottom">
<a href="../index.shtml">Home</a>
</div>

</body>
</html>