aboutsummaryrefslogtreecommitdiff
path: root/docs/source/apps/cs2cs.rst
diff options
context:
space:
mode:
authormwtoews <mwtoews@gmail.com>2018-05-05 22:30:15 +1200
committermwtoews <mwtoews@gmail.com>2018-05-05 22:30:15 +1200
commitdcc4ebc1e8945dbbd9270e4775a6d220633507b3 (patch)
tree88cc745abfaf9e792ba8a83fced7c5feca4904ba /docs/source/apps/cs2cs.rst
parente6472d42b33b7cc2155de82dd561365b16f9ef78 (diff)
downloadPROJ-dcc4ebc1e8945dbbd9270e4775a6d220633507b3.tar.gz
PROJ-dcc4ebc1e8945dbbd9270e4775a6d220633507b3.zip
Use formatting similar to used in original manuals
Minor rephrasing for better reading. Split -[w|W]<n> into two options.
Diffstat (limited to 'docs/source/apps/cs2cs.rst')
-rw-r--r--docs/source/apps/cs2cs.rst45
1 files changed, 26 insertions, 19 deletions
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