Skip to content

Commit

Permalink
Update man-pages from Sphinx-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kbevers committed Jun 23, 2019
1 parent 954bd87 commit e7dc7ca
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 69 deletions.
16 changes: 8 additions & 8 deletions man/man1/cct.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CCT" "1" "May 06, 2019" "6.1.0" "PROJ.4"
.TH "CCT" "1" "Jun 23, 2019" "6.1.1" "PROJ"
.SH NAME
cct \- Coordinate Conversion and Transformation
.
Expand Down Expand Up @@ -33,7 +33,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
\fBcct\fP [\fB\-cIostvz\fP [args]] \fI+opt[=arg]\fP file
\fBcct\fP [\fB\-cIostvz\fP [args]] \fI+opt[=arg]\fP ... file ...
.UNINDENT
.UNINDENT
.SH DESCRIPTION
Expand Down Expand Up @@ -103,7 +103,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
Expand Down Expand Up @@ -228,18 +228,18 @@ $ echo 12 56 100 2018.0 auxiliary data | cct +proj=merc
.UNINDENT
.SH BACKGROUND
.sp
\fBcct\fP also refers to Carl Christian Tscherning (19422014),
\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 (19952007), 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
Expand All @@ -255,11 +255,11 @@ Hence, in honour of \fIcct\fP (the geodesist) this is \fBcct\fP (the program).
\fBproj(1)\fP, \fBcs2cs(1)\fP, \fBgeod(1)\fP, \fBgie(1)\fP, \fBprojinfo(1)\fP
.SH BUGS
.sp
A list of know bugs can be found at \fI\%https://github.com/OSGeo/proj.4/issues\fP
A list of know bugs can be found at \fI\%https://github.com/OSGeo/PROJ/issues\fP
where new bug reports can be submitted to.
.SH HOME PAGE
.sp
\fI\%https://proj4.org/\fP
\fI\%https://proj.org/\fP
.SH AUTHOR
Thomas Knudsen
.SH COPYRIGHT
Expand Down
10 changes: 5 additions & 5 deletions man/man1/cs2cs.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CS2CS" "1" "May 06, 2019" "6.1.0" "PROJ.4"
.TH "CS2CS" "1" "Jun 23, 2019" "6.1.1" "PROJ"
.SH NAME
cs2cs \- Cartographic coordinate system filter
.
Expand Down Expand Up @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
\fBcs2cs\fP [\fB\-eEfIlrstvwW\fP [args]] [\fI+opt[=arg]\fP ] [+to \fI+opt[=arg]\fP ] file
\fBcs2cs\fP [\fB\-eEfIlrstvwW\fP [args]] [\fI+opt[=arg]\fP ...] [+to \fI+opt[=arg]\fP ...] file ...
.UNINDENT
.UNINDENT
.sp
or
.INDENT 0.0
.INDENT 3.5
\fBcs2cs\fP [\fB\-eEfIlrstvwW\fP [args]] {source_crs} +to {target_crs} file
\fBcs2cs\fP [\fB\-eEfIlrstvwW\fP [args]] {source_crs} +to {target_crs} file ...
.sp
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
Expand Down Expand Up @@ -275,11 +275,11 @@ outputs
\fBproj(1)\fP, \fBcct(1)\fP, \fBgeod(1)\fP, \fBgie(1)\fP, \fBprojinfo(1)\fP
.SH BUGS
.sp
A list of know bugs can be found at \fI\%https://github.com/OSGeo/proj.4/issues\fP
A list of know bugs can be found at \fI\%https://github.com/OSGeo/PROJ/issues\fP
where new bug reports can be submitted to.
.SH HOME PAGE
.sp
\fI\%https://proj4.org/\fP
\fI\%https://proj.org/\fP
.SH AUTHOR
Frank Warmerdam
.SH COPYRIGHT
Expand Down
16 changes: 8 additions & 8 deletions man/man1/geod.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "GEOD" "1" "May 06, 2019" "6.1.0" "PROJ.4"
.TH "GEOD" "1" "Jun 23, 2019" "6.1.1" "PROJ"
.SH NAME
geod \- Geodesic computations
.
Expand Down Expand Up @@ -33,9 +33,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
\fBgeod\fP \fI+ellps=<ellipse>\fP [\fB\-afFIlptwW\fP [args]] [\fI+opt[=arg]\fP ] file
\fBgeod\fP \fI+ellps=<ellipse>\fP [\fB\-afFIlptwW\fP [args]] [\fI+opt[=arg]\fP ...] file ...
.sp
\fBinvgeod\fP \fI+ellps=<ellipse>\fP [\fB\-afFIlptwW\fP [args]] [\fI+opt[=arg]\fP ] file
\fBinvgeod\fP \fI+ellps=<ellipse>\fP [\fB\-afFIlptwW\fP [args]] [\fI+opt[=arg]\fP ...] file ...
.UNINDENT
.UNINDENT
.SH DESCRIPTION
Expand Down Expand Up @@ -143,12 +143,12 @@ 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,
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
\fBgeod\fP may also be used to determine intermediate points along
Expand Down Expand Up @@ -201,7 +201,7 @@ 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:
and determine Portland\(aqs location by azimuth and distance:
.INDENT 0.0
.INDENT 3.5
.sp
Expand Down Expand Up @@ -249,11 +249,11 @@ C. F. F. Karney, \fI\%Algorithms for Geodesics\fP, J. Geodesy \fB87\fP(1), 43–
\fBproj(1)\fP, \fBcs2cs(1)\fP, \fBcct(1)\fP, \fBgeod(1)\fP, \fBgie(1)\fP
.SH BUGS
.sp
A list of know bugs can be found at \fI\%https://github.com/OSGeo/proj.4/issues\fP
A list of know bugs can be found at \fI\%https://github.com/OSGeo/PROJ/issues\fP
where new bug reports can be submitted to.
.SH HOME PAGE
.sp
\fI\%https://proj4.org/\fP
\fI\%https://proj.org/\fP
.SH AUTHOR
Charles Karney
.SH COPYRIGHT
Expand Down
32 changes: 16 additions & 16 deletions man/man1/gie.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "GIE" "1" "May 06, 2019" "6.1.0" "PROJ.4"
.TH "GIE" "1" "Jun 23, 2019" "6.1.1" "PROJ"
.SH NAME
gie \- The Geospatial Integrity Investigation Environment
.
Expand Down Expand Up @@ -209,7 +209,7 @@ 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\-invertible
pipeline is constructed.
Expand Down Expand Up @@ -267,7 +267,7 @@ 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,
the test is passed.
Expand Down Expand Up @@ -343,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
Expand Down Expand Up @@ -440,21 +440,21 @@ expect 0 110579.9
.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 (19352016), the geospatial visionary, who, already in the
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.
.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 \fBPJ\fP struct, storing
run\-time compiled versions of those key\-value pairs, hence making a map
Expand All @@ -463,25 +463,25 @@ 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
(19352016), 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
.SH BUGS
.sp
A list of know bugs can be found at \fI\%https://github.com/OSGeo/proj.4/issues\fP
A list of know bugs can be found at \fI\%https://github.com/OSGeo/PROJ/issues\fP
where new bug reports can be submitted to.
.SH HOME PAGE
.sp
\fI\%https://proj4.org/\fP
\fI\%https://proj.org/\fP
.SH AUTHOR
Thomas Knudsen
.SH COPYRIGHT
Expand Down
12 changes: 6 additions & 6 deletions man/man1/proj.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "PROJ" "1" "May 06, 2019" "6.1.0" "PROJ.4"
.TH "PROJ" "1" "Jun 23, 2019" "6.1.1" "PROJ"
.SH NAME
proj \- Cartographic projection filter
.
Expand Down Expand Up @@ -33,9 +33,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
\fBproj\fP [\fB\-beEfiIlmorsStTvVwW\fP] [args]] [\fI+opt[=arg]\fP ] file
\fBproj\fP [\fB\-beEfiIlmorsStTvVwW\fP] [args]] [\fI+opt[=arg]\fP ...] file ...
.sp
\fBinvproj\fP [\fB\-beEfiIlmorsStTvVwW\fP] [args]] [\fI+opt[=arg]\fP ] file
\fBinvproj\fP [\fB\-beEfiIlmorsStTvVwW\fP] [args]] [\fI+opt[=arg]\fP ...] file ...
.UNINDENT
.UNINDENT
.SH DESCRIPTION
Expand Down Expand Up @@ -216,7 +216,7 @@ portions of the input line are appended to the output line.
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
\fB\-w\fP switch is not employed) and precise to 0.001" with trailing, zero\-valued
minute\-second fields deleted.
.SH EXAMPLE
.sp
Expand Down Expand Up @@ -263,11 +263,11 @@ support for datum translation.
\fBcs2cs(1)\fP, \fBcct(1)\fP, \fBgeod(1)\fP, \fBgie(1)\fP, \fBprojinfo(1)\fP
.SH BUGS
.sp
A list of know bugs can be found at \fI\%https://github.com/OSGeo/proj.4/issues\fP
A list of know bugs can be found at \fI\%https://github.com/OSGeo/PROJ/issues\fP
where new bug reports can be submitted to.
.SH HOME PAGE
.sp
\fI\%https://proj4.org/\fP
\fI\%https://proj.org/\fP
.SH AUTHOR
Gerald I. Evenden
.SH COPYRIGHT
Expand Down
49 changes: 29 additions & 20 deletions man/man1/projinfo.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "PROJINFO" "1" "May 06, 2019" "6.1.0" "PROJ.4"
.TH "PROJINFO" "1" "Jun 23, 2019" "6.1.1" "PROJ"
.SH NAME
projinfo \- Geodetic object and coordinate operation queries
.
Expand Down Expand Up @@ -36,17 +36,17 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nf
\fBprojinfo\fP
.in +2
[\-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]
[grid\-check none|discard_missing|sort] [show\-superseded]
[pivot\-crs always|if_no_direct_transformation|never|{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})
[\-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]
[\-\-grid\-check none|discard_missing|sort] [\-\-show\-superseded]
[\-\-pivot\-crs always|if_no_direct_transformation|never|{auth:code[,auth:code]*}]
[\-\-boundcrs\-to\-wgs84]
[\-\-main\-db\-path path] [\-\-aux\-db\-path path]*
[\-\-identify]
[\-\-c\-ify] [\-\-single\-line]
{object_definition} | {object_reference} | (\-s {srs_def} \-t {srs_def})

