[GRASS-SVN] r49903 - grass/trunk/lib/init
svn_grass at osgeo.org
svn_grass at osgeo.org
Sun Dec 25 16:28:55 EST 2011
Author: martinl
Date: 2011-12-25 13:28:55 -0800 (Sun, 25 Dec 2011)
New Revision: 49903
Modified:
grass/trunk/lib/init/grass7.html
Log:
major update of grass7 manual page
Modified: grass/trunk/lib/init/grass7.html
===================================================================
--- grass/trunk/lib/init/grass7.html 2011-12-25 19:30:06 UTC (rev 49902)
+++ grass/trunk/lib/init/grass7.html 2011-12-25 21:28:55 UTC (rev 49903)
@@ -12,63 +12,41 @@
<h2>NAME</h2>
-<em><b>grass70</b></em> - The GRASS startup program<br>
+<em><b>grass70</b></em> - The GRASS startup program.<br>
<h2>SYNOPSIS</h2>
-<b>grass70</b> [<b>-</b>] [<b>-v</b>] [<b>-h | -help | --help</b>]
- [<b>-text | -gui | -wxpython | -wx]</b>]
+<b>grass70</b> [<b>-h</b> | <b>-help</b> | <b>--help</b>] [<b>-v</b> | <b>--version</b>]
+ [<b>-c</b> | <b>-c geofile</b> | <b>-c EPSG:code</b>]
+ [<b>-text</b> | <b>-gui</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>grass70</em> startup program will remember both the desired user
-interface and mapset. Thus, the next time the user runs GRASS, typing
-<em>grass70</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 (wxPython) the <em>grass70</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>grass70</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 and exits
-<dt><b>-h</b> <b>-help</b> <b>--help</b>
-<dd> Prints a brief usage message
+<dt><b>-v</b> | <b>--verbose</b>
+<dd> Prints the version of GRASS and exits
-<dt><b>-text</b>
-<dd> Indicates that the text based user interface should be used
+<dt><b>-c</b>
+<dd> Creates new GRASS unprojected location in specified GISDBASE
-<dt><b>-gui</b> (or <b>-wxpython</b>, or <b>-wx</b>)
-<dd> Indicates that the new Python based graphical user interface should be used
+<dt><b>-c geofile</b>
+<dd> Creates new GRASS projected location in specified GISDBASE based on georeferenced file
-<dt><b>-v</b> <b>--version</b>
-<dd> Prints the version of GRASS and exits
+<dt><b>-c EPSG:code</b>
+<dd> Creates new GRASS projected location in specified GISDBASE with given EPSG code
+<dt><b>-text</b>
+<dd> Indicates that Text-based User Interface should be used
+
+<dt><b>-gui</b>
+<dd> Indicates that Graphical User Interface
+(<em><a href="wxGUI.html">wxGUI</a></em>) should be used
</dl>
<h3>Parameters:</h3>
@@ -76,7 +54,7 @@
<dl>
<dt><b>GISDBASE</b>
<dd> Initial database directory which should be a fully qualified path
- (e.g., /usr/local/share/grassdata)
+ (e.g., <tt>/usr/local/share/grassdata</tt>)
<dt><b>LOCATION_NAME</b>
<dd> Initial location directory which is a subdirectory of GISDBASE
@@ -84,170 +62,185 @@
<dt><b>MAPSET</b>
<dd> Initial mapset directory which is a subdirectory of LOCATION_NAME
</dl>
+</dl>
-<br>
-<b><i>Note</i></b>- These parameters must be specified in one of the
+<i>Note</i>: 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>
+<pre>
+ MAPSET
+ LOCATION_NAME/MAPSET
+ GISDBASE/LOCATION_NAME/MAPSET
+</pre>
-<h2>ENVIRONMENT VARIABLES</h2>
+<h2>DESCRIPTION</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>This command is used to launch GRASS GIS. It will parse the command
+line arguments and then initialize GRASS for the user. Since GRASS
+modules require a specific environment, this program must be called
+before any other GRASS module 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.
-<p>In addition to these shell environment variables GRASS maintains a number of
-GIS environment variables in the <tt>$HOME/.grass7/rc</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.
+<p>The startup program will remember both the desired user interface
+and mapset. Thus, the next time the user runs GRASS, typing
+<em>grass70</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 (<b>-gui</b>)
+the <em>grass70</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>grass70</em> will automatically switch back
+to the text user interface mode.
-<h3>User Interface Environment Variable</h3>
+<h2>ENVIRONMENT VARIABLES</h2>
-<p>The <em>grass70</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>grass70</em> is run, then
-it will be created and then saved in the <tt>$HOME/.grass7/rc</tt> file for
-the next time GRASS is run. It can be set to "text" or "wxpython".
+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>There is an order of precedence in the way <em>grass70</em> determines the user
-interface to use. The following is the hierarchy from highest precedence to
-lowest.
+<p>In addition to these shell environment variables GRASS maintains a
+number of GIS environment variables in the <tt>$HOME/.grass7/rc</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 <em><a href="variables.html">implemented GRASS variables</a></em>
+for more information. The rest of this help page will only consider
+shell environment variables.
-<dl>
- <dt><b>Interface precedence</b>
- <dd>• Command line argument<br>
- • Environment variable GRASS_GUI<br>
- • Value set in <tt>$HOME/.grass7/rc</tt><br>
- • Default value - wxpython
-</dl>
+<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 <tt>export</tt> the variables for them to
+propogate).
-<h3>Python Environment Variables</h3>
+<h3>User Interface Environment Variable</h3>
-<p>If you choose to use the wxPython interface, then
-the following environment variables can be used to override your
-system default <tt>python</tt> command.
+<p>The <em>grass70</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>grass70</em> is run, then it will be created and then saved
+in the <tt>$HOME/.grass7/rc</tt> file for the next time GRASS is
+run. It can be set to <tt>text</tt> or <tt>gui</tt>.
-<dl>
-<dt><b>GRASS_PYTHON</b>
-<dd> Command to use to override <tt>python</tt>
-</dl>
+<p>There is an order of precedence in the way <em>grass70</em>
+determines the user interface to use. The following is the hierarchy
+from highest precedence to lowest.
+<ol>
+ <li>Command line argument
+ <li>Environment variable GRASS_GUI
+ <li>Value set in <tt>$HOME/.grass7/rc</tt> (GUI)
+ <li>Default value - <tt>gui</tt>
+</ol>
+<h3>Python Environment Variables</h3>
-<h4>Example Use of GRASS Python Environment Variable</h4>
+<p>If you choose to use <em><a href="wxGUI.html">wxGUI</a></em>
+interface, then the GRASS_PYTHON environment variable can be used to
+override your system default <tt>python</tt> command.
-<p>Suppose your system has Python 2.4 installed and you install a personal
-version of the Python 2.5 binaries under <tt>$HOME/bin</tt>. You can use
-the above variables to have GRASS use the Python 2.5 binaries instead.
+<p>Suppose for example your system has Python 2.4 installed and you
+install a personal version of the Python 2.5 binaries
+under <tt>$HOME/bin</tt>. You can use the above variables to have
+GRASS use the Python 2.5 binaries instead.
-
-<h4>Example Use of the GRASS Python Environment Variable</h4>
-<p><pre>
+<div class="code"><pre>
GRASS_PYTHON=python2.5
-</pre>
+</pre></div>
+<h3>Addon Path to Extra User Scripts</h3>
+This environment variable allows the user to extend the GRASS program
+search paths to include locally developed/installed GRASS modules or
+user scripts.
-<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>
+<div class="code"><pre>
GRASS_ADDON_PATH=/usr/mytools
GRASS_ADDON_PATH=/usr/mytools:/usr/local/othertools
-</pre>
+</pre></div>
<p>In this example above path(s) would be added to the standard GRASS path
environment.
+<h3>Addon Base for Extra Local GRASS Addon Modules</h3>
-<h3>HTML browser variable</h3>
+This environment variable allows the user to extend the GRASS program
+search paths to include locally installed
+(see <em><a href="g.extension.html">g.extension</a></em> for details)
+<a href="http://grass.osgeo.org/wiki/GRASS_AddOns">GRASS Addon</a>
+modules which are not distributed with the standard GRASS release.
+<div class="code"><pre>
+ GRASS_ADDON_BASE=/usr/grass-addons
+ GRASS_ADDON_BASE=/usr/grass-addons:/usr/local/grass-addons
+</pre></div>
-The GRASS_HTML_BROWSER environment variable allows the user to set the HTML
-web browser to use for dispalying help pages.
+<p>In this example above path(s) would be added to the standard GRASS path
+environment.
+<p>If not defined by user, this variable is set by GRASS startup program
+to <tt>$HOME/.grass7/addons</tt> on GNU/Linux
+and <tt>$APPDATA\GRASS7\addons</tt> on MS Windows.
-<h3>Location Environment Variables</h3>
+<h3>HTML Browser Variable</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:
+The GRASS_HTML_BROWSER environment variable allows the user to set the
+HTML web browser to use for displaying help pages.
-<dl>
+<h3>Location Environment Variables</h3>
-<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.
+<p>The <b>Synopsis</b> section above describes 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:
-<dt><b>GISDBASE</b>
+<dl>
+<dt>LOCATION
+<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>GISDBASE
<dd> Initial database directory which should be a fully qualified path
- (eg /usr/local/share/grassdata)
-
-<dt><b>LOCATION_NAME</b>
+ (eg <tt>/usr/local/share/grassdata</tt>)
+<dt>LOCATION_NAME
<dd> Initial location directory which is a subdirectory of GISDBASE
-
-<dt><b>MAPSET</b>
+<dt>MAPSET
<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.
+If the GRASS_BATCH_JOB 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>grass70</b>
-<dd> Start GRASS using the default user interface. The user will be prompted
- to choose the appropriate location and mapset.
+<dd> Start GRASS using the default user interface. The user will be
+ prompted to choose the appropriate location and mapset.
<dt><b>grass70 -gui</b>
-<dd> Start GRASS using the wxPython based user interface. The user will be
+<dd> Start GRASS using the graphical user interface. The user will be
prompted to choose the appropriate location and mapset.
<dt><b>grass70 -text</b>
-<dd> Start GRASS using the text based user interface. The user will be
+<dd> Start GRASS using the text-based user interface. The user will be
prompted to choose the appropriate location and mapset.
<dt><b>grass70 ~/grassdata/spearfish60/user1</b>
-<dd> Start GRASS using the default user interface and automatically launch
- into the given mapset, bypassing the mapset selection menu.
+<dd> Start GRASS using the default user interface and automatically
+ launch into the given mapset, bypassing the mapset selection menu.
<dt><b>grass70 -gui -</b>
-<dd> Start GRASS using the wxPython based user interface and try to obtain
- the location and mapset from environment variables.
-
+<dd> Start GRASS using the graphical user interface and try to
+ obtain the location and mapset from environment variables.
</dl>
@@ -257,126 +250,107 @@
variables</i> (see above) can be used to specify the mapset to use.
The following are some possible examples.
-<dl>
+<h4>Example 1</h4>
-<dt><b>Example 1</b>
-<dd> The environment variables are defined as follows:<br><br>
+The environment variables are defined as follows:
- 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>
-
- grass70 -<br><br>
-
- GRASS will start with the mapset defined by LOCATION since the LOCATION
- variable overrides the other variables.<br><br>
+<div class="code"><pre>
+LOCATION = /usr/local/share/grassdata/spearfish60/PERMANENT
+GISDBASE = /usr/local/share/grassdata
+LOCATION_NAME = spearfish60
+MAPSET = PERMANENT
+</pre></div>
-<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>
-
- grass70 -<br><br>
-
- GRASS will start with the mapset defined by
- GISDBASE/LOCATION_NAME/MAPSET.<br><br>
+Start GRASS with the following command:
-<dt><b>Example 3</b>
-<dd> The environment variables are defined as follows:<br><br>
+<div class="code"><pre>
+grass70 -
+</pre></div>
+
+GRASS will start with the mapset defined by LOCATION since the LOCATION
+variable overrides the other variables.
+
+<h4>Example 2</h4>
+
+The environment variables are defined as follows:
- 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>
-
- grass70 /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>
+<div class="code"><pre>
+GISDBASE = /usr/local/share/grassdata
+LOCATION_NAME = spearfish60
+MAPSET = PERMANENT
+</pre></div>
-<dt><b>Example 4</b>
-<dd> The environment variables are defined as follows:<br><br>
+Start GRASS with the following command:
+
+<div class="code"><pre>
+grass70 -
+</pre></div>
- 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>
-
- grass70 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>
+GRASS will start with the mapset defined by
+GISDBASE/LOCATION_NAME/MAPSET.
-<dt><b>Example 5</b>
-<dd> The environment variables are defined as follows:<br><br>
+<div class="code"><pre>
+grass70 /usr/home/grass/data/thailand/forests
+</pre></div>
- 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>
-
- grass70 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>
+GRASS will start with the
+mapset <tt>/home/grass/data/thailand/forests</tt> which overrides the
+environment variables.
-</dl>
+<div class="code"><pre>
+grass70 swamps
+</pre></div>
+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.
-<h2>CAVEAT</h2>
+<div class="code"><pre>
+grass70 thailand/forests
+</pre></div>
-If you start GRASS using the wxPython interface you must have a <tt>python</tt>
-command in your $PATH variable. That is, the command must be named
-<tt>python</tt> and not something like <tt>python2.5</tt>. Rarely some Python
-installations do not create a <tt>python</tt> command. In these cases the system
-administrator must create an appropriate link to the actual <tt>python</tt>
-program.
+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.
-<p>Furthermore, if you have more than one version of Python 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>python</tt>.
+<h2>CAVEAT</h2>
+If you start GRASS using the <em><a href="wxGUI.html">wxGUI</a></em>
+interface you must have a <tt>python</tt> command in your $PATH
+variable. That is, the command must be named
+<tt>python</tt> and not something like <tt>python2.5</tt>. Rarely some
+Python installations do not create a <tt>python</tt> command. In these
+cases you can override <tt>python</tt> by GRASS_PYTHON environmental
+variable.
-<h2>FILES</h2>
+<p>Furthermore, if you have more than one version of Python installed,
+make sure that the version you want to use with GRASS is set by
+GRASS_PYTHON environmental variable.
-<em>$UNIX_BIN/grass70</em> - GRASS startup program (Linux, MacOSX etc.)<br>
-<em>$WINDOWS_BIN/grass70.bat</em> - GRASS startup program (MS-Windows)<br>
-<em>$GISBASE/etc/Init.sh</em> - GRASS initialization script called by
- <em>grass70</em><br>
-<em>$GISBASE/etc/wxpython/gis_set.py</em> - Python 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.osgeo.org">GRASS Web site</a>
-<p><a href="http://download.osgeo.org/grass/grass7_progman/">GRASS 7 Programmer's Manual</a>
+List of <a href="variables.html">GRASS environment variables</a>
+<p>
+<a href="http://grass.osgeo.org">GRASS Web site</a><br>
+<a href="http://grass.osgeo.org/wiki">GRASS User Wiki</a><br>
+<a href="http://trac.osgeo.org/grass">GRASS Bug Tracker</a><br>
+<a href="http://grass.osgeo.org/programming7">GRASS 7 Programmer's
+ Manual</a>
+
<h2>AUTHORS (of this page)</h2>
Justin Hickey<br>
Markus Neteler<br>
-Hamish Bowman
+Hamish Bowman<br>
+<a href="http://geo.fsv.cvut.cz/gwiki/Landa">Martin
+Landa</a>, <a href="http://www.cvut.cz">Czech Technical University in
+Prague</a>, Czech Republic
-<p><i>Last changed: $Date$</i>
-<HR>
-<p><a href=index.html>Help Index</a>
-
+<p>
+<i>Last changed: $Date$</i>
+<hr>
+<p><a href="index.html">Help Index</a>
+<p>© 2003-2011 <a href="http://grass.osgeo.org">GRASS Development Team</a></p>
</body>
</html>
More information about the grass-commit
mailing list