diff options
| author | Chris Mayo <aklhfex@gmail.com> | 2019-03-24 11:56:35 +0000 |
|---|---|---|
| committer | Chris Mayo <aklhfex@gmail.com> | 2019-03-24 11:56:35 +0000 |
| commit | 1eadd02ac0b28486e98aed9407f27c4956619bae (patch) | |
| tree | 94cce7896e4abcaab0a1095600bf2e79c271fa31 /docs | |
| parent | d089e17fde8a636198cf21f1045fc6bee20d987d (diff) | |
| download | PROJ-1eadd02ac0b28486e98aed9407f27c4956619bae.tar.gz PROJ-1eadd02ac0b28486e98aed9407f27c4956619bae.zip | |
Doc: consistently use +opt and brackets
+opt represents one parameter. An ellipsis indicates additional
instances of the previous parameter may be given.
Spaces are used between parameters and before an ellipsis, not purely to
format brackets. See man(1) SYNOPSIS conventions.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/apps/cct.rst | 4 | ||||
| -rw-r--r-- | docs/source/apps/cs2cs.rst | 10 | ||||
| -rw-r--r-- | docs/source/apps/geod.rst | 6 | ||||
| -rw-r--r-- | docs/source/apps/proj.rst | 8 |
4 files changed, 14 insertions, 14 deletions
diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst index 249d523a..629e181c 100644 --- a/docs/source/apps/cct.rst +++ b/docs/source/apps/cct.rst @@ -13,7 +13,7 @@ cct Synopsis ******** - **cct** [ **-cIostvz** [ args ] ] *+opts[=arg]* file[s] + **cct** [**-cIostvz** [args]] *+opt[=arg]* ... file ... Description *********** @@ -70,7 +70,7 @@ The following control parameters can appear in any order: Print version number. -The *+args* arguments are associated with coordinate operation parameters. +The *+opt* arguments are associated with coordinate operation parameters. Usage varies with operation. .. only:: html diff --git a/docs/source/apps/cs2cs.rst b/docs/source/apps/cs2cs.rst index 579dc65e..afe5a610 100644 --- a/docs/source/apps/cs2cs.rst +++ b/docs/source/apps/cs2cs.rst @@ -11,11 +11,11 @@ cs2cs Synopsis ******** - **cs2cs** [ **-eEfIlrstvwW** [ args ] ] [ *+opts[=arg]* ] [ +to [*+opts[=arg]*] ] file[s] + **cs2cs** [**-eEfIlrstvwW** [args]] [*+opt[=arg]* ...] [+to *+opt[=arg]* ...] file ... or - **cs2cs** [ **-eEfIlrstvwW** [ args ] ] {source_crs} +to {target_crs} file[s] + **cs2cs** [**-eEfIlrstvwW** [args]] {source_crs} +to {target_crs} file ... where {source_crs} or {target_crs} is a PROJ string, a WKT string or a AUTHORITY:CODE (where AUTHORITY is the name of a CRS authority and CODE the code of a CRS @@ -25,7 +25,7 @@ or or - **cs2cs** [ **-eEfIlrstvwW** [ args ] ] {source_crs} {target_crs} + **cs2cs** [**-eEfIlrstvwW** [args]] {source_crs} {target_crs} .. versionadded:: 6.0.0 @@ -132,12 +132,12 @@ The following control parameters can appear in any order: .. only:: man - The *+args* run-line arguments are associated with cartographic + The *+opt* run-line arguments are associated with cartographic parameters. .. only:: html - The *+args* run-line arguments are associated with cartographic + The *+opt* run-line arguments are associated with cartographic parameters. Usage varies with projection and for a complete description consult the :ref:`projection pages <projections>`. diff --git a/docs/source/apps/geod.rst b/docs/source/apps/geod.rst index e890aede..2897445d 100644 --- a/docs/source/apps/geod.rst +++ b/docs/source/apps/geod.rst @@ -7,9 +7,9 @@ geod Synopsis ******** - **geod** *+ellps=<ellipse>* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] + **geod** *+ellps=<ellipse>* [**-afFIlptwW** [args]] [*+opt[=arg]* ...] file ... - **invgeod** *+ellps=<ellipse>* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] + **invgeod** *+ellps=<ellipse>* [**-afFIlptwW** [args]] [*+opt[=arg]* ...] file ... Description *********** @@ -85,7 +85,7 @@ The following command-line options can appear in any order: This option causes the azimuthal values to be output as unsigned DMS numbers between 0 and 360 degrees. Also note :option:`-f`. -The *+args* command-line options are associated with geodetic +The *+opt* command-line options are associated with geodetic parameters for specifying the ellipsoidal or sphere to use. controls. The options are processed in left to right order from the command line. Reentry of an option is ignored with diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst index 7585411f..2dbd104a 100644 --- a/docs/source/apps/proj.rst +++ b/docs/source/apps/proj.rst @@ -12,9 +12,9 @@ proj Synopsis ******** - **proj** [ **-beEfiIlmorsStTvVwW** ] [ args ] ] [ *+args* ] file[s] + **proj** [**-beEfiIlmorsStTvVwW**] [args]] [*+opt[=arg]* ...] file ... - **invproj** [ **-beEfiIlmorsStTvVwW** ] [ args ] ] [ *+args* ] file[s] + **invproj** [**-beEfiIlmorsStTvVwW**] [args]] [*+opt[=arg]* ...] file ... Description @@ -156,7 +156,7 @@ The following control parameters can appear in any order the projected point. :option:`-v` is implied with this option. -The *+args* run-line arguments are associated with cartographic parameters. +The *+opt* run-line arguments are associated with cartographic parameters. 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 @@ -167,7 +167,7 @@ also used for supporting files like datum shift files. .. only:: html - Usage of *+args* varies with projection and for a complete description + Usage of *+opt* varies with projection and for a complete description consult the :ref:`projection pages <projections>`. |
