瀏覽代碼

manual: some cleanup of HTML and examples

git-svn-id: https://svn.osgeo.org/grass/grass/branches/releasebranch_7_0@63432 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 10 年之前
父節點
當前提交
08d5224b41

+ 13 - 7
db/db.createdb/db.createdb.html

@@ -13,24 +13,29 @@ supported.
 
 <h3>Create a new SQLite file-based database</h3>
 
+Note that the standard GRASS GIS SQLite database is by default
+generated in the user's current mapset. This example shows an
+out-of-mapset database file creation:
+
 <div class="code"><pre>
 db.createdb driver=sqlite database=/opt/sqlite.db
 </pre></div>
 
 <h3>Create a new PostgreSQL database</h3>
 
-Create a new PostgreSQL database (if PostgreSQL connection is
-established through <em>odbc</em> driver):
+Create a new PostgreSQL database (after the PostgreSQL connection got
+established through the <em>pg</em> driver):
 
 <div class="code"><pre>
-db.createdb driver=odbc database=grassdb
+db.createdb driver=pg database=grassdb
 </pre></div>
 
-Create a new PostgreSQL database (if PostgreSQL connection is established
-through <em>pg</em> driver):
+<p>
+Create a new PostgreSQL database (after the PostgreSQL connection got
+established through the <em>odbc</em> driver):
 
 <div class="code"><pre>
-db.createdb driver=pg database=grassdb
+db.createdb driver=odbc database=grassdb
 </pre></div>
 
 <h2>TODO</h2>
@@ -40,10 +45,11 @@ Support other database drivers, too.
 <h2>SEE ALSO</h2>
 
 <em>
-<a href="db.dropdb.html">db.dropdb</a>,
 <a href="db.columns.html">db.columns</a>,
+<a href="db.connect.html">db.connect</a>,
 <a href="db.describe.html">db.describe</a>,
 <a href="db.drivers.html">db.drivers</a>,
+<a href="db.dropdb.html">db.dropdb</a>,
 <a href="db.droptable.html">db.droptable</a>,
 <a href="db.execute.html">db.execute</a>,
 <a href="db.login.html">db.login</a>,

+ 2 - 2
db/db.databases/db.databases.html

@@ -22,7 +22,7 @@ db.databases driver=sqlite
 </pre></div>
 
 <p>
-List SQLite databases in the given directory:
+List SQLite databases in a given directory:
 
 <div class="code"><pre>
 db.databases driver=sqlite location=/opt/sqlite
@@ -49,7 +49,7 @@ db.databases driver=pg location="host=server_name port=5333"
 <p>
 <a href="sql.html">GRASS SQL interface</a>
 
-<h2>AUTHOR</h2>
+<h2>AUTHORS</h2>
 
 Radim Blazek, ITC-Irst, Trento, Italy<br>
 Updated for GRASS 7 by Martin Landa, Czech Technical University in Prague, Czech Republic

+ 4 - 0
db/db.dropdb/db.dropdb.html

@@ -9,6 +9,10 @@ supported.
 
 <h3>Drop (delete) an existing database connected through SQLite driver</h3>
 
+Note that the standard GRASS GIS SQLite database is by default
+found in the user's current mapset. This example shows an
+out-of-mapset database removal:
+
 <div class="code"><pre>
 db.dropdb driver=sqlite database=/opt/sqlite.db
 </pre></div>

+ 12 - 4
display/d.geodesic/d.geodesic.html

@@ -26,12 +26,17 @@ the great circle distance is not displayed.
 
 <h2>EXAMPLE</h2>
 
+A geodesic line if shown over the political map of the world
+(demolocation dataset):
+
 <div class="code"><pre>
-g.region vect=world_political -p
+g.region vect=country_boundaries -p
 d.mon wx0
-d.vect world_political type=area
+d.vect country_boundaries type=area
 d.geodesic coordinates=55:58W,33:18S,26:43E,60:37N \
   line_color=yellow text_color=red
+# show additionally 10 degree grid
+d.grid 10
 </pre></div>
 
 <p><center>
