Skip to content

Commit

Permalink
general: various updates
Browse files Browse the repository at this point in the history
  • Loading branch information
neteler committed Dec 14, 2024
1 parent e473bc8 commit 00930f5
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 44 deletions.
3 changes: 3 additions & 0 deletions general/g.gisenv/g.gisenv.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<h2>DESCRIPTION</h2>

<em>g.gisenv</em> outputs and modifies the user's current GRASS GIS
variable settings.

When a user runs GRASS, certain variables are set specifying the GRASS
data base, project, mapset, peripheral device drivers, etc., being
used in the current GRASS session. These variable name settings are
Expand Down
3 changes: 3 additions & 0 deletions general/g.mapsets/g.mapsets.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<h2>DESCRIPTION</h2>

<em>g.mapsets</em> modifies/prints the user's current mapset search
path.

For basic information about GRASS <em>mapset</em>, <em>project</em>
and <em>data base</em> refer to <a href="helptext.html">GRASS
Quickstart</a>.
Expand Down
5 changes: 4 additions & 1 deletion general/g.message/g.message.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<h2>DESCRIPTION</h2>

<p>This program is to be used in Shell/Perl/Python scripts, so the author does not
<em>g.message</em> prints a message, warning, progress info, or fatal error
in the GRASS GIS way.

This program is to be used in Shell/Perl/Python scripts, so the author does not
need to use the <tt>echo</tt> program. The advantage of <em>g.message</em> is
that it formats messages just like other GRASS modules do and that its
functionality is influenced by the <tt>GRASS_VERBOSE</tt> and
Expand Down
2 changes: 1 addition & 1 deletion general/g.mkfontcap/g.mkfontcap.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ <h2>DESCRIPTION</h2>

<em>g.mkfontcap</em> is a utility to generate a GRASS font configuration file
("fontcap") containing details of the fonts available on the current system.
If <a href="http://freetype.sourceforge.net/">Freetype</a> is not installed,
If <a href="https://freetype.org/">Freetype</a> is not installed,
the font list will be limited to the set of Hershey stroke fonts supplied
with GRASS. With Freetype enabled however, the module will recursively scan
all files within a predefined hierarchy to find Freetype-compatible scalable
Expand Down
52 changes: 28 additions & 24 deletions general/g.proj/g.proj.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ <h2>DESCRIPTION</h2>
If compiled without <a href="https://gdal.org/">OGR</a> present, the
functionality is limited to:
<ul>
<li>Reporting the CRS information for the current project
(previously called location),
either in conventional GRASS (-p flag) or PROJ (-j flag) format</li>
<li>Reporting the CRS information for the current project (previously called
location), either in conventional GRASS (<b>-p</b> flag) or PROJ (<b>-j</b>
flag) format</li>
<li>Changing the datum, or reporting and modifying the datum transformation
parameters, for the current project</li>
</ul>
Expand All @@ -32,22 +32,22 @@ <h2>DESCRIPTION</h2>
read from this file. If the file is not georeferenced or cannot be read,
XY (unprojected) will be used.</dd>

<dt>wkt=<em>filename</em> or <em>-</em></dt>
<dt>wkt=<em>filename</em> or <b>-</b></dt>
<dd>The file <em>filename</em> should contain a CRS description in WKT
format with or without line-breaks (e.g. a '.prj' file). If <em>-</em> is given
format with or without line-breaks (e.g. a '.prj' file). If <b>-</b> is given
for the filename, the WKT description will be read from stdin rather than a
file.</dd>

<dt>proj4=<em>description</em> or <em>-</em></dt>
<dt>proj4=<em>description</em> or <b>-</b></dt>
<dd><em>description</em> should be a CRS description in
<a href="https://proj.org/">PROJ</a> format, enclosed in
quotation marks if there are any spaces. If <em>-</em> is given for
quotation marks if there are any spaces. If <b>-</b> is given for
<em>description</em>, the PROJ description will be read from stdin rather
than as a directly-supplied command-line parameter.</dd>

<dt>epsg=<em>number</em></dt>
<dd><em>number</em> should correspond to the index number of a valid
co-ordinate system in the <a href="http://www.epsg.org/CurrentDB.html">EPSG
co-ordinate system in the <a href="https://epsg.org/search/by-name">EPSG
database</a>. EPSG code support is based upon a local copy of the GDAL CSV
co-ordinate system and datum information files, stored in the directory
<tt>$GISBASE/etc/proj/ogr_csv</tt>. These can be updated if necessary
Expand All @@ -65,22 +65,22 @@ <h2>DESCRIPTION</h2>
<em>datumtrans</em> parameter should in general always be used in
conjunction with <em>datum</em>.