.in -2
.fi
Expand All @@ -59,16 +59,25 @@ a proj\-string,
.IP \(bu 2
a WKT string,
.IP \(bu 2
an object code (like EPSG:4326”, “urn:ogc:def:crs:EPSG::4326,
urn:ogc:def:coordinateOperation:EPSG::1671),
an object code (like "EPSG:4326", "urn:ogc:def:crs:EPSG::4326",
"urn:ogc:def:coordinateOperation:EPSG::1671"),
.IP \(bu 2
a OGC URN combining references for compound coordinate reference systems
(e.g “\fI\%urn:ogc:def:crs,crs:EPSG::2393,crs:EPSG::5717\fP” or custom abbreviated
syntax “EPSG:2393+5717”),
(e.g "\fI\%urn:ogc:def:crs,crs:EPSG::2393,crs:EPSG::5717\fP" or custom abbreviated
syntax "EPSG:2393+5717"),
.IP \(bu 2
a OGC URN combining references for references for projected or derived CRSs
e.g. for Projected 3D CRS "UTM zone 31N / WGS 84 (3D)":
"\fI\%urn:ogc:def:crs,crs:EPSG::4979,cs:PROJ::ENh,coordinateOperation:EPSG::16031\fP"
(\fIadded in 6.2\fP)
.IP \(bu 2
a OGC URN combining references for concatenated operations
(e.g. \fI\%urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618\fP)
(e.g. "\fI\%urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618\fP")
.UNINDENT
.sp
{object_reference} is a filename preceded by the \(aq@\(aq character. The
file referenced by the {object_reference} must contain a valid
{object_definition}.
.UNINDENT
.UNINDENT
.SH DESCRIPTION
Expand Down Expand Up @@ -125,7 +134,7 @@ potentially compatible of being piped in other utilities.
.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)
as a name (e.g "Denmark \- onshore") or a AUTHORITY:CODE (EPSG:3237)
This option is exclusive of \fI\%\-\-bbox\fP\&.
.sp
\fBNOTE:\fP
Expand Down Expand Up @@ -424,11 +433,11 @@ COORDINATEOPERATION["NAD27 to NAD83 (1)",
\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
A list of know bugs can be found at \fI\%https://github.com/OSGeo/PROJ/issues\fP
where new bug reports can be submitted to.
.SH HOME PAGE
.sp
\fI\%https://proj4.org/\fP
\fI\%https://proj.org/\fP
.SH AUTHOR
Even Rouault
.SH COPYRIGHT
Expand Down
Loading

0 comments on commit e7dc7ca

Please sign in to comment.