@@ -41,12 +46,15 @@ d.geodesic coordinates=55:58W,33:18S,26:43E,60:37N \
 
 <h2>NOTES</h2>
 
-This program works only with GRASS locations using a longitude/latitude 
+This program works only in GRASS locations with longitude/latitude 
 coordinate system. 
 
 <h2>SEE ALSO</h2>
 
-<em><a href="d.rhumbline.html">d.rhumbline</a></em>
+<em>
+<a href="d.rhumbline.html">d.rhumbline</a>,
+<a href="d.grid.html">d.grid</a>
+</em>
 
 <h2>AUTHOR</h2>
 

+ 32 - 16
display/d.mon/d.mon.html

@@ -3,7 +3,7 @@
 <em>d.mon</em> allows the user to start, select, list, release, and
 stop available graphics monitors.
 
-<h3>Start a monitor</h3> 
+<h3>Starting a monitor</h3> 
 
 In order to display on-screen GRASS graphics, the user must
 <b>start</b> and <b>select</b> a graphics monitor. By default,
@@ -23,7 +23,7 @@ explicitly <b>select</b> a monitor that has been started.
 unless it is stopped for some reason. A monitor may continue to run
 for any length of time, even when no GRASS session is being run.
 
-<h3>Stop a monitor</h3> 
+<h3>Stopping a monitor</h3> 
 
 A graphics monitor has two different types of status: monitor
 program <em>not running</em>, and monitor <em>running</em>. A monitor
@@ -31,7 +31,7 @@ that has been started and/or selected will be listed as running; a
 monitor that has been stopped (or not started) will be listed as not
 running.  The <b>-l</b> flag will list all currently running monitors.
 
-<h3>Select a monitor</h3> 
+<h3>Selecting a monitor</h3> 
 
 When the user <em>starts</em> a monitor, it is also
 (automatically) <em>selected</em> for graphics output unless the user
@@ -44,28 +44,38 @@ be selected for graphics output.
 <p>The user can run multiple graphics monitors by simply starting each of
 the graphics monitors he wishes to direct output to.
 
-<h3>Release a monitor</h3>
+<h3>Releasing (unselecting) a monitor</h3>
 
 Currently <em>selected</em> a monitor can be released by <b>-r</b>
 flag.
 
 <h2>EXAMPLES</h2>
 
+<h3>wx0 monitor</h3>
+
 To start interactive <em><a href="wxGUI.html#map-display-window">wxGUI map
-display</a></em>
+display</a></em>, run
 
 <div class="code"><pre>
 d.mon start=wx0
 </pre></div>
 
-All data will be rendered on <tt>wx0</tt> display. New monitor can be
-started (and selected ) by
+All data will be rendered on <tt>wx0</tt> display.
+
+<h3>CAIRO file renderer monitor</h3>
+
+A new CAIRO monitor can be started (and selected) by
 
 <div class="code"><pre>
 d.mon start=cairo output=out.pdf
 </pre></div>
 
-To list running monitors
+From this moment all data will be rendered into
+file <tt>output.pdf</tt>. 
+
+<h3>List running monitors</h3>
+
+To list running monitors, use
 
 <div class="code"><pre>
 d.mon -l
@@ -75,6 +85,8 @@ wx0
 cairo
 </pre></div>
 
+<h3>Show currently selected monitor</h3>
+
 To determine currently selected monitor
 
 <div class="code"><pre>
@@ -83,15 +95,18 @@ d.mon -p
 cairo
 </pre></div>
 
-From this moment all data will be rendered into
-file <tt>output.pdf</tt>. To switch back to interactive wxGUI monitor
+<h3>Switching between monitors</h3>
 
+To switch back to interactive, earlier started and still running wxGUI
+monitor
 
 <div class="code"><pre>
 d.mon select=wx0
 </pre></div>
 
-To close this monitor
+<h3>Stopping a monitor</h3> 
+
+To close the wxGUI monitor
 
 <div class="code"><pre>
 d.mon stop=wx0
