File: grass6.html

package info (click to toggle)
grass 6.0.2-6
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 40,044 kB
  • ctags: 31,303
  • sloc: ansic: 321,125; tcl: 25,676; sh: 11,176; cpp: 10,098; makefile: 5,025; fortran: 1,846; yacc: 493; lex: 462; perl: 133; sed: 1
file content (359 lines) | stat: -rw-r--r-- 10,801 bytes parent folder | download
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
 <TITLE>GRASS 6</TITLE>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>

<body bgcolor="white">

<H2>NAME</H2>

<EM><B>grass60</B></EM>  - The GRASS startup program<BR>

<H2>SYNOPSIS</H2>

<B>grass60</B> [<B>-</B>] [<B>-v</B>] [<B>-h | -help | --help</B>] [<B>-text | -tcltk | -gui</B>]
    [[[<B>&lt;GISDBASE&gt;/</B>]<B>&lt;LOCATION_NAME&gt;/</B>]
    	<B>&lt;MAPSET&gt;</B>]

<BR>

<H2>DESCRIPTION</H2>

<P>
This program is used to start GRASS. It will parse the command line arguments
and then initialize GRASS for the user. Since GRASS programs require a
specific environment, this program must be called before any other GRASS
program can run. The command line arguments are optional and provide the user
with a method to indicate the desired user interface, as well as the desired
mapset to work on.

<H2>FEATURES</H2>

<P>
The GRASS program will save both the desired user interface and mapset.
Thus, the next time the user runs GRASS, typing <EM>grass60</EM> (without any
options) will start grass with the previous settings for the user interface
and mapset.

<P>
If you specify a graphical user interface (eg Tcl/Tk) the <EM>grass60</EM>
program will try to verify that the system you specified exists and that you
can access it successfully. If any of these checks fail, then <EM>grass60</EM>
will automatically switch back to the text user interface mode.

<H2>OPTIONS</H2>

<P>
All command line options are optional.

<H3>Flags:</H3>

<DL>

<DT><B>-</B>
<DD> Tries to start GRASS using location environment variables (see below)

<DT><B>-h</B> <B>-help</B> <B>--help</B>
<DD> Prints a brief usage message

<DT><B>-text</B>
<DD> Indicates that the text based user interface should be used

<DT><B>-gui</B> (or <B>-tcltk</B>)
<DD> Indicates that the Tcl/Tk based graphical user interface should be used

<DT><B>-v</B> <B>--version</B>
<DD> Prints the version for GRASS

</DL>

<H3>Parameters:</H3>

<DL>
<DT><B>GISDBASE</B>
<DD> Initial database directory which should be a fully qualified path
    (eg /usr/local/share/grassdata)

<DT><B>LOCATION_NAME</B>
<DD> Initial location directory which is a subdirectory of GISDBASE

<DT><B>MAPSET</B>
<DD> Initial mapset directory which is a subdirectory of LOCATION_NAME

<DT><B>Note</B>
<DD> You must specify one of the following<BR><BR>
    MAPSET<BR>
    LOCATION_NAME/MAPSET<BR>
    GISDBASE/LOCATION_NAME/MAPSET<BR>
    
</DL>

<H2>ENVIRONMENT VARIABLES</H2>

<H3>User Interface Environment Variable</H3>

<P>
The <EM>grass60</EM> program will check for the existence of an environment
variable called GRASS_GUI which indicates the type of user interface for
GRASS to use. If this variable is not set when <EM>grass60</EM> is run, then
it will be created and then saved in the $HOME/.grassrc6 file for the next
time GRASS is run.

<P>
There is an order of precedence in the way <EM>grass60</EM> determines the user
interface to use. The following is the hierarchy from highest precedence to
lowest.

<P>
The user may add own environment variable settings to $HOME/.grassrc6 file
which are used during next startup of GRASS (list of 
<a href=variables.html>implemented environment variables</a>). 

<DL>

<DT><B>Interface precedence</B>
<DD>Command line argument<BR>
    Environment variable GRASS_GUI<BR>
    Value set in $HOME/.grassrc6<BR>
    Default value - currently tcltk

</DL>

