diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2018-05-24 18:28:48 +0200 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2018-05-24 18:28:48 +0200 |
| commit | 08ae33432776368649ca30d6c314cc07c8eba445 (patch) | |
| tree | 71a60ee0d0a4f81e6a6a0fb6513364901d87ed2f | |
| parent | 62960c27e44ba1259bad509740a0a8b0925caa5e (diff) | |
| download | PROJ-08ae33432776368649ca30d6c314cc07c8eba445.tar.gz PROJ-08ae33432776368649ca30d6c314cc07c8eba445.zip | |
Update man pages in preparation for new release
| -rw-r--r-- | man/man1/cct.1 | 47 | ||||
| -rw-r--r-- | man/man1/cs2cs.1 | 106 | ||||
| -rw-r--r-- | man/man1/geod.1 | 110 | ||||
| -rw-r--r-- | man/man1/gie.1 | 162 | ||||
| -rw-r--r-- | man/man1/proj.1 | 121 | ||||
| -rw-r--r-- | man/man3/geodesic.3 | 2 | ||||
| -rw-r--r-- | man/man3/pj_init.3 | 4 |
7 files changed, 342 insertions, 210 deletions
diff --git a/man/man1/cct.1 b/man/man1/cct.1 index 5ab6d314..3a4fdffc 100644 --- a/man/man1/cct.1 +++ b/man/man1/cct.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "CCT" "1" "Mar 18, 2018" "5.0.0" "PROJ.4" +.TH "CCT" "1" "May 24, 2018" "5.1.0" "PROJ.4" .SH NAME cct \- Coordinate Conversion and Transformation . @@ -33,17 +33,17 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 -\fBcct\fP [ \fB\-cotvz\fP [ args ] ] \fI+opts[=arg]\fP file[s] +\fBcct\fP [ \fB\-cIostvz\fP [ args ] ] \fI+opts[=arg]\fP file[s] .UNINDENT .UNINDENT .SH DESCRIPTION .sp \fBcct\fP a 4D equivalent to the \fBproj\fP projection program, -performs transformation coordinate systems on a set of input points. The -coordinate system transformation can include translation between projected +performs transformation coordinate systems on a set of input points. The +coordinate system transformation can include translation between projected and geographic coordinates as well as the application of datum shifts. .sp -The following control parameters can appear in any order: +The following control parameters can appear in any order: .INDENT 0.0 .TP .B \-c <x,y,z,t> @@ -51,18 +51,32 @@ Specify input columns for (up to) 4 input parameters. Defaults to 1,2,3,4. .UNINDENT .INDENT 0.0 .TP +.B \-I +Do the inverse transformation. +.UNINDENT +.INDENT 0.0 +.TP .B \-o <output file name>, \-\-output=<output file name> Specify the name of the output file. .UNINDENT .INDENT 0.0 .TP .B \-t <time>, \-\-time=<time> -Specify a fixed observation time to be used for all input data. +Specify a fixed observation \fItime\fP to be used for all input data. .UNINDENT .INDENT 0.0 .TP .B \-z <height>, \-\-height=<height> -Specify a fixed observation height to be used for all input data. +Specify a fixed observation \fIheight\fP to be used for all input data. +.UNINDENT +.INDENT 0.0 +.TP +.B \-s <n>, \-\-skip\-lines=<n> +New in version 5.1.0. + +.sp +Skip the first \fIn\fP lines of input. This applies to any kind of input, whether +it comes from \fBSTDIN\fP, a file or interactive user input. .UNINDENT .INDENT 0.0 .TP @@ -70,6 +84,11 @@ Specify a fixed observation height to be used for all input data. Write non\-essential, but potentially useful, information to stderr. Repeat for additional information (\fB\-vv\fP, \fB\-vvv\fP, etc.) .UNINDENT +.INDENT 0.0 +.TP +.B \-\-version +Print version number. +.UNINDENT .sp The \fI+args\fP arguments are associated with coordinate operation parameters. Usage varies with operation. @@ -77,7 +96,7 @@ Usage varies with operation. \fBcct\fP is an acronym meaning \fICoordinate Conversion and Transformation\fP\&. .sp The acronym refers to definitions given in the OGC 08\-015r2/ISO\-19111 -standard “Geographical Information – Spatial Referencing by Coordinates”, +standard "Geographical Information \-\- Spatial Referencing by Coordinates", which defines two different classes of \fIcoordinate operations\fP: .sp \fICoordinate Conversions\fP, which are coordinate operations where input @@ -116,7 +135,7 @@ echo 12 55 | cct \-z0 \-t0 +proj=utm +zone=32 +ellps=GRS80 .UNINDENT .UNINDENT .sp -Should give results comparable to the classic proj command +Should give results comparable to the classic \fBproj\fP command .INDENT 0.0 .INDENT 3.5 .sp @@ -164,7 +183,7 @@ As (2) but specify input columns for longitude, latitude, height and time: .sp .nf .ft C -cct \-c 5,2,1,4 +proj=utm +ellps=GRS80 +zone=32 +cct \-c 5,2,1,4 +proj=utm +ellps=GRS80 +zone=32 .ft P .fi .UNINDENT @@ -179,25 +198,25 @@ input: .sp .nf .ft C -cct \-t 0 \-z 0 +proj=utm +ellps=GRS80 +zone=32 +cct \-t 0 \-z 0 +proj=utm +ellps=GRS80 +zone=32 .ft P .fi .UNINDENT .UNINDENT .SH BACKGROUND .sp -\fBcct\fP also refers to Carl Christian Tscherning (1942–2014), +\fBcct\fP also refers to Carl Christian Tscherning (1942\-\-2014), professor of Geodesy at the University of Copenhagen, mentor and advisor for a generation of Danish geodesists, colleague and collaborator for two generations of global geodesists, Secretary General for the -International Association of Geodesy, IAG (1995–2007), fellow of the +International Association of Geodesy, IAG (1995\-\-2007), fellow of the American Geophysical Union (1991), recipient of the IAG Levallois Medal (2007), the European Geosciences Union Vening Meinesz Medal (2008), and of numerous other honours. .sp \fIcct\fP, or Christian, as he was known to most of us, was recognized for his good mood, his sharp wit, his tireless work, and his great commitment to -the development of geodesy – both through his scientific contributions, +the development of geodesy \-\- both through his scientific contributions, comprising more than 250 publications, and by his mentoring and teaching of the next generations of geodesists. .sp diff --git a/man/man1/cs2cs.1 b/man/man1/cs2cs.1 index 1f334911..eb1ad4da 100644 --- a/man/man1/cs2cs.1 +++ b/man/man1/cs2cs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "CS2CS" "1" "Mar 18, 2018" "5.0.0" "PROJ.4" +.TH "CS2CS" "1" "May 24, 2018" "5.1.0" "PROJ.4" .SH NAME cs2cs \- Cartographic coordinate system filter . @@ -39,43 +39,41 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH DESCRIPTION .sp \fBcs2cs\fP performs transformation between the source and destination -cartographic coordinate system on a set of input points. The coordinate -system transformation can include translation between projected and +cartographic coordinate system on a set of input points. The coordinate +system transformation can include translation between projected and geographic coordinates as well as the application of datum shifts. .sp -The following control parameters can appear in any order: +The following control parameters can appear in any order: .INDENT 0.0 .TP .B \-I -method to specify inverse translation, convert from \fI+to\fP coordinate system to +Method to specify inverse translation, convert from \fI+to\fP coordinate system to the primary coordinate system defined. .UNINDENT .INDENT 0.0 .TP .B \-t<a> -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). +Where \fIa\fP 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). .UNINDENT .INDENT 0.0 .TP .B \-e <string> -String is an arbitrary string to be output if an error is detected during -data transformations. The default value is: \fIt\fP\&. Note that if the \-b, \-i -or \-o options are employed, an error is returned as HUGE_VAL value for both -return values. +Where \fIstring\fP is an arbitrary string to be output if an error is detected during +data transformations. The default value is a three character string: \fB*\et*\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-E -causes the input coordinates to be copied to the output line prior to -printing the converted values. +Causes the input coordinates to be copied to the output line prior to +printing the converted values. .UNINDENT .INDENT 0.0 .TP .B \-l<[=id]> List projection identifiers that can be selected with \fI+proj\fP\&. \fBcs2cs \-l=id\fP -gives expanded description of projection id, e.g. \fBcs2cs \-l=merc\fP\&. +gives expanded description of projection \fIid\fP, e.g. \fBcs2cs \-l=merc\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -119,58 +117,64 @@ to y\-x or latitude\-longitude. .INDENT 0.0 .TP .B \-f <format> -Format is a printf format string to control the form of the output values. +Where \fIformat\fP 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 deci\- mal degrees. The default format is “%.2f” for forward +employed. If a format is specified for inverse projection the output data +will be in decimal degrees. The default format is \fB"%.2f"\fP for forward projection and DMS for inverse. .UNINDENT .INDENT 0.0 .TP -.B \-[w|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. +.B \-w<n> +Where \fIn\fP is the number of significant fractional digits to employ for seconds +output (when the option is not specified, \fB\-w3\fP is assumed). +.UNINDENT +.INDENT 0.0 +.TP +.B \-W<n> +Where \fIn\fP is the number of significant fractional digits to employ for seconds +output. When \fB\-W\fP is employed the fields will be constant width +with leading zeroes. .UNINDENT .INDENT 0.0 .TP .B \-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. .UNINDENT .sp The \fI+args\fP run\-line arguments are associated with cartographic parameters. .sp -The \fBcs2cs\fP program requires two coordinate system definitions. The first (or -primary is defined based on all projection parameters not appearing after the -\fI+to\fP argument. All projection parameters appearing after the \fI+to\fP argument -are considered the definition of the second coordinate system. If there is no +The \fBcs2cs\fP program requires two coordinate system definitions. The first (or +primary is defined based on all projection parameters not appearing after the +\fI+to\fP argument. All projection parameters appearing after the \fI+to\fP argument +are considered the definition of the second coordinate system. If there is no second coordinate system defined, a geographic coordinate system based on the -datum and ellipsoid of the source coordinate system is assumed. Note that the -source and destination coordinate system can both be projections, both be +datum and ellipsoid of the source coordinate system is assumed. Note that the +source and destination coordinate system can both be projections, both be geographic, or one of each and may have the same or different datums. .sp -Additional projection control parameters may be contained in two auxiliary -control files: the first is optionally referenced with the +Additional projection control parameters may be contained in two auxiliary +control files: the first is optionally referenced with the \fI+init=file:id\fP and the second is always processed after the name of the -projection has been established from either the run\-line or the contents of -\fI+init\fP file. The environment parameter 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. +projection has been established from either the run\-line or the contents of +\fI+init\fP file. The environment parameter \fBPROJ_LIB\fP establishes the default +directory for a file reference without an absolute path. This is also used +for supporting files like datum shift files. .sp -One or more files (processed in left to right order) specify the source of -data to be transformed. A \fB\-\fP will specify the location of processing standard -input. If no files are specified, the input is assumed to be from stdin. -For input data the two data values must be in the first two white space -separated fields and when both input and output are ASCII all trailing portions +One or more files (processed in left to right order) specify the source of +data to be transformed. A \fB\-\fP will specify the location of processing standard +input. If no files are specified, the input is assumed to be from stdin. +For input data the two data values must be in the first two white space +separated fields and when both input and output are ASCII all trailing portions of the input line are appended to the output line. .sp -Input geographic data (longitude and latitude) must be in DMS or decimal -degrees format and input cartesian data must be in units consistent with the -ellipsoid major axis or sphere radius units. Output geographic coordinates will +Input geographic data (longitude and latitude) must be in DMS or decimal +degrees format and input cartesian data must be in units consistent with the +ellipsoid major axis or sphere radius units. Output geographic coordinates will normally be in DMS format (use \fB\-f %.12f\fP for decimal degrees with 12 decimal -places), while projected (cartesian) coordinates will be in linear +places), while projected (cartesian) coordinates will be in linear (meter, feet) units. .SH EXAMPLE .sp @@ -180,17 +184,19 @@ The following script .sp .nf .ft C -cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 \-r -<<EOF 45d15\(aq33.1" 111.5W 45d15.551666667N \-111d30 +45.25919444444 -111d30\(aq000w EOF +cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 \-r <<EOF +45d15\(aq33.1" 111.5W +45d15.551666667N \-111d30 ++45.25919444444 111d30\(aq000w +EOF .ft P .fi .UNINDENT .UNINDENT .sp -will transform the input NAD83 geographic coordinates into NAD27 coordinates in -the UTM projection with zone 10 selected. The geographic values of this -example are equivalent and meant as examples of various forms of DMS input. +will transform the input NAD83 geographic coordinates into NAD27 coordinates in +the UTM projection with zone 10 selected. The geographic values of this +example are equivalent and meant as examples of various forms of DMS input. The x\-y output data will appear as three lines of: .INDENT 0.0 .INDENT 3.5 diff --git a/man/man1/geod.1 b/man/man1/geod.1 index 9918abbf..84cbf003 100644 --- a/man/man1/geod.1 +++ b/man/man1/geod.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "GEOD" "1" "Mar 18, 2018" "5.0.0" "PROJ.4" +.TH "GEOD" "1" "May 24, 2018" "5.1.0" "PROJ.4" .SH NAME geod \- Geodesic computations . @@ -35,20 +35,20 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .INDENT 3.5 \fBgeod\fP \fI+ellps=<ellipse>\fP [ \fB\-afFIlptwW\fP [ args ] ] [ \fI+args\fP ] file[s] .sp -\fBinvgeod\fP \fI+ellps=<ellipse>\fP [ \fB\-afFIlptwW\fP [ args ] ] [ \fI+args\fP ] file[s] +\fBinvgeod\fP \fI+ellps=<ellipse>\fP [ \fB\-afFIlptwW\fP [ args ] ] [ \fI+args\fP ] file[s] .UNINDENT .UNINDENT .SH DESCRIPTION .sp -\fBgeod\fP (direct) and \fBinvgeod\fP (inverse) perform geodesic -(Great Circle) computations for determining latitude, longitude and back -azimuth of a terminus point given a initial point latitude, longitude, -azimuth and distance (direct) or the forward and back azimuths and distance -between an initial and terminus point latitudes and longitudes (inverse). -The results are accurate to round off for |f| < 1/50, where +\fBgeod\fP (direct) and \fBinvgeod\fP (inverse) perform geodesic +(Great Circle) computations for determining latitude, longitude and back +azimuth of a terminus point given a initial point latitude, longitude, +azimuth and distance (direct) or the forward and back azimuths and distance +between an initial and terminus point latitudes and longitudes (inverse). +The results are accurate to round off for |f| < 1/50, where f is flattening. .sp -\fBinvgeod\fP may not be available on all platforms; in this case +\fBinvgeod\fP may not be available on all platforms; in this case use \fI\%geod \-I\fP instead. .sp The following command\-line options can appear in any order: @@ -56,18 +56,18 @@ The following command\-line options can appear in any order: .TP .B \-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 \fBgeod\fP as an alternative to \fBinvgeod\fP execution. .UNINDENT .INDENT 0.0 .TP .B \-a Latitude and longitudes of the initial and terminal points, forward and -back azimuths and distance are output. +back azimuths and distance are output. .UNINDENT .INDENT 0.0 .TP -.B \-ta -A specifies a character employed as the first character to denote a control +.B \-t<a> +Where \fIa\fP specifies a character employed as the first character to denote a control line to be passed through without processing. .UNINDENT .INDENT 0.0 @@ -79,33 +79,33 @@ Gives a listing of all the ellipsoids that may be selected with the .INDENT 0.0 .TP .B \-lu -Gives a listing of all the units that may be selected with the \fI+units=\fP +Gives a listing of all the units that may be selected with the \fI+units=\fP option. .UNINDENT .INDENT 0.0 .TP .B \-f <format> -Format is a printf format string to control the output form of the +Where \fIformat\fP 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 \fB"%.3f"\fP for distance. .UNINDENT .INDENT 0.0 .TP .B \-F <format> -Format is a printf format string to control the output form of the distance +Where \fIformat\fP is a printf format string to control the output form of the distance value (\fB\-F\fP). The default mode is DMS for geographic coordinates and -“%.3f” for distance. +\fB"%.3f"\fP for distance. .UNINDENT .INDENT 0.0 .TP .B \-w<n> -N is the number of significant fractional digits to employ for seconds +Where \fIn\fP is the number of significant fractional digits to employ for seconds output (when the option is not specified, \fB\-w3\fP is assumed). .UNINDENT .INDENT 0.0 .TP .B \-W<n> -N is the number of significant fractional digits to employ for seconds +Where \fIn\fP is the number of significant fractional digits to employ for seconds output. When \fB\-W\fP is employed the fields will be constant width with leading zeroes. .UNINDENT @@ -116,61 +116,61 @@ This option causes the azimuthal values to be output as unsigned DMS numbers between 0 and 360 degrees. Also note \fI\%\-f\fP\&. .UNINDENT .sp -The \fI+args\fP 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 +The \fI+args\fP 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 the first occurrence assumed to be the desired value. .sp See the PROJ documentation for a full list of these parameters and controls. .sp -One or more files (processed in left to right order) specify -the source of data to be transformed. A \fB\-\fP will specify the -location of processing standard input. If no files are specified, +One or more files (processed in left to right order) specify +the source of data to be transformed. A \fB\-\fP will specify the +location of processing standard input. If no files are specified, the input is assumed to be from stdin. .sp -For direct determinations input data must be in latitude, longitude, +For direct determinations input data must be in latitude, longitude, azimuth and distance order and output will be latitude, -longitude and back azimuth of the terminus point. Latitude, -longitude of the initial and terminus point are input for the -inverse mode and respective forward and back azimuth from the -initial and terminus points are output along with the distance +longitude and back azimuth of the terminus point. Latitude, +longitude of the initial and terminus point are input for the +inverse mode and respective forward and back azimuth from the +initial and terminus points are output along with the distance between the points. .sp -Input geographic coordinates (latitude and longitude) and -azimuthal data must be in decimal degrees or DMS format and +Input geographic coordinates (latitude and longitude) and +azimuthal data must be in decimal degrees or DMS format and input distance data must be in units consistent with the ellipsoid -major axis or sphere radius units. The latitude must lie -in the range [\-90d,90d]. Output geographic coordinates will be -in DMS (if the \fI\%\-f\fP switch is not employed) to 0.001” with trailing, -zero\-valued minute\-second fields deleted. Output distance -data will be in the same units as the ellipsoid or sphere +major axis or sphere radius units. The latitude must lie +in the range [\-90d,90d]. Output geographic coordinates will be +in DMS (if the \fI\%\-f\fP switch is not employed) to 0.001" with trailing, +zero\-valued minute\-second fields deleted. Output distance +data will be in the same units as the ellipsoid or sphere radius. .sp -The Earth’s ellipsoidal figure may be selected in the same manner +The Earth\(aqs ellipsoidal figure may be selected in the same manner as program \fBproj\fP by using \fI+ellps=\fP, \fI+a=\fP, \fI+es=\fP, etc. .sp -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 \fI+lat_1=lat\fP and \fI+lon_1=lon\fP -parameters and either a terminus point \fI+lat_2=lat\fP and -\fI+lon_2=lon\fP or a distance and azimuth from the initial point +\fBgeod\fP 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 \fI+lat_1=lat\fP and \fI+lon_1=lon\fP +parameters and either a terminus point \fI+lat_2=lat\fP and +\fI+lon_2=lon\fP or a distance and azimuth from the initial point with \fI+S=distance\fP and \fI+A=azimuth\fP must be specified. .sp -If points along a geodesic are to be determined then either -\fI+n_S=integer\fP specifying the number of intermediate points -and/or \fI+del_S=distance\fP specifying the incremental distance +If points along a geodesic are to be determined then either +\fI+n_S=integer\fP specifying the number of intermediate points +and/or \fI+del_S=distance\fP specifying the incremental distance between points must be specified. .sp -To determine points along an arc equidistant from the initial -point both \fI+del_A=angle\fP and \fI+n_A=integer\fP must be specified +To determine points along an arc equidistant from the initial +point both \fI+del_A=angle\fP and \fI+n_A=integer\fP must be specified which determine the respective angular increments and number of points to be determined. .SH EXAMPLES .sp -The following script determines the geodesic azimuths and distance in U.S. +The following script determines the geodesic azimuths and distance in U.S. statute miles from Boston, MA, to Portland, OR: .INDENT 0.0 .INDENT 3.5 @@ -200,8 +200,8 @@ which gives the results: where the first two values are the azimuth from Boston to Portland, the back azimuth from Portland to Boston followed by the distance. .sp -An example of forward geodesic use is to use the Boston location -and determine Portland’s location by azimuth and distance: +An example of forward geodesic use is to use the Boston location +and determine Portland\(aqs location by azimuth and distance: .INDENT 0.0 .INDENT 3.5 .sp @@ -230,7 +230,7 @@ which gives: \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 -Lack of precision in the distance value compromises the +Lack of precision in the distance value compromises the precision of the Portland location. .UNINDENT .UNINDENT diff --git a/man/man1/gie.1 b/man/man1/gie.1 index cdadc266..8433e749 100644 --- a/man/man1/gie.1 +++ b/man/man1/gie.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "GIE" "1" "Mar 18, 2018" "5.0.0" "PROJ.4" +.TH "GIE" "1" "May 24, 2018" "5.1.0" "PROJ.4" .SH NAME gie \- The Geospatial Integrity Investigation Environment . @@ -56,14 +56,14 @@ Specify output file name .INDENT 0.0 .TP .B \-v, \-\-verbose -Verbose: Provide non\-essential informational output. Repeat \fI\%\-v\fP for +Verbose: Provide non\-essential informational output. Repeat \fI\%\-v\fP for more verbosity (e.g. \fB\-vv\fP) .UNINDENT .INDENT 0.0 .TP .B \-q, \-\-quiet -Quiet: Opposite of verbose. In quiet mode not even errors are -reported. Only interaction is through the return code (0 on success, +Quiet: Opposite of verbose. In quiet mode not even errors are +reported. Only interaction is through the return code (0 on success, non\-zero indicates number of FAILED tests) .UNINDENT .INDENT 0.0 @@ -71,6 +71,11 @@ non\-zero indicates number of FAILED tests) .B \-l, \-\-list List the PROJ internal system error codes .UNINDENT +.INDENT 0.0 +.TP +.B \-\-version +Print version number +.UNINDENT .sp Tests for \fBgie\fP are defined in simple text files. Usually having the extension \fB\&.gie\fP\&. Test for \fBgie\fP are written in the purpose\-build command language for gie. @@ -102,7 +107,7 @@ expect 691_875.632_14 6_098_907.825_05 .UNINDENT .UNINDENT .sp -Parsing of a \fBgie\fP file starts at \fB<gie>\fP and ends when \fB</gie>\fP +Parsing of a \fBgie\fP file starts at \fB<gie>\fP and ends when \fB</gie>\fP is reached. Anything before \fB<gie>\fP and after \fB</gie>\fP is not considered. Test cases are created by defining an \fI\%operation\fP which \fI\%accept\fP an input coordinate and \fI\%expect\fP an output @@ -185,8 +190,8 @@ version of the operation is tested (2D, 3D or 4D). Many coordinates can be accepted for one \fI\%operation\fP\&. For each \fI\%accept\fP an accompanying \fI\%expect\fP is needed. .sp -Note that \fBgie\fP accepts the underscore (“_”) as a thousands -separator. It is not required (in fact, it is entirely ignored by the +Note that \fBgie\fP accepts the underscore (\fB_\fP) 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. .sp @@ -204,9 +209,9 @@ Many coordinates can be expected for one \fI\%operation\fP\&. For each See \fI\%operation\fP for an example. .sp In addition to expecting a coordinate it is also possible to expect a -PROJ error code in case an operation can’t be created. This is useful when +PROJ error code in case an operation can\(aqt be created. This is useful when testing that errors are caught and handled correctly. Below is an example of -that tests that the pipeline operator fails correctly when a non\-invertable +that tests that the pipeline operator fails correctly when a non\-invertible pipeline is constructed. .INDENT 7.0 .INDENT 3.5 @@ -229,7 +234,7 @@ See \fBgie \-l\fP for a list of error codes that can be expected. The \fI\%tolerance\fP command controls how much accepted coordinates can deviate from the expected coordinate. This is handy to test that an operation meets a certain numerical tolerance threshold. Some operations -are expexted to be accurate within milimeters where others might only be +are expected to be accurate within millimeters where others might only be accurate within a few meters. \fI\%tolerance\fP should .INDENT 7.0 .INDENT 3.5 @@ -262,16 +267,52 @@ units. Do a roundtrip test of an operation. \fI\%roundtrip\fP needs a \fI\%operation\fP and a \fI\%accept\fP command to function. The accepted coordinate is passed to the operation first in -it’s forward mode, then the output from the forward operation is passed +it\(aqs forward mode, then the output from the forward operation is passed back to the inverse operation. This procedure is done \fBn\fP times. If the -resulting coordinate is within the set tolerance of the initial coordinate +resulting coordinate is within the set tolerance of the initial coordinate, the test is passed. .sp -Example: +Example with the default 100 iterations and the default tolerance: +.INDENT 7.0 +.INDENT 3.5 .sp +.nf +.ft C +operation proj=merc +accept 12 55 +roundtrip +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Example with count and default tolerance: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +operation proj=merc +accept 12 55 +roundtrip 10000 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Example with count and tolerance: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C operation proj=merc accept 12 55 roundtrip 10000 5 mm +.ft P +.fi +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -302,7 +343,7 @@ expect 12 55 0 0 .UNINDENT .UNINDENT .sp -The default direction is “forward”. +The default direction is "forward". .UNINDENT .INDENT 0.0 .TP @@ -315,7 +356,7 @@ available. Below is an example of that situation. .sp .nf .ft C -operation proj=hgridshift +grids=nzgd2kgrid0005.gsb ellps=GRS80 +operation proj=hgridshift +grids=nzgd2kgrid0005.gsb ellps=GRS80 tolerance 1 mm ignore pjd_err_failed_to_load_grid accept 172.999892181021551 \-45.001620431954613 @@ -327,40 +368,101 @@ expect 173 \-45 .sp See \fBgie \-l\fP for a list of error codes that can be ignored. .UNINDENT +.INDENT 0.0 +.TP +.B echo <text> +Add user defined text to the output stream. See the example below. +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +<gie> +echo ** Mercator projection tests ** +operation +proj=merc +accept 0 0 +expect 0 0 +</gie> +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +which returns +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +Reading file \(aqtest.gie\(aq +** Mercator projection test ** +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +total: 1 tests succeeded, 0 tests skipped, 0 tests failed. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B skip +Skip any test after the first occurrence of \fI\%skip\fP\&. In the example below only +the first test will be performed. The second test is skipped. This feature is mostly +relevant for debugging when writing new test cases. +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +<gie> +operation proj=merc +accept 0 0 +expect 0 0 +skip +accept 0 1 +expect 0 110579.9 +</gie> +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT .SH BACKGROUND .sp -More importantly than being an acronym for “Geospatial Integrity Investigation -Environment”, gie were also the initials, user id, and USGS email address of -Gerald Ian Evenden (1935–2016), the geospatial visionary, who, already in the -1980s, started what was to become the PROJ of today. +More importantly than being an acronym for "Geospatial Integrity Investigation +Environment", gie were also the initials, user id, and USGS email address of +Gerald Ian Evenden (1935\-\-2016), the geospatial visionary, who, already in the +1980s, started what was to become the PROJ of today. .sp -Gerald’s clear vision was that map projections are \fIjust special functions\fP\&. +Gerald\(aqs clear vision was that map projections are \fIjust special functions\fP\&. Some of them rather complex, most of them of two variables, but all of them \fIjust special functions\fP, and not particularly more special than the \fBsin()\fP, -\fBcos()\fP, \fBtan()\fP, and \fBhypot()\fP already available in the C standard library. +\fBcos()\fP, \fBtan()\fP, and \fBhypot()\fP already available in the C standard library. .sp And hence, according to Gerald, \fIthey should not be particularly much harder -to use\fP, for a programmer, than the \fBsin()\fP’s, \fBtan()\fP’s and -\fBhypot()\fP’s so readily available. +to use\fP, for a programmer, than the \fBsin()\fP\(aqs, \fBtan()\fP\(aqs and +\fBhypot()\fP\(aqs so readily available. .sp -Gerald’s ingenuity also showed in the implementation of the vision, where +Gerald\(aqs ingenuity also showed in the implementation of the vision, where he devised a comprehensive, yet simple, system of key\-value pairs for -parameterising a map projection, and the highly flexible PJ struct, storing -run\-time compiled versions of those key\-value pairs, hence mak\- ing a map -projection function call, pj_fwd(PJ, point), as easy as a traditional function +parameterising a map projection, and the highly flexible \fBPJ\fP struct, storing +run\-time compiled versions of those key\-value pairs, hence making a map +projection function call, \fBpj_fwd(PJ, point)\fP, as easy as a traditional function call like \fBhypot(x,y)\fP\&. .sp While today, we may have more formally well defined metadata systems (most prominent the OGC WKT2 representation), nothing comes close being as easily -readable (“human compatible”) as Gerald’s key\-value system. This system in -particular, and the PROJ system in general, was Gerald’s great gift to anyone +readable ("human compatible") as Gerald\(aqs key\-value system. This system in +particular, and the PROJ system in general, was Gerald\(aqs great gift to anyone using and/or communicating about geodata. .sp It is only reasonable to name a program, keeping an eye on the integrity of the PROJ system, in honour of Gerald. .sp So in honour, and hopefully also in the spirit, of Gerald Ian Evenden -(1935–2016), this is the Geospatial Integrity Investigation Environment. +(1935\-\-2016), this is the Geospatial Integrity Investigation Environment. .SH SEE ALSO .sp \fBproj(1)\fP, \fBcs2cs(1)\fP, \fBcct(1)\fP, \fBgeod(1)\fP diff --git a/man/man1/proj.1 b/man/man1/proj.1 index 6faab758..8190b452 100644 --- a/man/man1/proj.1 +++ b/man/man1/proj.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "PROJ" "1" "Mar 18, 2018" "5.0.0" "PROJ.4" +.TH "PROJ" "1" "May 24, 2018" "5.1.0" "PROJ.4" .SH NAME proj \- Cartographic projection filter . @@ -33,27 +33,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 -\fBproj\fP [ \fB\-bceEfiIlmorsStTvVwW\fP ] [ args ] ] [ \fI+args\fP ] file[s] +\fBproj\fP [ \fB\-beEfiIlmorsStTvVwW\fP ] [ args ] ] [ \fI+args\fP ] file[s] .sp -\fBinvproj\fP [ \fB\-bceEfiIlmorsStTwW\fP ] [ args ] ] [ \fI+args\fP ] file[s] +\fBinvproj\fP [ \fB\-beEfiIlmorsStTvVwW\fP ] [ args ] ] [ \fI+args\fP ] file[s] .UNINDENT .UNINDENT .SH DESCRIPTION .sp -\fBproj\fP and \fBinvproj\fP perform respective forward and inverse -transformation of cartographic data to or from cartesian data with a wide -range of selectable projection functions. +\fBproj\fP and \fBinvproj\fP perform respective forward and inverse +transformation of cartographic data to or from cartesian data with a wide +range of selectable projection functions. .sp -\fBinvproj\fP may not be available on all platforms; in this case +\fBinvproj\fP may not be available on all platforms; in this case use \fI\%proj \-I\fP instead. .sp -The following control parameters can appear in any order +The following control parameters can appear in any order .INDENT 0.0 .TP .B \-b 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 \fBproj\fP is a child process and allows bypassing formatting operations. .UNINDENT .INDENT 0.0 @@ -64,8 +64,8 @@ Selects binary input only (see \fI\%\-b\fP). .INDENT 0.0 .TP .B \-I -alternate method to specify inverse projection. Redundant when used with -invproj. +Alternate method to specify inverse projection. Redundant when used with +\fBinvproj\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -75,29 +75,29 @@ Selects binary output only (see \fI\%\-b\fP). .INDENT 0.0 .TP .B \-t<a> -\fIa\fP 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). +Where \fIa\fP 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). .UNINDENT .INDENT 0.0 .TP .B \-e <string> -String is an arbitrary string to be output if an error is detected during -data transformations. The default value is: \fIt\fP\&. Note that if the -\fI\%\-b\fP, \fI\%\-i\fP or \fI\%\-o\fP options are employed, an error +Where \fIstring\fP is an arbitrary string to be output if an error is detected during +data transformations. The default value is a three character string: \fB*\et*\fP\&. +Note that if the \fI\%\-b\fP, \fI\%\-i\fP or \fI\%\-o\fP options are employed, an error is returned as HUGE_VAL value for both return values. .UNINDENT .INDENT 0.0 .TP .B \-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. .UNINDENT .INDENT 0.0 .TP .B \-l<[=id]> List projection identifiers that can be selected with \fI+proj\fP\&. \fBproj \-l=id\fP -gives expanded description of projection id, e.g. \fBproj \-l=merc\fP\&. +gives expanded description of projection \fIid\fP, e.g. \fBproj \-l=merc\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -150,31 +150,37 @@ area projections will have an area factor of 1. .INDENT 0.0 .TP .B \-m <mult> -The cartesian data may be scaled by the mult parameter. When processing data +The cartesian data may be scaled by the \fImult\fP 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. +\fImult\fP otherwise the input cartesian values are divided by \fImult\fP before inverse +projection. If the first two characters of \fImult\fP are 1/ or 1: then the +reciprocal value of \fImult\fP is employed. .UNINDENT .INDENT 0.0 .TP .B \-f <format> -Format is a printf format string to control the form of the output values. +Where \fIformat\fP 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 \fB"%.2f"\fP for forward projection and DMS for inverse. .UNINDENT .INDENT 0.0 .TP -.B \-[w|W]<n> -N is the number of significant fractional digits to employ for seconds -output (when the option is not specified, \fB\-w3\fP is assumed). When \fB\-W\fP -is employed the fields will be constant width and with leading zeroes. +.B \-w<n> +Where \fIn\fP is the number of significant fractional digits to employ for seconds +output (when the option is not specified, \fB\-w3\fP is assumed). +.UNINDENT +.INDENT 0.0 +.TP +.B \-W<n> +Where \fIn\fP is the number of significant fractional digits to employ for seconds +output. When \fB\-W\fP is employed the fields will be constant width +with leading zeroes. .UNINDENT .INDENT 0.0 .TP .B \-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 \fI\%\-T\fP option. .UNINDENT @@ -188,35 +194,35 @@ the projected point. \fI\%\-v\fP is implied with this option. .TP .B \-T <ulow,uhi,vlow,vhi,res[,umax,vmax]> 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 +that approximate the selected cartographic projection on stdout. The values +\fIlow\fP and \fIhi\fP denote the range of the input where the \fIu\fP or \fIv\fP 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 \fIres\fP is a number specifying the +power of 10 precision of the approximation. For example, a \fIres\fP of \-3 +specifies an approximation with an accuracy better than 0.001. Optional \fIumax\fP, and \fIvmax\fP specify maximum degree of the polynomials (default: 15). .UNINDENT .sp The \fI+args\fP 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 +Additional projection control parameters may be contained in two auxiliary +control files: the first is optionally referenced with the \fI+init=file:id\fP 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 \fBPROJ_LIB\fP establishes the -default directory for a file reference without an absolute path. This is -also used for supporting files like datum shift files. ++init file. The environment parameter \fBPROJ_LIB\fP establishes the +default directory for a file reference without an absolute path. This is +also used for supporting files like datum shift files. .sp -One or more files (processed in left to right order) specify the source of -data to be transformed. A \fB\-\fP will specify the location of processing standard -input. If no files are specified, the input is assumed to be from stdin. -For ASCII input data the two data values must be in the first two white space -separated fields and when both input and output are ASCII all trailing +One or more files (processed in left to right order) specify the source of +data to be transformed. A \fB\-\fP will specify the location of processing standard +input. If no files are specified, the input is assumed to be from stdin. +For ASCII input data the two data values must be in the first two white space +separated fields and when both input and output are ASCII all trailing portions of the input line are appended to the output line. .sp -Input geographic data (longitude and latitude) must be in DMS format and input -cartesian data must be in units consistent with the ellipsoid major axis or -sphere radius units. Output geographic coordinates will be in DMS (if the -\fB\-w\fP switch is not employed) and precise to 0.001” with trailing, zero\-valued +Input geographic data (longitude and latitude) must be in DMS format and input +cartesian data must be in units consistent with the ellipsoid major axis or +sphere radius units. Output geographic coordinates will be in DMS (if the +\fB\-w\fP switch is not employed) and precise to 0.001" with trailing, zero\-valued minute\-second fields deleted. .SH EXAMPLE .sp @@ -226,20 +232,19 @@ The following script .sp .nf .ft C -proj +proj=utm +lon_0=112w +ellps=clrk66 -\-r <<EOF -45d15\(aq33.1" 111.5W -45d15.551666667N \-111d30 -+45.25919444444 111d30\(aq000w +proj +proj=utm +lon_0=112w +ellps=clrk66 \-r <<EOF +45d15\(aq33.1" 111.5W +45d15.551666667N \-111d30 ++45.25919444444 111d30\(aq000w EOF .ft P .fi .UNINDENT .UNINDENT .sp -will perform UTM forward projection with a standard UTM central meridian -nearest longitude 112W. The geographic values of this example are equivalent -and meant as examples of various forms of DMS input. The x\-y output +will perform UTM forward projection with a standard UTM central meridian +nearest longitude 112W. The geographic values of this example are equivalent +and meant as examples of various forms of DMS input. The x\-y output data will appear as three lines of: .INDENT 0.0 .INDENT 3.5 @@ -257,7 +262,7 @@ The \fBproj\fP program is limited to converting between geographic and projected coordinates within one datum. .sp The \fBcs2cs\fP program operates similarly, but allows translation -between any paor of definable coordinate reference systems, including +between any pair of definable coordinate reference systems, including support for datum translation. .SH SEE ALSO .sp diff --git a/man/man3/geodesic.3 b/man/man3/geodesic.3 index 9410ced4..c19cbce8 100644 --- a/man/man3/geodesic.3 +++ b/man/man3/geodesic.3 @@ -1,6 +1,6 @@ .\" @(#)geodesic.3 .\" -.TH GEODESIC 3 "2018/02/15 Rel. 5.0.0" +.TH GEODESIC 3 "2018/06/01 Rel. 5.1.0" .ad b .hy 1 .SH NAME diff --git a/man/man3/pj_init.3 b/man/man3/pj_init.3 index 5a5aede3..696561d6 100644 --- a/man/man3/pj_init.3 +++ b/man/man3/pj_init.3 @@ -1,6 +1,6 @@ -.\" @(#)pj_init.3 - 5.0.0 +.\" @(#)pj_init.3 - 5.1.0 .\" -.TH PJ_INIT 3 "2018/02/15 Rel. 5.0.0" +.TH PJ_INIT 3 "2018/06/01 Rel. 5.1.0" .ad b .hy 1 .SH NAME |