<p>The -p, -j, -w, etc. flags are all functional when importing CRS
information from an external source, meaning that <em>g.proj</em> can be
used to convert between representations of the information. It is
<p>The <b>-p</b>, <b>-j</b>, <b>-w</b>, etc. flags are all functional when
importing CRS information from an external source, meaning that <em>g.proj</em>
can be used to convert between representations of the information. It is
<strong>not</strong> required that either the input or output be in GRASS
format.

<p>In addition however, if the -c flag is specified, <em>g.proj</em> will
<p>In addition however, if the <b>-c</b> flag is specified, <em>g.proj</em> will
create new GRASS CRS files (PROJ_INFO, PROJ_UNITS, WIND and
DEFAULT_WIND) based on the imported information. If the <em>project</em>
parameter is specified in addition to -c, then a new project will be created.
parameter is specified in addition to <b>-c</b>, then a new project will be created.
Otherwise the CRS information files in the current project will be
overwritten. The program will <strong>not</strong> warn before doing this.

<p>The final mode of operation of g.proj is to report on the datum
<p>The final mode of operation of <em>g.proj</em> is to report on the datum
information and datum transformation parameters associated with the
co-ordinate system. The -d flag will report a human-readable summary of
co-ordinate system. The <b>-d</b> flag will report a human-readable summary of
this.

<h2>NOTES</h2>
Expand All @@ -89,16 +89,20 @@ <h2>NOTES</h2>
transformation parameters, and there is more than one suitable parameter set
available (according to the files datum.table and datumtransform.table in
<tt>$GISBASE/etc/proj</tt>), <em>g.proj</em> will check the value of
the <em>datumtrans</em> option and act according to the following:<br>
<strong>-1:</strong> List available parameter sets in a GUI-parsable (but also
human-readable) format and exit.<br>
<strong>0 (default):</strong> Continue without specifying parameters - if
the <em>datumtrans</em> option and act according to the following:

<ul>
<li> <strong>-1:</strong> List available parameter sets in a GUI-parsable (but also
human-readable) format and exit.</li>
<li> <strong>0 (default):</strong> Continue without specifying parameters - if
used when creating a project, other GRASS modules will use the "default"
(likely non-optimum) parameters for this datum if necessary in the future.<br>
<strong>Any other number less than or equal to the number of parameter sets
(likely non-optimum) parameters for this datum if necessary in the future.</li>
<li> <strong>Any other number less than or equal to the number of parameter sets
available for this datum:</strong> Choose this parameter set and add it to the
co-ordinate system description.<br>
If the <em>-t</em> flag is specified, the module will attempt to change the
co-ordinate system description.</li>
</ul>

If the <b>-t</b> flag is specified, the module will attempt to change the
datum transformation parameters using one of the above two methods
<strong>even if</strong> a valid parameter set is already specified in the
input co-ordinate system. This can be useful to change the datum information
Expand Down Expand Up @@ -229,7 +233,7 @@ <h2>REFERENCES</h2>
<p><b>Further reading</b>
<ul>
<li> <a href="https://www.asprs.org/asprs-publications/grids-and-datums">ASPRS Grids and Datum</a></li>
<li> <a href="http://www.mapref.org">MapRef - The Collection of Map Projections and Reference Systems for Europe</a></li>
<li> <a href="https://mapref.org">MapRef - The Collection of Map Projections and Reference Systems for Europe</a></li>
<li> <a href="http://geotiff.maptools.org/proj_list/">Projections Transform List</a> (PROJ)</li>
</ul>

Expand Down
14 changes: 6 additions & 8 deletions general/g.region/g.region.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ <h2>DESCRIPTION</h2>
settings of the current geographic region. These regional
boundaries can be set by the user directly and/or set from
a region definition file (stored under the
<kbd>windows</kbd> directory in the user's current
<tt>windows</tt> directory in the user's current
mapset). The user can create, modify, and store as many
geographic region definitions as desired for any given
mapset. However, only one of these geographic region
Expand Down Expand Up @@ -50,8 +50,8 @@ <h2>DEFINITIONS</h2>