<H3>Tcl/Tk Environment Variables</H3>

<P>
If you choose to use the Tcl/Tk graphical user interface, then the following
environment variables can be used to override your system default tclsh and
wish commands. See the section immediately following the variable descriptions
for an example.

<DL>

<DT><B>GRASS_TCLSH</B>
<DD> Command to use to override tclsh

<DT><B>GRASS_WISH</B>
<DD> Command to use to override wish

</DL>

<H4>Example Use of GRASS Tcl/Tk Environment Variables</H4>

<P>
Suppose your system has Tcl/Tk 8.0 installed and you install your personal
version of Tcl/Tk 8.3 binaries installed under $HOME/bin. You can use the
above variables to have GRASS use the Tcl/Tk 8.3 binaries instead.

<P>
GRASS_TCLSH = $HOME/bin/tclsh8.3<BR>
GRASS_WISH  = $HOME/bin/wish8.3

<H3>Addon path to extra local GRASS modules</H3>

This environment variables allows to extend the GRASS paths to locally
developed/installed modules which are not distributes through the standard
release of GRASS.
<P>
GRASS_ADDON_PATH=/usr/mytools<BR>
GRASS_ADDON_PATH=/usr/mytools:/usr/local/othertools

<P>
In this example above path(s) would be added to the standard GRASS path
environment.


<H3>Location Environment Variables</H3>

<P>
The Synopsis and Options sections above describe options that can be used to
set the location and mapset that GRASS will use. These values can also be set
with environment variables. However, specifying the location and mapset
variables on the command line will override these environment variables. The
available variables are as follows:

<DL>

<DT><B>LOCATION</B>
<DD> A fully qualified path to a mapset 
    (eg /usr/local/share/grassdata/spearfish60/PERMANENT). This environment variable
    overrides the GISDBASE, LOCATION_NAME, and MAPSET variables.

<DT><B>GISDBASE</B>
<DD> Initial database directory which should be a fully qualified path
    (eg /usr/local/share/grassdata)

<DT><B>LOCATION_NAME</B>
<DD> Initial location directory which is a subdirectory of GISDBASE

<DT><B>MAPSET</B>
<DD> Initial mapset directory which is a subdirectory of LOCATION_NAME

</DL>

<P>
There are a variety of ways in which these variables can be used to specify
the mapset to use. The following are some possible examples.

<DL>

<DT><B>Example 1</B>
<DD> The environment variables are defined as follows:<BR><BR>
    
    LOCATION = /usr/local/share/grassdata/spearfish60/PERMANENT<BR>
    GISDBASE = /usr/local/share/grassdata<BR>
    LOCATION_NAME = spearfish60<BR>
    MAPSET = PERMANENT<BR><BR>
    
    Start GRASS with the following command:<BR><BR>
    
    grass60 -<BR><BR>
    
    GRASS will start with the mapset defined by LOCATION since the LOCATION
    variable overrides the other variables.<BR><BR>

<DT><B>Example 2</B>
<DD> The environment variables are defined as follows:<BR><BR>
    
    GISDBASE = /usr/local/share/grassdata<BR>
    LOCATION_NAME = spearfish60<BR>
    MAPSET = PERMANENT<BR><BR>
    
    Start GRASS with the following command:<BR><BR>
    
    grass60 -<BR><BR>
    
    GRASS will start with the mapset defined by
    GISDBASE/LOCATION_NAME/MAPSET.<BR><BR>

<DT><B>Example 3</B>
<DD> The environment variables are defined as follows:<BR><BR>
    
    LOCATION = /usr/local/share/grassdata/spearfish60/PERMANENT<BR>
    GISDBASE = /usr/local/share/grassdata<BR>
    LOCATION_NAME = spearfish60<BR>
    MAPSET = PERMANENT<BR><BR>
    
    Start GRASS with the following command:<BR><BR>
    
    grass60 /usr/home/grass/data/thailand/forests<BR><BR>
    
    GRASS will start with the mapset /home/grass/data/thailand/forests which
    overrides the environment variables.<BR><BR>