@@ -100,11 +115,12 @@ d.mon stop=wx0
 <h2>SEE ALSO</h2>
 
 <em>
-  <a href="d.erase.html">d.erase</a>,
-  <a href="d.redraw.html">d.redraw</a>,
-  <a href="d.rast.html">d.rast</a>,
-  <a href="d.vect.html">d.vect</a>
-</em>
+<a href="d.erase.html">d.erase</a>,
+<a href="d.redraw.html">d.redraw</a>,
+<a href="d.rast.html">d.rast</a>,
+<a href="d.vect.html">d.vect</a>,
+<a href="wxGUI.html">wxGUI</a>
+<em>
 
 <p>
 See also

+ 8 - 4
display/d.path/d.path.html

@@ -8,9 +8,13 @@ boundary lines.
 
 <h2>NOTE</h2>
 
-The user needs to display a vector map before using d.path. The 'from' and 'to'
-points are entered by mouse into the map displayed in the GRASS monitor, or
-if the <b>coor</b> option is used they can be specified non-interactively.
+<!-- TODO: apparently d.path does not render into wxGUI? -->
+The user needs to display a vector map before using d.path. If no graphics monitor
+is open, a file <tt>map.png</tt> is generated in the current directory.
+
+<p>
+The 'from' and 'to' points are entered by mouse into the map displayed in the GRASS monitor,
+or if the <b>coordinates</b> option is used they can be specified non-interactively.
 The actions bound to the mouse buttons are described in the terminal
 window when running the command.
 <p>To calculate shortest path non-interactively and save the path to a new vector
@@ -20,7 +24,7 @@ map, use the <em>v.net.path</em> module.
 
 Interactive shortest path routing on road network (North Carolina sample dataset):
 <div class="code"><pre>
-g.region vect=roadsmajor
+g.region vect=roadsmajor -p
 d.vect roadsmajor
 d.path roadsmajor coordinates=668646.15,224447.16,668348.83,235894.02
 </pre></div>

+ 19 - 12
display/d.rhumbline/d.rhumbline.html

@@ -4,9 +4,9 @@ A rhumbline (loxodrome) is a line following a constant angle of the
 compass (i.e., a line of constant direction). It crosses all meridians
 at the same angle, i.e. a path of constant bearing.
 
- <!-- There are 32
-points on the compass (points are roughly 11 degrees 15
-minutes apart). --> <em>d.rhumbline</em> displays the
+<!-- There are 32 points on the compass (points are roughly 11 degrees 15
+minutes apart). -->
+<em>d.rhumbline</em> displays the
 rhumbline joining any two user-specified points in the
 active frame on the user's graphics monitor.  The named
 coordinate locations must fall within the boundaries of the
@@ -20,11 +20,17 @@ non-interactively.
 
 <h2>EXAMPLE</h2>
 
+A geodesic line if shown over the political map of the world
+(demolocation dataset):
+
 <div class="code"><pre>
-g.region vect=world_political -p
+g.region vect=country_boundaries -p
 d.mon wx0
-d.vect world_political type=area
-d.rhumbline coor=55:58W,33:18S,26:43E,60:37N line_color=yellow text_color=red
+d.vect country_boundaries type=area
+d.rhumbline coordinates=55:58W,33:18S,26:43E,60:37N \
+  line_color=yellow
+# show additionally 10 degree grid
+d.grid 10
 </pre></div>
 
 <p><center>
@@ -32,19 +38,20 @@ d.rhumbline coor=55:58W,33:18S,26:43E,60:37N line_color=yellow text_color=red
 <i>Rhumbline (loxodrome)</i>
 </center>
 
-
 <h2>NOTES</h2>
 
-This program works only with longitude-latitude locations. 
+This program works only in GRASS locations with longitude/latitude 
+coordinate system. 
 
 <h2>SEE ALSO</h2>
 
-<em><a href="d.geodesic.html">d.geodesic</a></em>
+<em>
+<a href="d.geodesic.html">d.geodesic</a>,
+<a href="d.grid.html">d.grid</a>
+</em>
 
 <h2>AUTHOR</h2>
 
