diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/man1/Makefile.am | 2 | ||||
| -rw-r--r-- | man/man1/projinfo.1 | 410 |
2 files changed, 411 insertions, 1 deletions
diff --git a/man/man1/Makefile.am b/man/man1/Makefile.am index b8a59ff2..7aadabb4 100644 --- a/man/man1/Makefile.am +++ b/man/man1/Makefile.am @@ -1,4 +1,4 @@ -man_MANS = geod.1 proj.1 cs2cs.1 cct.1 gie.1 +man_MANS = geod.1 proj.1 cs2cs.1 cct.1 gie.1 projinfo.1 EXTRA_DIST = $(man_MANS) diff --git a/man/man1/projinfo.1 b/man/man1/projinfo.1 new file mode 100644 index 00000000..fcfe3345 --- /dev/null +++ b/man/man1/projinfo.1 @@ -0,0 +1,410 @@ +.\" Man page generated from reStructuredText. +. +.TH "PROJINFO" "1" "Feb 14, 2019" "6.0.0" "PROJ.4" +.SH NAME +projinfo \- Geodetic object and coordinate operation queries +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.INDENT 0.0 +.INDENT 3.5 +.nf +\fBprojinfo\fP +.in +2 +[\-o formats] [\-k crs|operation] [\-\-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] +[\-\-grid\-check none|discard_missing|sort] [\-\-show\-superseded] +[\-\-pivot\-crs none|{auth:code[,auth:code]*}] +[\-\-boundcrs\-to\-wgs84] +[\-\-main\-db\-path path] [\-\-aux\-db\-path path]* +[\-\-identify] +[\-\-c\-ify] [\-\-single\-line] +{object_definition} | (\-s {srs_def} \-t {srs_def}) + +.in -2 +.fi +.sp +.sp +where {object_definition} or {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). +.UNINDENT +.UNINDENT +.SH DESCRIPTION +.sp +\fBprojinfo\fP is a program that can query information on a geodetic object, +coordinate reference system (CRS) or coordinate operation, when the \fB\-s\fP and \fB\-t\fP +options are specified, and display it under different formats (PROJ string, WKT string). +.sp +It can also be used to query coordinate operations available between two CRS. +.sp +The program is named with some reference to the GDAL \fBgdalsrsinfo\fP that offers +partly similar services. +.sp +The following control parameters can appear in any order: +.INDENT 0.0 +.TP +.B \-o formats +formats is a comma separated combination of: +\fBall\fP, \fBdefault\fP, \fBPROJ\fP, \fBWKT_ALL\fP, \fBWKT2_2015\fP, \fBWKT2_2018\fP, \fBWKT1_GDAL\fP, \fBWKT1_ESRI\fP\&. +.sp +Except \fBall\fP and \fBdefault\fP, other formats can be preceded by \fB\-\fP to disable them. +.UNINDENT +.INDENT 0.0 +.TP +.B \-k crs|operation +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. +The default is crs. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-summary +When listing coordinate operations available between 2 CRS, return the +result in a summary format, mentionning only the name of the coordinate +operation, its accuracy and its area of use. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-q +Turn on quiet mode. Quiet mode is only available for queries on single objects, +and only one output format is selected. In that mode, only the PROJ or WKT +string is displayed, without other introduction output. The output is then +potentially compatible of being piped in other utilities. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-area name_or_code +Specify an area of interest to restrict the results when researching +coordinate operations between 2 CRS. The area of interest can be specified either +as a name (e.g "Denmark \- onshore") or a AUTHORITY:CODE (EPSG:3237) +This option is exclusive of \fI\%\-\-bbox\fP\&. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-bbox west_long,south_lat,east_long,north_lat +Specify an area of interest to restrict the results when researching +coordinate operations between 2 CRS. The area of interest is specified as a +bounding box with geographic coordinates, expressed in degrees in a +unspecified geographic CRS. +\fIwest_long\fP and \fIeast_long\fP should be in the [\-180,180] range, and +\fIsouth_lat\fP and \fInorth_lat\fP in the [\-90,90]. \fIwest_long\fP is generally lower than +\fIeast_long\fP, except in the case where the area of interest crosses the antimeridian. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-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 \fI\%\-\-area\fP or \fI\%\-\-bbox\fP, +or derivedi implictly 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 (\fBcontains\fP strategy). +If using the \fBintersects\fP strategy, the spatial test is relaxed, and any +coordinate operation whose area of use at least partly intersects the +area of interest is listed. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-crs\-extent\-use none|both|intersection|smallest +Specify which area of interest to consider when no explicit one is specified +with \fI\%\-\-area\fP or \fI\%\-\-bbox\fP options. +By default (\fBsmallest\fP strategy), the area of +use of the source or target CRS will be looked, and the one that is the +smallest one in terms of area will be used as the area of interest. +If using \fBnone\fP, no area of interest is used. +If using \fBboth\fP, only coordinate operations that relate (contain or intersect +depending of the \fI\%\-\-spatial\-test\fP strategy) to the area of use of both CRS +are selected. +If using \fBintersection\fP, the area of interest is the intersection of the +bounding box of the area of use of the source and target CRS +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-grid\-check none|discard_missing|sort +Specify how the presence or absence of a horizontal or vertical shift grid +required for a coordinate operation affects the results returned when +researching coordinate operations between 2 CRS. +The default strategy is \fBsort\fP: in that case, all candidate +operations are returned, but the actual availability of the grids is used +to determine the sorting order. That is, if a coordinate operation involves +using a grid that is not available in the PROJ resource directories +(determined by the \fBPROJ_LIB\fP environment variable, it will be listed in +the bottom of the results. +The \fBnone\fP strategy completely disables the checks of presence of grids and +this returns the results as if all the grids where available. +The \fBdiscard_missing\fP strategy discards results that involve grids not +present in the PROJ resource directories. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-show\-superseded +When enabled, coordinate operations that are superseded by others will be +listed. Note that supersession is not equivalent to deprecation: superseded +operations are still considered valid although they have a better equivalent, +whereas deprecated operations have been determined to be erroneous and are +not considered at all. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-pivot\-crs none|{auth:code[,auth:code]*} +Determine if intermediate (pivot) CRS can be used when researching coordinate +operation between 2 CRS. A typical example is the WGS84 pivot. By default, +projinfo will consider any potential pivot. If using the \fBnone\fP strategy, +only direct transformations between the source and target CRS will be +used. It is also possible to restrict the pivot CRS to consider by specifying +one or several CRS by their AUTHORITY:CODE. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +only used for coordinate operation computation +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-boundcrs\-to\-wgs84 +When specified, this option researches a coordinate operation from the +base geographic CRS of the single CRS, source or target CRS to the WGS84 +geographic CRS, and if found, wraps those CRS into a BoundCRS object. +This is mostly to be used for early\-binding approaches. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-main\-db\-path path +Specify the name and path of the database to be used by projinfo. The +default is proj.db in the PROJ resource directories. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-aux\-db\-path path +Specify the name and path of auxiliary databases, that are to be combined +with the main database. Those auxiliary databases must have a table +structure that is identical to the main database, but can be partly filled +and their entries can refer to entries of the main database. +The option may be repeated to specify several auxiliary databases. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-c\-ify +For developers only. Modify the string output of the utility so that it +is easy to put those strings in C/C++ code +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-single\-line +Output WKT strings on a single line, instead of multiple intended lines by +default. +.UNINDENT +.SH EXAMPLES +.INDENT 0.0 +.IP 1. 3 +Query the CRS object corresponding to EPSG:4326 +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +projinfo EPSG:4326 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Output: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +PROJ.4 string: ++proj=longlat +datum=WGS84 +no_defs +type=crs + +WKT2_2018 string: +GEOGCRS["WGS 84", + DATUM["World Geodetic System 1984", + ELLIPSOID["WGS 84",6378137,298.257223563, + LENGTHUNIT["metre",1]]], + PRIMEM["Greenwich",0, + ANGLEUNIT["degree",0.0174532925199433]], + CS[ellipsoidal,2], + AXIS["geodetic latitude (Lat)",north, + ORDER[1], + ANGLEUNIT["degree",0.0174532925199433]], + AXIS["geodetic longitude (Lon)",east, + ORDER[2], + ANGLEUNIT["degree",0.0174532925199433]], + USAGE[ + SCOPE["unknown"], + AREA["World"], + BBOX[\-90,\-180,90,180]], + ID["EPSG",4326]] +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.IP 2. 3 +List the coordinate operations between NAD27 (designed with its CRS name) +and NAD83 (designed with its EPSG code 4269) within an area of interest +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +projinfo \-s NAD27 \-t EPSG:4269 \-\-area "USA \- Missouri" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Output: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +DERIVED_FROM(EPSG):1241, NAD27 to NAD83 (1), 0.15 m, USA \- CONUS including EEZ + +PROJ string: ++proj=pipeline +step +proj=axisswap +order=2,1 +step +proj=unitconvert \e ++xy_in=deg +xy_out=rad +step +proj=hgridshift +grids=conus \e ++step +proj=unitconvert +xy_in=rad +xy_out=deg +step +proj=axisswap +order=2,1 + +WKT2_2018 string: +COORDINATEOPERATION["NAD27 to NAD83 (1)", + SOURCECRS[ + GEOGCRS["NAD27", + DATUM["North American Datum 1927", + ELLIPSOID["Clarke 1866",6378206.4,294.978698213898, + LENGTHUNIT["metre",1]]], + PRIMEM["Greenwich",0, + ANGLEUNIT["degree",0.0174532925199433]], + CS[ellipsoidal,2], + AXIS["geodetic latitude (Lat)",north, + ORDER[1], + ANGLEUNIT["degree",0.0174532925199433]], + AXIS["geodetic longitude (Lon)",east, + ORDER[2], + ANGLEUNIT["degree",0.0174532925199433]]]], + TARGETCRS[ + GEOGCRS["NAD83", + DATUM["North American Datum 1983", + ELLIPSOID["GRS 1980",6378137,298.257222101, + LENGTHUNIT["metre",1]]], + PRIMEM["Greenwich",0, + ANGLEUNIT["degree",0.0174532925199433]], + CS[ellipsoidal,2], + AXIS["geodetic latitude (Lat)",north, + ORDER[1], + ANGLEUNIT["degree",0.0174532925199433]], + AXIS["geodetic longitude (Lon)",east, + ORDER[2], + ANGLEUNIT["degree",0.0174532925199433]]]], + METHOD["CTABLE2"], + PARAMETERFILE["Latitude and longitude difference file","conus"], + OPERATIONACCURACY[0.15], + USAGE[ + SCOPE["unknown"], + AREA["USA \- CONUS including EEZ"], + BBOX[23.81,\-129.17,49.38,\-65.69]], + ID["DERIVED_FROM(EPSG)",1241]] +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +\fBcs2cs(1)\fP, \fBcct(1)\fP, \fBgeod(1)\fP, \fBgie(1)\fP, \fBproj(1)\fP +.SH BUGS +.sp +A list of know bugs can be found at \fI\%https://github.com/OSGeo/proj.4/issues\fP +where new bug reports can be submitted to. +.SH HOME PAGE +.sp +\fI\%https://proj4.org/\fP +.SH AUTHOR +Even Rouault +.SH COPYRIGHT +1983-2019 +.\" Generated by docutils manpage writer. +. |