<DT><B>Example 4</B>
<DD> The environment variables are defined as follows:<BR><BR>
    
    LOCATION = /usr/local/share/grassdata/spearfish60/PERMANENT<BR>
    GISDBASE = /usr/local/share/grassdata<BR>
    LOCATION_NAME = spearfish60<BR>
    MAPSET = PERMANENT<BR><BR>
    
    Start GRASS with the following command:<BR><BR>
    
    grass60 swamps<BR><BR>
    
    GRASS will start with the mapset defined by GISDBASE/LOCATION_NAME/swamps
    since the command line argument for the mapset overrides the environment
    variable MAPSET.<BR><BR>

<DT><B>Example 5</B>
<DD> The environment variables are defined as follows:<BR><BR>
    
    LOCATION = /usr/local/share/grassdata/spearfish60/PERMANENT<BR>
    GISDBASE = /usr/local/share/grassdata<BR>
    LOCATION_NAME = spearfish60<BR>
    MAPSET = PERMANENT<BR><BR>
    
    Start GRASS with the following command:<BR><BR>
    
    grass60 thailand/forests<BR><BR>
    
    GRASS will start with the mapset defined by GISDBASE/thailand/forests
    since the command line arguments for the location and mapset overrides
    the environment variables LOCATION_NAME and MAPSET.<BR><BR>

</DL>

<H3>Note</H3>

<P>
Note that you will need to set these variables using the appropriate method
required for the UNIX shell that you use.

<H2>EXAMPLES</H2>

<P>
The following are some examples of how you could start GRASS

<DL>

<DT><B>grass60</B>
<DD> Start GRASS using the default user interface. The user will be prompted
    to choose the appropriate location and mapset.

<DT><B>grass60 -tcltk</B>
<DD> Start GRASS using the Tcl/Tk based user interface. The user will be
    prompted to choose the appropriate location and mapset.

<DT><B>grass60 -text</B>
<DD> Start GRASS using the text based user interface. The user will be
    prompted to choose the appropriate location and mapset.

<DT><B>grass60 -tcltk -</B>
<DD> Start GRASS using the Tcl/Tk based user interface and try to obtain
    the location and mapset from environment variables.

<DT><B>Other examples</B>
<DD> See the <B>Location Environment Variables</B> section for further
    examples.

</DL>

<H2>BUGS AND CAVEAT</H2>

<P>
If you start GRASS using the Tcl/Tk interface you must have a <EM>wish</EM>
command in your $PATH variable. That is, the command must be named
<EM>wish</EM> and not something like <EM>wish8.3</EM>. By default, a Tcl/Tk
installation does not create a <EM>wish</EM> command. Thus, the system
administrator must create an appropriate link to the actual wish program.

<P>
For example, suppose Tcl/Tk 8.3 programs are installed in /usr/local/bin. Then
the system administrator should go to the /usr/local/bin directory and run the
commands <EM>ln -s wish8.3 wish</EM> and <EM>ln -s tclsh8.3 tclsh</EM> to
properly install Tcl/Tk for use with GRASS.

<P>
Furthermore, if you have more than one version of Tcl/Tk installed, make sure
that the version you want to use with GRASS is the first version found in
your $PATH variable. GRASS searches your $PATH variable until it finds the 
first version of <EM>wish</EM>.

<H2>FILES</H2>

<EM>$UNIX_BIN/grass60</EM> - GRASS startup program<BR><BR>
<EM>$GISBASE/etc/Init.sh</EM> - GRASS initialization script called by
    <EM>grass60</EM><BR><BR>
<EM>$GISBASE/tcltkgrass/script/gis_set.tcl</EM> - Tcl/Tk script to set the
    location and mapset to use. Called by <EM>Init.sh</EM><BR><BR>

<H2>SEE ALSO</H2>

List of <a href=variables.html>implemented GRASS environment variables</a>.
<p>
<a href="http://grass.itc.it">GRASS Web site</a>

<H2>AUTHORS (of this page)</H2>

Justin Hickey<br>
Markus Neteler

<p><i>Last changed: $Date: 2005/05/06 12:50:17 $</i>
<HR>
<P><a href=index.html>Help Index</a>

</body>
</html>