-Michael Shapiro, 
-U.S. Army Construction Engineering 
-Research Laboratory
+Michael Shapiro, U.S. Army Construction Engineering Research Laboratory
 
 <p><i>Last changed: $Date$</i>

+ 4 - 3
scripts/d.correlate/d.correlate.html

@@ -6,8 +6,9 @@ highlights the correlation (or lack of it) among data
 layers (scattergram).
 
 <p>The results are displayed in the active display frame on
-the user's graphics monitor.  <em>d.correlate</em> erases
-the active frame before displaying results.
+the user's graphics monitor. <em>d.correlate</em> erases
+the active frame before displaying results. If no graphics monitor
+is open, a file <tt>map.png</tt> is generated in the current directory.
 
 <h2>NOTES</h2>
 
@@ -32,7 +33,7 @@ d.correlate map=lsat7_2002_30,lsat7_2002_40
 <a href="r.stats.html">r.stats</a>
 </em>
 
-<h2>AUTHOR</h2>
+<h2>AUTHORS</h2>
 
 Michael Shapiro,
 <a href="http://www.cecer.army.mil/">U.S.Army Construction Engineering Research Laboratory</a>

+ 6 - 5
scripts/db.in.ogr/db.in.ogr.html

@@ -1,8 +1,9 @@
 <h2>DESCRIPTION</h2>
 
 <em>db.in.ogr</em> imports attribute tables in various formats as
-supported by the <a href="http://gdal.org/ogr">OGR library</a> on the local system (DBF, CSV, PostgreSQL,
-SQLite, MySQL, ODBC, etc.). Optionally a unique <b>key</b> (ID) column can be
+supported by the <a href="http://gdal.org/ogr">OGR library</a>
+on the local system (DBF, CSV, PostgreSQL, SQLite, MySQL, ODBC,
+etc.). Optionally a unique <b>key</b> (ID) column can be
 added to the table.
 
 <h2>EXAMPLES</h2>
@@ -14,7 +15,7 @@ columns through a descriptive file with same name as the CSV file, but .csvt ext
 (see details <a href="http://www.gdal.org/ogr/drv_csv.html">here</a>).
 
 <div class="code"><pre>
-# NOTE: create koeppen_gridcode.csvt first for type recognition
+# NOTE: create koeppen_gridcode.csvt first for automated type recognition
 db.in.ogr input=koeppen_gridcode.csv output=koeppen_gridcode
 db.select koeppen_gridcode
 </pre></div>
@@ -60,8 +61,8 @@ db.in.ogr input=address.xls db_table=address_data
 <h2>SEE ALSO</h2>
 
 <em>
-  <a href="v.in.ogr.html">v.in.ogr</a>,
-  <a href="v.in.db.html">v.in.db</a>
+<a href="v.in.ogr.html">v.in.ogr</a>,
+<a href="v.in.db.html">v.in.db</a>
 </em>
 
 <p>

+ 2 - 2
scripts/i.tasscap/i.tasscap.html

@@ -28,9 +28,9 @@ Calculation of TC maps from North Carolina Landsat scene:
 
 <div class="code"><pre>
 g.region rast=lsat7_2002_10 -p
-i.tasscap satellite=landsat7_etm \
+i.tasscap sensor=landsat7_etm \
   input=lsat7_2002_10,lsat7_2002_20,lsat7_2002_30,lsat7_2002_40,lsat7_2002_50,lsat7_2002_70 \
-  basename=tasscap
+  output=tasscap
 </pre></div>
 
 Results:

+ 2 - 0
vector/v.univar/v.univar.html

@@ -46,7 +46,9 @@ v.univar -d samples column=heights type=point
 <h2>SEE ALSO</h2>
 
 <em>
+<a href="db.univar.html">db.univar</a>,
 <a href="r.univar.html">r.univar</a>,
+<a href="v.db.univar.html">v.db.univar</a>,
 <a href="v.neighbors.html">v.neighbors</a>
 </em>