diff options
Diffstat (limited to 'docs/source/apps')
| -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/gie.rst | 4 | ||||
| -rw-r--r-- | docs/source/apps/index.rst | 15 | ||||
| -rw-r--r-- | docs/source/apps/proj.rst | 8 | ||||
| -rw-r--r-- | docs/source/apps/projinfo.rst | 39 |
7 files changed, 52 insertions, 34 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/gie.rst b/docs/source/apps/gie.rst index 8cbd2336..bab0ec69 100644 --- a/docs/source/apps/gie.rst +++ b/docs/source/apps/gie.rst @@ -172,7 +172,7 @@ gie command language proj=urm5 n=0.5 inv expect failure pjd_err_malformed_pipeline - See ``gie -l`` for a list of error codes that can be expected. + See :option:`gie --list<--list>` for a list of error codes that can be expected. .. option:: tolerance <tolerance> @@ -273,7 +273,7 @@ gie command language expect 173 -45 - See ``gie -l`` for a list of error codes that can be ignored. + See :option:`gie --list<--list>` for a list of error codes that can be ignored. .. option:: require_grid <grid_name> diff --git a/docs/source/apps/index.rst b/docs/source/apps/index.rst index 8c2c8222..381b8933 100644 --- a/docs/source/apps/index.rst +++ b/docs/source/apps/index.rst @@ -4,15 +4,16 @@ Applications ================================================================================ -Bundled with PROJ comes a set of small command line utilities. The ``proj`` +Bundled with PROJ comes a set of small command line utilities. The :program:`proj` program is limited to converting between geographic and projection coordinates -within one datum. The ``cs2cs`` program operates similarly, but allows +within one datum. The :program:`cs2cs` program operates similarly, but allows translation between any pair of definable coordinate systems, including support -for datum transformation. The ``geod`` program provides the ability to do -geodesic (great circle) computations. ``gie`` is the program used for -regression tests in PROJ. ``cct`` a 4D equivalent to the ``proj`` program, -performs transformation coordinate systems on a set of input points. -``projinfo`` performs queries for geodetic objects and coordinate operations. +for datum transformation. The :program:`geod` program provides the ability to do +geodesic (great circle) computations. :program:`gie` is the program used for +regression tests in PROJ. :program:`cct`, a 4D equivalent to the :program:`proj` +program, performs transformation coordinate systems on a set of input points. +:program:`projinfo` performs queries for geodetic objects and coordinate +operations. .. toctree:: :maxdepth: 1 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>`. diff --git a/docs/source/apps/projinfo.rst b/docs/source/apps/projinfo.rst index 20225b25..fc816e40 100644 --- a/docs/source/apps/projinfo.rst +++ b/docs/source/apps/projinfo.rst @@ -16,7 +16,7 @@ Synopsis ******** | **projinfo** - | [-o formats] [-k crs|operation] [--summary] [-q] + | [-o formats] [-k crs|operation|ellipsoid] [--summary] [-q] | [[--area name_or_code] | [--bbox west_long,south_lat,east_long,north_lat]] | [--spatial-test contains|intersects] | [--crs-extent-use none|both|intersection|smallest] @@ -29,12 +29,19 @@ Synopsis | {object_definition} | {object_reference} | (-s {srs_def} -t {srs_def}) | - where {object_definition} is a PROJ string, a - WKT string, an object name or a AUTHORITY:CODE - (where AUTHORITY is the name of a CRS authority and CODE the code of a CRS - found in the proj.db database). + where {object_definition} or {srs_def} is - {object_reference} is a filename preceded with the '@' character. The + - a proj-string, + - a WKT string, + - an object code (like "EPSG:4326", "urn:ogc:def:crs:EPSG::4326", + "urn:ogc:def:coordinateOperation:EPSG::1671"), + - a OGC URN combining references for compound coordinate reference systems + (e.g "urn:ogc:def:crs,crs:EPSG::2393,crs:EPSG::5717" or custom abbreviated + syntax "EPSG:2393+5717"), + - a OGC URN combining references for concatenated operations + (e.g. "urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618") + + {object_reference} is a filename preceded by the '@' character. The file referenced by the {object_reference} must contain a valid {object_definition}. @@ -62,16 +69,16 @@ The following control parameters can appear in any order: Except ``all`` and ``default``, other formats can be preceded by ``-`` to disable them. -.. option:: -k crs|operation +.. option:: -k crs|operation|ellipsoid When used to query a single object with a AUTHORITY:CODE, determines the (k)ind of the object - in case there are CRS or coordinate operations with the same CODE. + in case there are CRS, coordinate operations or ellipsoids with the same CODE. The default is crs. .. option:: --summary When listing coordinate operations available between 2 CRS, return the - result in a summary format, mentionning only the name of the coordinate + result in a summary format, mentioning only the name of the coordinate operation, its accuracy and its area of use. .. note:: only used for coordinate operation computation @@ -107,8 +114,8 @@ The following control parameters can appear in any order: .. option:: --spatial-test contains|intersects Specify how the area of use of coordinate operations found in the database - are compared to the area of use specfied explicitly with :option:`--area` or :option:`--bbox`, - or derivedi implictly from the area of use of the source and target CRS. + are compared to the area of use specified explicitly with :option:`--area` or :option:`--bbox`, + or derived implicitly from the area of use of the source and target CRS. By default, projinfo will only keep coordinate operations whose are of use is strictly within the area of interest (``contains`` strategy). If using the ``intersects`` strategy, the spatial test is relaxed, and any @@ -195,6 +202,16 @@ The following control parameters can appear in any order: and their entries can refer to entries of the main database. The option may be repeated to specify several auxiliary databases. +.. option:: --identify + + When used with an object definition, this queries the PROJ database to find + known objects, typically CRS, that are close or identical to the object. + Each candidate object is associated with an approximate likelihood percentage. + This is useful when used with a WKT string that lacks a EPSG identifier, + such as ESRI WKT1. This might also be used with PROJ strings. + For example, `+proj=utm +zone=31 +datum=WGS84 +type=crs` will be identified + with a likelihood of 70% to EPSG:32631 + .. option:: --c-ify For developers only. Modify the string output of the utility so that it |