<dd>Each GRASS project (previously called location) has a fixed
geographic region, called the default geographic region
(stored in the region file <kbd>DEFAULT_WIND</kbd> under
the special mapset <kbd>PERMANENT</kbd>), that defines the
(stored in the region file <tt>DEFAULT_WIND</tt> under
the special mapset <tt>PERMANENT</tt>), that defines the
extent of the data base. While this provides a starting
point for defining new geographic regions, user-defined
geographic regions need not fall within this geographic
Expand All @@ -73,7 +73,7 @@ <h2>DEFINITIONS</h2>
<dd>Each GRASS MAPSET may contain any number of
pre-defined, and named, geographic regions. These region
definitions are stored in the user's current mapset
location under the <kbd>windows</kbd> directory (also
location under the <tt>windows</tt> directory (also
referred to as the user's saved region definitions).
Any of these pre-defined geographic regions
may be selected, by name, to become the current geographic
Expand Down Expand Up @@ -373,7 +373,6 @@ <h3>Changing extent and raster resolution using maps</h3>
the raster map layer <em>soils</em>.

<p>

<dt><span class="code"><tt>
g.region raster=soils zoom=soils
</tt></span>
Expand All @@ -385,11 +384,10 @@ <h3>Changing extent and raster resolution using maps</h3>
data in the map layer <em>soils</em>. Note that if the
parameter <em>raster=soils</em> were not specified, the
zoom would shrink to encompass all non-NULL data values in
the soils map that were located within the <i>current region</i>
the soils map that were located within the <em>current region</em>
settings.

<p>

<dt><span class="code"><tt>
g.region -up raster=soils
</tt></span>
Expand All @@ -408,7 +406,7 @@ <h3>Changing extent and raster resolution using maps</h3>
<dd> This will zoom into the smallest region which
encompasses all non-NULL soils data values, and save the
new region settings in a file to be called <em>soils</em>
and stored under the <kbd>windows</kbd> directory in the
and stored under the <tt>windows</tt> directory in the
user's current mapset. The current region settings are not
changed.
</dl>
Expand Down
2 changes: 1 addition & 1 deletion general/g.setproj/g.setproj.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h2>SEE ALSO</h2>
<ul>
<li> A guide to <a href="http://erg.usgs.gov/isb/pubs/MapProjections/projections.html">Map Projections</a> by USGS</li>
<li> <a href="https://www.asprs.org/asprs-publications/grids-and-datums">ASPRS Grids and Datum</a></li>
<li> <a href="http://www.mapref.org">MapRef - The Collection of Map Projections and Reference Systems for Europe</a></li>
<li> <a href="https://mapref.org">MapRef - The Collection of Map Projections and Reference Systems for Europe</a></li>
<li> <a href="http://geotiff.maptools.org/proj_list/">Projections Transform List</a> (PROJ)</li>
</ul>

Expand Down
21 changes: 12 additions & 9 deletions general/g.tempfile/g.tempfile.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ <h2>DESCRIPTION</h2>
<em>g.tempfile</em>
is designed for shell scripts that need to use large temporary files.
GRASS provides a mechanism for temporary files that does not depend on
/tmp. GRASS temporary files are created in the data base with the assumption
<tt>/tmp/</tt>. GRASS temporary files are created in the data base with the assumption
that there will be enough space under the data base for large files.
GRASS periodically removes temporary files that have been left behind
by programs that failed to remove them before terminating.
Expand All @@ -13,18 +13,21 @@ <h2>DESCRIPTION</h2>
creates an unique file and prints the name. The user is required to provide
a process-id which will be used as part of the name of the file.
Most Unix shells provide a way to get the process id of the current shell.
For /bin/sh and /bin/csh this is $$.
It is recommended that $$ be specified as the process-id for
For <tt>/bin/sh</tt> and <tt>/bin/csh</tt> this is <tt>$$</tt>.
It is recommended that <tt>$$</tt> be specified as the process-id for
<em>g.tempfile</em>.

<h2>EXAMPLE</h2>

For /bin/sh scripts the following syntax should be used:
For <tt>/bin/sh</tt> scripts the following syntax should be used:

<div class="code"><pre>
temp1=`g.tempfile pid=$$`
temp2=`g.tempfile pid=$$`
</pre></div>
For /bin/csh scripts, the following can be used:

For <tt>/bin/csh</tt> scripts, the following can be used:

<div class="code"><pre>
set temp1=`g.tempfile pid=$$`
set temp2=`g.tempfile pid=$$`
Expand All @@ -38,10 +41,10 @@ <h2>NOTES</h2>
Although GRASS does eventually get around to removing
tempfiles that have been left behind, the programmer should
make every effort to remove these files. They often get
large and take up disk space. If you write /bin/sh scripts,
learn to use the /bin/sh <em>trap</em> command. If you
write /bin/csh scripts, learn to use the /bin/csh
<em>onintr</em> command.
large and take up disk space. If you write <tt>/bin/sh</tt> scripts,
learn to use the <tt>/bin/sh<tt> related <tt>trap</tt> command. If you
write <tt>/bin/csh</tt> scripts, learn to use the <tt>/bin/csh</tt>
related <tt>onintr</tt> command.

<h2>AUTHOR</h2>

Expand Down

0 comments on commit 00930f5

Please sign in to comment.