From dcc4ebc1e8945dbbd9270e4775a6d220633507b3 Mon Sep 17 00:00:00 2001
From: mwtoews <mwtoews@gmail.com>
Date: Sat, 5 May 2018 22:30:15 +1200
Subject: Use formatting similar to used in original manuals

Minor rephrasing for better reading. Split -[w|W]<n> into two options.
---
 docs/source/apps/cct.rst   | 10 ++++-----
 docs/source/apps/cs2cs.rst | 45 +++++++++++++++++++++----------------
 docs/source/apps/geod.rst  | 20 ++++++++---------
 docs/source/apps/gie.rst   |  2 +-
 docs/source/apps/proj.rst  | 56 +++++++++++++++++++++++++---------------------
 5 files changed, 72 insertions(+), 61 deletions(-)

(limited to 'docs/source')

diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst
index 3c3f6668..a6e6e551 100644
--- a/docs/source/apps/cct.rst
+++ b/docs/source/apps/cct.rst
@@ -38,13 +38,13 @@ The following control parameters can appear in any order:
 
 .. option:: -t <time>, --time=<time>
 
-    Specify a fixed observation time to be used for all input data.
+    Specify a fixed observation *time* to be used for all input data.
 
 .. option:: -z <height>, --height=<height>
 
-    Specify a fixed observation height to be used for all input data.
+    Specify a fixed observation *height* to be used for all input data.
 
-.. option:: s <n>, --skip-lines=<n>
+.. option:: -s <n>, --skip-lines=<n>
 
     .. versionadded:: 5.1.0
 
@@ -89,7 +89,7 @@ Examples
 
 .. code-block:: console
 
-     echo 12 55 0 0 | cct +proj=utm +zone=32 +ellps=GRS80
+      echo 12 55 0 0 | cct +proj=utm +zone=32 +ellps=GRS80
 
 will transform the input geographic coordinates into UTM zone 32 coordinates.
 Hence, the command
@@ -98,7 +98,7 @@ Hence, the command
 
       echo 12 55 | cct -z0 -t0 +proj=utm +zone=32 +ellps=GRS80
 
-Should give results comparable to the classic proj command
+Should give results comparable to the classic :program:`proj` command
 
 .. code-block:: console
 
diff --git a/docs/source/apps/cs2cs.rst b/docs/source/apps/cs2cs.rst
index 45d004bf..d5d35028 100644
--- a/docs/source/apps/cs2cs.rst
+++ b/docs/source/apps/cs2cs.rst
@@ -27,31 +27,31 @@ The following control parameters can appear in any order:
 
 .. option:: -I
 
-    method to specify inverse translation, convert from *+to* coordinate system to
+    Method to specify inverse translation, convert from *+to* coordinate system to
     the primary coordinate system defined.
 
 .. option:: -t<a>
 
-    A specifies a character employed as the first character to denote a control
+    Where *a* specifies a character employed as the first character to denote a control
     line to be passed through without processing. This option applicable to
