grass5(1)		      Grass User's Manual		     grass5(1)



NNAAMMEE
       ggrraassss55  - The GRASS startup program


SSYYNNOOPPSSIISS
       ggrraassss55  [--]  [--hh  ||  --hheellpp  || ----hheellpp] [--tteexxtt || --ttccllttkk] [--vv || ----vveerrssiioonn]
       [[[//]//] ]

DDEESSCCRRIIPPTTIIOONN
       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	inter-
       face, as well as the desired mapset to work on.

FFEEAATTUURREESS
       The GRASS program will save both the desired user interface and mapset.
       Thus, the next time the user runs GRASS,  typing  _g_r_a_s_s_5  (without  any
       options)  will  start  grass  with  the	previous settings for the user
       interface and mapset.


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

OOPPTTIIOONNSS
       All command line options are optional.

   FFllaaggss::
       --      Tries to start GRASS using location environment  variables  (see
	      below)

       --hh --hheellpp ----hheellpp
	      Prints a brief usage message

       --tteexxtt  Indicates that the text based user interface should be used

       --ttccllttkk Indicates  that the Tcl/Tk based graphical user interface should
	      be used

       --vv ----vveerrssiioonn
	      Prints the version for GRASS


   PPaarraammeetteerrss::
       GGIISSDDBBAASSEE
	      Initial database directory which should  be  a  fully  qualified
	      path (eg /usr/local/grassData)

       LLOOCCAATTIIOONN__NNAAMMEE
	      Initial location directory which is a subdirectory of GISDBASE

       MMAAPPSSEETT Initial  mapset  directory  which  is  a	subdirectory  of LOCA-
	      TION_NAME

       NNoottee   You must specify one of the following

	      MAPSET

	      LOCATION_NAME/MAPSET

	      GISDBASE/LOCATION_NAME/MAPSET



EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS
   UUsseerr IInntteerrffaaccee EEnnvviirroonnmmeenntt VVaarriiaabbllee
       The _g_r_a_s_s_5 program will check for the existence of an environment vari-
       able  called  GRASS_GUI	which indicates the type of user interface for
       GRASS to use. If this variable is not set when _g_r_a_s_s_5 is run,  then  it
       will be created and then saved in the $HOME/.grassrc5 file for the next
       time GRASS is run.


       There is an order of precedence in the way _g_r_a_s_s_5 determines  the  user
       interface  to  use.  The following is the hierarchy from highest prece-
       dence to lowest.


       The user may add own environment variable settings  to  $HOME/.grassrc5
       file  which  are used during next startup of GRASS (list of implemented
       environment variables).

       IInntteerrffaaccee pprreecceeddeennccee
	      Command line argument

	      Environment variable GRASS_GUI

	      Value set in $HOME/.grassrc5

	      Default value - currently tcltk


   TTccll//TTkk EEnnvviirroonnmmeenntt VVaarriiaabblleess
       If you choose to use the Tcl/Tk graphical user interface, then the fol-
       lowing  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.

       GGRRAASSSS__TTCCLLSSHH
	      Command to use to override tclsh

       GGRRAASSSS__WWIISSHH
	      Command to use to override wish

       Example Use of GRASS Tcl/Tk Environment Variables


       Suppose	your system has Tcl/Tk 8.0 installed and you install your per-
       sonal 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.


       GRASS_TCLSH = $HOME/bin/tclsh8.3

       GRASS_WISH  = $HOME/bin/wish8.3

   AAddddoonn ppaatthh ttoo eexxttrraa llooccaall GGRRAASSSS mmoodduulleess
       This environment variables allows to extend the GRASS paths to  locally
       developed/installed modules which are not distributes through the stan-
       dard release of GRASS.


       GRASS_ADDON_PATH=/usr/mytools

       GRASS_ADDON_PATH=/usr/mytools:/usr/local/othertools


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

   LLooccaattiioonn EEnnvviirroonnmmeenntt VVaarriiaabblleess
       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:

       LLOOCCAATTIIOONN
	      A  fully	qualified  path  to  a	mapset	(eg  /usr/local/grass-
	      Data/spearfish/PERMANENT). This environment  variable  overrides
	      the GISDBASE, LOCATION_NAME, and MAPSET variables.

       GGIISSDDBBAASSEE
	      Initial  database  directory  which  should be a fully qualified
	      path (eg /usr/local/grassData)

       LLOOCCAATTIIOONN__NNAAMMEE
	      Initial location directory which is a subdirectory of GISDBASE

       MMAAPPSSEETT Initial mapset  directory  which	is  a  subdirectory  of  LOCA-
	      TION_NAME



       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.

       EExxaammppllee 11
	      The environment variables are defined as follows:

	      LOCATION = /usr/local/grassData/spearfish/PERMANENT

	      GISDBASE = /usr/local/grassData

	      LOCATION_NAME = spearfish

	      MAPSET = PERMANENT

	      Start GRASS with the following command:

	      grass5 -

	      GRASS will start with the mapset defined by LOCATION  since  the
	      LOCATION variable overrides the other variables.


       EExxaammppllee 22
	      The environment variables are defined as follows:

	      GISDBASE = /usr/local/grassData

	      LOCATION_NAME = spearfish

	      MAPSET = PERMANENT

	      Start GRASS with the following command:

	      grass5 -

	      GRASS  will  start  with	the  mapset  defined by GISDBASE/LOCA-
	      TION_NAME/MAPSET.


       EExxaammppllee 33
	      The environment variables are defined as follows:

	      LOCATION = /usr/local/grassData/spearfish/PERMANENT

	      GISDBASE = /usr/local/grassData

	      LOCATION_NAME = spearfish

	      MAPSET = PERMANENT

	      Start GRASS with the following command:

	      grass5 /usr/home/grass/data/thailand/forests

	      GRASS  will  start  with	 the   mapset	/home/grass/data/thai-
	      land/forests which overrides the environment variables.


       EExxaammppllee 44
	      The environment variables are defined as follows:

	      LOCATION = /usr/local/grassData/spearfish/PERMANENT

	      GISDBASE = /usr/local/grassData

	      LOCATION_NAME = spearfish

	      MAPSET = PERMANENT

	      Start GRASS with the following command:

	      grass5 swamps

	      GRASS  will  start  with	the  mapset  defined by GISDBASE/LOCA-
	      TION_NAME/swamps since the command line argument for the	mapset
	      overrides the environment variable MAPSET.


       EExxaammppllee 55
	      The environment variables are defined as follows:

	      LOCATION = /usr/local/grassData/spearfish/PERMANENT

	      GISDBASE = /usr/local/grassData

	      LOCATION_NAME = spearfish

	      MAPSET = PERMANENT

	      Start GRASS with the following command:

	      grass5 thailand/forests

	      GRASS  will  start  with	the  mapset  defined by GISDBASE/thai-
	      land/forests since the command line arguments for  the  location
	      and mapset overrides the environment variables LOCATION_NAME and
	      MAPSET.



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

EEXXAAMMPPLLEESS
       The following are some examples of how you could start GRASS

       ggrraassss55 Start  GRASS  using the default user interface. The user will be
	      prompted to choose the appropriate location and mapset.

       ggrraassss55 --ttccllttkk
	      Start GRASS using the Tcl/Tk based user interface. The user will
	      be prompted to choose the appropriate location and mapset.

       ggrraassss55 --tteexxtt
	      Start  GRASS  using the text based user interface. The user will
	      be prompted to choose the appropriate location and mapset.

       ggrraassss55 --ttccllttkk --
	      Start GRASS using the Tcl/Tk based user  interface  and  try  to
	      obtain the location and mapset from environment variables.

       OOtthheerr eexxaammpplleess
	      See the LLooccaattiioonn EEnnvviirroonnmmeenntt VVaarriiaabblleess section for further exam-
	      ples.


BBUUGGSS AANNDD CCAAVVEEAATT
       If you start GRASS using the Tcl/Tk interface you must have a _w_i_s_h com-
       mand  in  your  $PATH variable. That is, the command must be named _w_i_s_h
       and not something like _w_i_s_h_8_._3. By default, a Tcl/Tk installation  does
       not  create  a _w_i_s_h command. Thus, the system administrator must create
       an appropriate link to the actual wish program.


       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 _l_n _-_s _w_i_s_h_8_._3 _w_i_s_h and _l_n
       _-_s _t_c_l_s_h_8_._3 _t_c_l_s_h to properly install Tcl/Tk for use with GRASS.


       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 ver-
       sion  found  in your $PATH variable. GRASS searches your $PATH variable
       until it finds the first version of _w_i_s_h.

FFIILLEESS
       _$_U_N_I_X___B_I_N_/_g_r_a_s_s_5 - GRASS startup program

       _$_G_I_S_B_A_S_E_/_e_t_c_/_I_n_i_t_._s_h - GRASS initialization script called by _g_r_a_s_s_5

       _$_G_I_S_B_A_S_E_/_t_c_l_t_k_g_r_a_s_s_/_s_c_r_i_p_t_/_g_i_s___s_e_t_._t_c_l - Tcl/Tk script to set the loca-
       tion and mapset to use. Called by _I_n_i_t_._s_h


SSEEEE AALLSSOO
       List of implemented GRASS environment variables.

AAUUTTHHOORR
       Justin Hickey (jhickey@hpcc.nectec.or.th)

       _L_a_s_t _c_h_a_n_g_e_d_: _$_D_a_t_e_: _2_0_0_2_/_0_3_/_0_1 _0_0_:_0_8_:_3_1 _$



GRASS 5.0							     grass5(1)
