From 5324937759b602a9eba8314daa1ac40f2ffcaa8e Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Sat, 17 Mar 2018 20:50:15 +0100 Subject: Reformat doc pages for cct, cs2cs, geod and proj The doc pages are reformatted to better use the features of the Sphinx documentation system. All four pages has been formatted such that they can serve as the basis for both the website and UNIX man-pages. This will make it easier to keep the man-pages aligned with the main documentation in the future. --- docs/source/usage/apps/geod.rst | 164 +++++++++++++++++++++++++--------------- 1 file changed, 105 insertions(+), 59 deletions(-) (limited to 'docs/source/usage/apps/geod.rst') diff --git a/docs/source/usage/apps/geod.rst b/docs/source/usage/apps/geod.rst index e7056121..3b60f461 100644 --- a/docs/source/usage/apps/geod.rst +++ b/docs/source/usage/apps/geod.rst @@ -4,77 +4,105 @@ geod ================================================================================ -``geod`` (direct) and ``invgeod`` (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 :math:`|f| < 1/50`, where f is flattening. +Synopsis +******** + **geod** *+ellps=* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] -``invgeod`` may not be available on all platforms; in this case -call geod with the -I option. + **invgeod** *+ellps=* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] +Description +*********** +:program:`geod` (direct) and :program:`invgeod` (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 :math:`|f| < 1/50`, where +:math:`f` is flattening. -Synopsis -******** -:: +:program:`invgeod` may not be available on all platforms; in this case +use :option:`geod -I` instead. - geod +ellps= [ -afFIlptwW [ args ] ] [ +args ] file[s] +The following command-line options can appear in any order: - invgeod +ellps= [ -afFIlptwW [ args ] ] [ +args ] file[s] -Description -*********** -The following command-line options can appear in any order: +.. program:: geod + + +.. option:: -I + + Specifies that the inverse geodesic computation is to be performed. May be + used with execution of geod as an alternative to invgeod execution. + +.. option:: -a + + Latitude and longitudes of the initial and terminal points, forward and + back azimuths and distance are output. + +.. option:: -ta + + A specifies a character employed as the first character to denote a control + line to be passed through without processing. -:: +.. option:: -le - -I Specifies that the inverse geodesic computation is to be - performed. May be used with execution of geod as an - alternative to invgeod execution. + Gives a listing of all the ellipsoids that may be selected with the + *+ellps=* option. - -a Latitude and longitudes of the initial and terminal - points, forward and back azimuths and distance are output. +.. option:: -lu - -ta A specifies a character employed as the first character - to denote a control line to be passed through without - processing. + Gives a listing of all the units that may be selected with the *+units=* + option. - -le Gives a listing of all the ellipsoids that may be - selected with the +ellps= option. +.. option:: -f - -lu Gives a listing of all the units that may be selected - with the +units= option. + Format 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. - -[f|F] format - Format is a printf format string to control the output - form of the geographic coordinate values (f) or distance - value (F). The default mode is DMS for geographic - coordinates and "%.3f" for distance. +.. option:: -F - -[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 with leading zeroes. + Format is a printf format string to control the output form of the distance + value (``-F``). The default mode is DMS for geographic coordinates and + "%.3f" for distance. - -p This option causes the azimuthal values to be output as - unsigned DMS numbers between 0 and 360 degrees. Also - note -f. +.. option:: -w -The ``+args`` command-line options are associated with geodetic + N is the number of significant fractional digits to employ for seconds + output (when the option is not specified, ``-w3`` is assumed). + +.. option:: -W + + N is the number of significant fractional digits to employ for seconds + output. When ``-W`` is employed the fields will be constant width + with leading zeroes. + +.. option:: -p + + 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 parameters for specifying the ellipsoidal or sphere to use. -See ``proj`` `documentation `_ for full list of these parameters and 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. +.. only:: html + + See :ref:`projections_intro` for full + list of these parameters and controls. + +.. only:: man + + See the PROJ documentation for a full list of these parameters and + controls. + One or more files (processed in left to right order) specify -the source of data to be transformed. A - will specify the +the source of data to be transformed. A ``-`` will specify the location of processing standard input. If no files are specified, the input is assumed to be from stdin. @@ -91,29 +119,29 @@ 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 -f switch is not employed) to 0.001" with trailing, +in DMS (if the :option:`-f` 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. The Earth's ellipsoidal figure may be selected in the same manner -as program ``proj`` by using ``+ellps=``, ``+a=``, ``+es=``, etc. +as program :program:`proj` by using *+ellps=*, *+a=*, *+es=*, etc. 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 ``+lat_1=lat`` and ``+lon_1=lon`` -parameters and either a terminus point ``+lat_2=lat`` and -``+lon_2=lon`` or a distance and azimuth from the initial point -with ``+S=distance`` and ``+A=azimuth`` must be specified. +initial point must be specified with *+lat_1=lat* and *+lon_1=lon* +parameters and either a terminus point *+lat_2=lat* and +*+lon_2=lon* or a distance and azimuth from the initial point +with *+S=distance* and *+A=azimuth* must be specified. If points along a geodesic are to be determined then either -``+n_S=integer`` specifying the number of intermediate points -and/or ``+del_S=distance`` specifying the incremental distance +*+n_S=integer* specifying the number of intermediate points +and/or *+del_S=distance* specifying the incremental distance between points must be specified. To determine points along an arc equidistant from the initial -point both ``+del_A=angle`` and ``+n_A=integer`` must be specified +point both *+del_A=angle* and *+n_A=integer* must be specified which determine the respective angular increments and number of points to be determined. @@ -123,7 +151,7 @@ Examples The following script determines the geodesic azimuths and distance in U.S. statute miles from Boston, MA, to Portland, OR: -:: +.. code-block:: console geod +ellps=clrk66 <`_. #. `A geodesic bibliography `_. + +.. only:: man + + See also + ******** + + **proj(1)**, **cs2cs(1)**, **cct(1)**, **geod(1)**, **gie(1)** + + Bugs + **** + + A list of know bugs can be found at http://github.com/OSGeo/proj.4/issues + where new bug reports can be submitted to. + + Home page + ********* + + http://proj4.org/ -- cgit v1.2.3