-    ascii input only. (# is the default value).
+    ASCII input only. (# is the default value).
 
 .. option:: -e <string>
 
-    String is an arbitrary string to be output if an error is detected during
-    data transformations. The default value is: *\t*. Note that if the -b, -i
-    or -o options are employed, an error is returned as HUGE_VAL value for both
+    Where *string* is an arbitrary string to be output if an error is detected during
+    data transformations. The default value is a three character string: ``*\t*``.
+    Note that if the -b, -i or -o options are employed, an error is returned as HUGE_VAL value for both
     return values.
 
 .. option:: -E
 
-    causes the input coordinates to be copied to the output line prior to
+    Causes the input coordinates to be copied to the output line prior to
     printing the converted values.
 
 .. option:: -l<[=id]>
 
     List projection identifiers that can be selected with *+proj*. ``cs2cs -l=id``
-    gives expanded description of projection id, e.g. ``cs2cs -l=merc``.
+    gives expanded description of projection *id*, e.g. ``cs2cs -l=merc``.
 
 .. option:: -lp
 
@@ -87,21 +87,26 @@ The following control parameters can appear in any order:
 
 .. option:: -f <format>
 
-    Format is a printf format string to control the form of the output values.
+    Where *format* is a printf format string to control the form of the output values.
     For inverse projections, the output will be in degrees when this option is
     employed. If a format is specified for inverse projection the output data
-    will be in decimal degrees. The default format is "%.2f" for forward
+    will be in decimal degrees. The default format is ``"%.2f"`` for forward
     projection and DMS for inverse.
 
-.. option:: -[w|W]<n>
+.. option:: -w<n>
 
-    N is the number of significant fractional digits to employ for seconds
-    output (when the option is not specified, -w3 is assumed). When -W is
-    employed the fields will be constant width and with leading zeroes.
+    Where *n* is the number of significant fractional digits to employ for seconds
+    output (when the option is not specified, ``-w3`` is assumed).
+
+.. option:: -W<n>
+
+    Where *n* is the number of significant fractional digits to employ for seconds
+    output. When ``-W`` is employed the fields will be constant width
+    with leading zeroes.
 
 .. option:: -v
 
-    causes a listing of cartographic control parameters tested for and used by
+    Causes a listing of cartographic control parameters tested for and used by
     the program to be printed prior to input data.
 
 
@@ -129,7 +134,7 @@ Additional projection control parameters may be contained in two auxiliary
 control files: the first is optionally referenced with the
 *+init=file:id* and the second is always processed after the name of the
 projection has been established from either the run-line or the contents of
-*+init* file. The environment parameter PROJ_LIB establishes the default
+*+init* file. The environment parameter :envvar:`PROJ_LIB` establishes the default
 directory for a file reference without an absolute path. This is also used
 for supporting files like datum shift files.
 
@@ -155,9 +160,11 @@ The following script
 
 ::
 
-    cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 -r
-    <<EOF 45d15'33.1"   111.5W 45d15.551666667N   -111d30 +45.25919444444
-    111d30'000w EOF
+    cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 -r <<EOF
+    45d15'33.1" 111.5W
+    45d15.551666667N -111d30
+    +45.25919444444 111d30'000w
+    EOF
 
 will transform the input NAD83 geographic coordinates into NAD27 coordinates in
 the UTM projection with zone 10 selected. The geographic values of this
diff --git a/docs/source/apps/geod.rst b/docs/source/apps/geod.rst
index e5251ad2..f5e61de4 100644
--- a/docs/source/apps/geod.rst
+++ b/docs/source/apps/geod.rst
@@ -35,16 +35,16 @@ The following command-line options can appear in any order:
 .. option:: -I
 
     Specifies that the inverse geodesic computation is to be performed. May be
-    used with execution of geod as an alternative to invgeod execution.
+    used with execution of :program:`geod` as an alternative to :program:`invgeod` execution.
 
 .. option:: -a
 
     Latitude and longitudes of the initial and terminal points, forward and
     back azimuths and distance are output.
 
-.. option:: -ta
+.. option:: -t<a>
 
-    A specifies a character employed as the first character to denote a control
+    Where *a* specifies a character employed as the first character to denote a control
     line to be passed through without processing.
 
 .. option:: -le
@@ -59,24 +59,24 @@ The following command-line options can appear in any order:
 
 .. option:: -f <format>
 
-    Format is a printf format string to control the output form of the
+    Where *format* is a printf format string to control the output form of the
     geographic coordinate values. The default mode is DMS for geographic
-    coordinates and "%.3f" for distance.
+    coordinates and ``"%.3f"`` for distance.
 
 .. option:: -F <format>
 
-    Format is a printf format string to control the output form of the distance
+    Where *format* is a printf format string to control the output form of the distance
     value (``-F``). The default mode is DMS for geographic coordinates and
-    "%.3f" for distance.
+    ``"%.3f"`` for distance.
 
 .. option:: -w<n>
 
-    N is the number of significant fractional digits to employ for seconds
+    Where *n* is the number of significant fractional digits to employ for seconds
     output (when the option is not specified, ``-w3`` is assumed).
 
 .. option:: -W<n>
 
-    N is the number of significant fractional digits to employ for seconds
+    Where *n* is the number of significant fractional digits to employ for seconds
     output. When ``-W`` is employed the fields will be constant width
     with leading zeroes.
 
@@ -127,7 +127,7 @@ radius.
 The Earth's ellipsoidal figure may be selected in the same manner
 as program :program:`proj` by using *+ellps=*, *+a=*, *+es=*, etc.
 
-Geod may also be used to determine intermediate points along
+:program:`geod` may also be used to determine intermediate points along
 either a geodesic line between two points or along an arc of
 specified distance from a geographic point. In both cases an
 initial point must be specified with *+lat_1=lat* and *+lon_1=lon*
diff --git a/docs/source/apps/gie.rst b/docs/source/apps/gie.rst
index 35b0ac38..066b4f70 100644
--- a/docs/source/apps/gie.rst
+++ b/docs/source/apps/gie.rst
@@ -142,7 +142,7 @@ gie command language
     accepted for one :option:`operation`. For each :option:`accept` an
     accompanying :option:`expect` is needed.
 
-    Note that :program:`gie` accepts the underscore ("_") as a thousands
+    Note that :program:`gie` accepts the underscore (``_``) as a thousands
     separator. It is not required (in fact, it is entirely ignored by the
     input routine), but it significantly improves the readability of the very
     long strings of numbers typically required in projected coordinates.
diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst
index 19a72a66..086617a4 100644
--- a/docs/source/apps/proj.rst
+++ b/docs/source/apps/proj.rst
@@ -34,7 +34,7 @@ The following control parameters can appear in any order
 
     Special option for binary coordinate data input and output through standard
     input and standard output. Data is assumed to be in system type double
-    floating point words. This option is to be used when proj is a son process
+    floating point words. This option is to be used when :program:`proj` is a son process
     and allows bypassing formatting operations.
 
 .. option:: -i
@@ -43,8 +43,8 @@ The following control parameters can appear in any order
 
 .. option:: -I
 
-    alternate method to specify inverse projection. Redundant when used with
-    invproj.
+    Alternate method to specify inverse projection. Redundant when used with
+    :program:`invproj`.
 
 .. option:: -o
 
@@ -52,26 +52,26 @@ The following control parameters can appear in any order
 
 .. option:: -t<a>
 
-    *a* specifies a character employed as the first character to denote a
+    Where *a* specifies a character employed as the first character to denote a
     control line to be passed through without processing. This option
-    applicable to ascii input only. (# is the default value).
+    applicable to ASCII input only. (# is the default value).
 
 .. option:: -e <string>
 
-    String is an arbitrary string to be output if an error is detected during
-    data transformations. The default value is: *\t*. Note that if the
-    :option:`-b`, :option:`-i` or :option:`-o` options are employed, an error
+    Where *string* is an arbitrary string to be output if an error is detected during
+    data transformations. The default value is a three character string: ``*\t*``.
+    Note that if the :option:`-b`, :option:`-i` or :option:`-o` options are employed, an error
     is returned as HUGE_VAL value for both return values.
 
 .. option:: -E
 
-    causes the input coordinates to be copied to the output line prior to
+    Causes the input coordinates to be copied to the output line prior to
     printing the converted values.
 
 .. option:: -l<[=id]>
 
     List projection identifiers that can be selected with *+proj*. ``proj -l=id``
-    gives expanded description of projection id, e.g. ``proj -l=merc``.
+    gives expanded description of projection *id*, e.g. ``proj -l=merc``.
 
 .. option:: -lp
 
@@ -95,7 +95,6 @@ The following control parameters can appear in any order
 
     List of datums that can be selected with the *+datum* parameter.
 
-
 .. option:: -r
 
     This options reverses the order of the expected input from
@@ -116,28 +115,33 @@ The following control parameters can appear in any order
 
 .. option:: -m <mult>
 
-    The cartesian data may be scaled by the mult parameter. When processing data
+    The cartesian data may be scaled by the *mult* parameter. When processing data
     in a forward projection mode the cartesian output values are multiplied by
-    mult otherwise the input cartesian values are divided by mult before inverse
-    projection. If the first two characters of mult are 1/ or 1: then the
-    reciprocal value of mult is employed.
+    *mult* otherwise the input cartesian values are divided by *mult* before inverse
+    projection. If the first two characters of *mult* are 1/ or 1: then the
+    reciprocal value of *mult* is employed.
 
 .. option:: -f <format>
 
-    Format is a printf format string to control the form of the output values.
+    Where *format* is a printf format string to control the form of the output values.
     For inverse projections, the output will be in degrees when this option is
-    employed. The default format is "%.2f" for forward projection and DMS for
+    employed. The default format is ``"%.2f"`` for forward projection and DMS for
     inverse.
 
-.. option:: -[w|W]<n>
+.. option:: -w<n>
+
+    Where *n* is the number of significant fractional digits to employ for seconds
+    output (when the option is not specified, ``-w3`` is assumed).
+
+.. option:: -W<n>
 
-    N is the number of significant fractional digits to employ for seconds
-    output (when the option is not specified, ``-w3`` is assumed). When ``-W``
-    is employed the fields will be constant width and with leading zeroes.
+    Where *n* is the number of significant fractional digits to employ for seconds
+    output. When ``-W`` is employed the fields will be constant width
+    with leading zeroes.
 
 .. option:: -v
 
-    causes a listing of cartographic control parameters tested for and used by
+    Causes a listing of cartographic control parameters tested for and used by
     the program to be printed prior to input data. Should not be used with the
     :option:`-T` option.
 
@@ -150,11 +154,11 @@ The following control parameters can appear in any order
 
     This option creates a set of bivariate Chebyshev polynomial coefficients
     that approximate the selected cartographic projection on stdout. The values
-    low and hi denote the range of the input where the u or v prefixes apply to
+    *low* and *hi* denote the range of the input where the *u* or *v* prefixes apply to
     respective longitude-x or latitude-y depending upon whether a forward or
-    inverse projection is selected. Res is an integer number specifying the
-    power of 10 precision of the approximation. For example, a res of -3
-    specifies an approximation with an accuracy better than .001. Umax, and vmax
+    inverse projection is selected. The integer *res* is a number specifying the
+    power of 10 precision of the approximation. For example, a *res* of -3
+    specifies an approximation with an accuracy better than 0.001. Optional *umax*, and *vmax*
     specify maximum degree of the polynomials (default: 15).
 
 
-- 
cgit v1.2.3