/usr/share/doc/grass-doc/html/grass6.html is in grass-doc 6.4.3-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 | <!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">
<link rel="stylesheet" href="grassdocs.css" type="text/css">
</head>
<body bgcolor="white">
<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
<h2>NAME</h2>
<em><b>grass64</b></em> - The GRASS startup program<br>
<h2>SYNOPSIS</h2>
<b>grass64</b> [<b>-</b>] [<b>-v</b>] [<b>-h | -help | --help</b>]
[<b>-text | -gui | -tcltk | -oldtcltk | -wxpython | -wx]</b>]
[[[<b><GISDBASE>/</b>]<b><LOCATION_NAME>/</b>]
<b><MAPSET></b>]
<br>
<h2>DESCRIPTION</h2>
<p>
This command is used to launch GRASS GIS. 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 <em>grass64</em> startup program will remember both the desired user
interface and mapset. Thus, the next time the user runs GRASS, typing
<em>grass64</em> (without any options) will start GRASS with the previous
settings for the user interface and mapset selected.
<p>
If you specify a graphical user interface (Tcl/Tk or wxPython) the <em>grass64</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>grass64</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 old Tcl/Tk based graphical user interface should be used
<dt><b>-oldtcltk</b>
<dd> Indicates that the even older Tcl/Tk based graphical user interface should be used
<dt><b>-wxpython</b> (or <b>-wx</b>)
<dd> Indicates that the new Python based graphical user interface should be used
<dt><b>-v</b> <b>--version</b>
<dd> Prints the version of GRASS and exits
</dl>
<h3>Parameters:</h3>
<dl>
<dt><b>GISDBASE</b>
<dd> Initial database directory which should be a fully qualified path
(e.g., <tt>/usr/local/share/grassdata</tt>)
<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>
<br>
<b><i>Note</i></b>- These parameters must be specified in one of the
following ways:
<dl><dd>
MAPSET<br>
LOCATION_NAME/MAPSET<br>
GISDBASE/LOCATION_NAME/MAPSET<br>
</dl>
<h2>ENVIRONMENT VARIABLES</h2>
A number of environment variables are available at GRASS startup to assist
with automation and customization. Most users will not need to bother with
these.
<p>
In addition to these shell environment variables GRASS maintains a number of
GIS environment variables in the <tt>$HOME/.grassrc6</tt> file. User changes
to this file will be read during the next startup of GRASS. If this file
becomes corrupted the user may edit it by hand or remove it to start afresh.
See the list of <a href=variables.html>implemented GRASS variables</a> for
more information.
The rest of this help page will only consider shell environment variables.
<h3>User Interface Environment Variable</h3>
<p>
The <em>grass64</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>grass64</em> is run, then
it will be created and then saved in the <tt>$HOME/.grassrc6</tt> file for
the next time GRASS is run. In addition to "text", "tcltk" or "wxpython",
the GRASS_GUI variable can be set to the name of the Tcl/Tk GUI to use, for
example "gis.m" or "d.m".
<p>
There is an order of precedence in the way <em>grass64</em> determines the user
interface to use. The following is the hierarchy from highest precedence to
lowest.
<dl>
<dt><b>Interface precedence</b>
<dd>• Command line argument<br>
• Environment variable GRASS_GUI<br>
• Value set in <tt>$HOME/.grassrc6</tt><br>
• Default value - currently gis.m
</dl>
<h3>Tcl/Tk and Python 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
<tt>tclsh</tt> and <tt>wish</tt> commands.
<dl>
<dt><b>GRASS_TCLSH</b>
<dd> Command to use to override <tt>tclsh</tt>
<dt><b>GRASS_WISH</b>
<dd> Command to use to override <tt>wish</tt>
<dt><b>GRASS_PYTHON</b>
<dd> Command to use to override <tt>python</tt>
</dl>
<h4>Example Use of GRASS Tcl/Tk Environment Variables</h4>
<p>
Suppose your system has Tcl/Tk 8.3 installed and you install a personal
version of the Tcl/Tk 8.5 binaries under <tt>$HOME/bin</tt>. You can use
the above variables to have GRASS use the Tcl/Tk 8.5 binaries instead.
<p>
<pre>
GRASS_TCLSH = $HOME/bin/tclsh8.5
GRASS_WISH = $HOME/bin/wish8.5
</pre>
<h4>Example Use of the GRASS Python Environment Variable</h4>
<p>
<pre>
GRASS_PYTHON=python2.5
</pre>
<h3>Addon path to extra local GRASS modules</h3>
This environment variable allows the user to extend the GRASS program search
paths to include locally developed/installed addon modules which are not
distributed with the standard GRASS release.
<p>
<pre>
GRASS_ADDON_PATH=/usr/mytools
GRASS_ADDON_PATH=/usr/mytools:/usr/local/othertools
</pre>
<p>
In this example above path(s) would be added to the standard GRASS path
environment.
<h3>HTML browser variable</h3>
The GRASS_HTML_BROWSER environment variable allows the user to set the HTML
web browser to use for dispalying help pages.
<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 <tt>/usr/local/share/grassdata/spearfish60/PERMANENT</tt>). 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 <tt>/usr/local/share/grassdata</tt>)
<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>
<h3>Running non-interactive batch jobs</h3>
If the <tt>GRASS_BATCH_JOB</tt> environment variable is set to the <i>full</i>
path and filename of a shell script then GRASS will be launched in a
non-interactive way and the script will be run. The script itself can be
interactive if that is what the user requires. When it is finished GRASS
will automatically exit using the exit-success code given by the script.
The script file must have its executable bit set.
<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. (e.g. in a Bash shell you must
"export" the variables for them to propogate)
<h2>EXAMPLES</h2>
<p>
The following are some examples of how you could start GRASS
<dl>
<dt><b>grass64</b>
<dd> Start GRASS using the default user interface. The user will be prompted
to choose the appropriate location and mapset.
<dt><b>grass64 -gui</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>grass64 -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>grass64 ~/grassdata/spearfish60/user1</b>
<dd> Start GRASS using the default user interface and automatically launch
into the given mapset, bypassing the mapset selection menu.
<dt><b>grass64 -gui -</b>
<dd> Start GRASS using the Tcl/Tk based user interface and try to obtain
the location and mapset from environment variables.
</dl>
<h3>Other examples</h3>
There are a variety of ways in which the <i>location environment
variables</i> (see above) 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>
grass64 -<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>
grass64 -<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>
grass64 /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>
grass64 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>
grass64 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>
<h2>CAVEAT</h2>
If you start GRASS using the Tcl/Tk interface you must have a <tt>wish</tt>
command in your $PATH variable. That is, the command must be named
<tt>wish</tt> and not something like <tt>wish8.3</tt>. By default, some Tcl/Tk
installations do not create a <tt>wish</tt> command. In these cases the system
administrator must create an appropriate link to the actual <tt>wish</tt>
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 "<tt>ln -s wish8.3 wish</tt>" and "<tt>ln -s tclsh8.3 tclsh</tt>" 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 <tt>$PATH</tt> variable. GRASS searches your <tt>$PATH</tt> variable
until it finds the first version of <tt>wish</tt>.
<h2>FILES</h2>
<em>$UNIX_BIN/grass64</em> - GRASS startup program (Linux, MacOSX etc.)<br>
<em>$WINDOWS_BIN/grass64.bat</em> - GRASS startup program (MS-Windows)<br>
<em>$GISBASE/etc/Init.sh</em> - GRASS initialization script called by
<em>grass64</em><br>
<em>$GISBASE/etc/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 GIS environment variables</a>.
<p>
<a href="http://grass.osgeo.org">GRASS GIS Web site</a>
<p>
<a href="http://grass.osgeo.org/programming6/">GRASS GIS 6 Programmer's Manual</a>
<h2>AUTHORS (of this page)</h2>
Justin Hickey<br>
Markus Neteler<br>
Hamish Bowman
<p>
<i>Last changed: $Date: 2012-08-30 23:09:43 -0700 (Thu, 30 Aug 2012) $</i>
<hr>
<p>
<a href=index.html>Help Index</a>
</body>
</html>
|