diff options
Diffstat (limited to 'docs/source/usage')
| -rw-r--r-- | docs/source/usage/differences.rst | 10 | ||||
| -rw-r--r-- | docs/source/usage/environmentvars.rst | 14 | ||||
| -rw-r--r-- | docs/source/usage/network.rst | 6 | ||||
| -rw-r--r-- | docs/source/usage/projections.rst | 28 | ||||
| -rw-r--r-- | docs/source/usage/quickstart.rst | 19 | ||||
| -rw-r--r-- | docs/source/usage/transformation.rst | 18 |
6 files changed, 48 insertions, 47 deletions
diff --git a/docs/source/usage/differences.rst b/docs/source/usage/differences.rst index 11bab0b5..3bc2f54d 100644 --- a/docs/source/usage/differences.rst +++ b/docs/source/usage/differences.rst @@ -62,10 +62,10 @@ the old behavior. Version 6.0.0 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -Removal of proj_def.dat ------------------------ +Removal of :file:`proj_def.dat` +------------------------------- -Before PROJ 6, the ``proj_def.dat`` was used to provide general and per-projection +Before PROJ 6, the :file:`proj_def.dat` was used to provide general and per-projection parameters, when ``+no_defs`` was not specified. It has now been removed. In case, no ellipsoid or datum specification is provided in the PROJ string, the default ellipsoid is GRS80 (was WGS84 in previous PROJ versions). @@ -121,8 +121,8 @@ Version 6.3.0 projinfo -------- -Before PROJ 6.3.0, WKT1:GDAL was implicitly calling --boundcrs-to-wgs84, to -add a TOWGS84[] node in some cases. This is no longer the case. +Before PROJ 6.3.0, WKT1:GDAL was implicitly calling ``--boundcrs-to-wgs84``, to +add a ``TOWGS84[]`` node in some cases. This is no longer the case. Version 7.0.0 diff --git a/docs/source/usage/environmentvars.rst b/docs/source/usage/environmentvars.rst index 304b9276..0439d918 100644 --- a/docs/source/usage/environmentvars.rst +++ b/docs/source/usage/environmentvars.rst @@ -23,7 +23,7 @@ On windows systems environment variables can be set in the command line with:: > set VAR="some variable" -```VAR`` will be available for the entire session, unless it is unset. This is +``VAR`` will be available for the entire session, unless it is unset. This is done by setting the variable with no content:: > set VAR= @@ -42,7 +42,7 @@ done by setting the variable with no content:: installation root) and the current folder. You can also set the location of the resource files using - :func:`proj_context_set_search_paths` in the `proj.h` API header. + :func:`proj_context_set_search_paths` in the :file:`proj.h` API header. .. versionchanged:: 6.1.0 @@ -57,7 +57,7 @@ done by setting the variable with no content:: .. versionadded:: 8.1.0 To set the path to one or several auxiliary SQLite3 databases of structure - identical to the main ``proj.db`` database and that can contain additional + identical to the main :file:`proj.db` database and that can contain additional object (CRS, transformation, ...) definitions. If several paths are provided, they must be separated by the colon (:) character on Unix, and on Windows, by the semi-colon (;) character. @@ -66,7 +66,7 @@ done by setting the variable with no content:: .. envvar:: PROJ_DEBUG Set the debug level of PROJ. The default debug level is zero, which results - in no debug output when using PROJ. A number from 1-3, whit 3 being the most + in no debug output when using PROJ. A number from 1-3, with 3 being the most verbose setting. .. envvar:: PROJ_NETWORK @@ -82,8 +82,8 @@ done by setting the variable with no content:: .. versionadded:: 7.0.0 - Define the endpoint of the CDN storage. Normally defined through the proj.ini - configuration file locale in :envvar:`PROJ_LIB`. + Define the endpoint of the CDN storage. Normally defined through the + :file:`proj.ini` configuration file locale in :envvar:`PROJ_LIB`. Alternatively, the :c:func:`proj_context_set_url_endpoint` function can be used. @@ -91,6 +91,6 @@ done by setting the variable with no content:: .. versionadded:: 7.2.0 - Define a custum path to the CA Bundle file. This can be useful if `curl` + Define a custom path to the CA Bundle file. This can be useful if `curl` and :envvar:`PROJ_NETWORK` are enabled. Alternatively, the :c:func:`proj_curl_set_ca_bundle_path` function can be used. diff --git a/docs/source/usage/network.rst b/docs/source/usage/network.rst index c89a5960..37a32d34 100644 --- a/docs/source/usage/network.rst +++ b/docs/source/usage/network.rst @@ -34,9 +34,9 @@ the user authorizes network access. Authorizing network access can be done in multiple ways: - enabling / uncommenting the ``network = on`` line of :ref:`proj-ini` - - definiting the :envvar:`PROJ_NETWORK` environment variable to ON + - defining the :envvar:`PROJ_NETWORK` environment variable to ON - or using the :cpp:func:`proj_context_set_enable_network` with a - ``enabled`` = TRUE value. + ``enabled = TRUE`` value. .. note:: @@ -59,7 +59,7 @@ Caching ------- To avoid repeated access to network, a local cache of downloaded chunks of grids -is implemented as SQLite3 database, ``cache.db``, stored in the +is implemented as SQLite3 database, :file:`cache.db`, stored in the :ref:`PROJ user writable directory <user_writable_directory>`. This local caching is enabled by default (can be changed in :ref:`proj-ini` or diff --git a/docs/source/usage/projections.rst b/docs/source/usage/projections.rst index 464451c9..1f2e504f 100644 --- a/docs/source/usage/projections.rst +++ b/docs/source/usage/projections.rst @@ -42,23 +42,23 @@ Units +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Horizontal units can be specified using the ``+units`` keyword with a symbolic -name for a unit (ie. ``us-ft``). Alternatively the translation to meters can be -specified with the ``+to_meter`` keyword (ie. 0.304800609601219 for US feet). The -``-lu`` argument to ``cs2cs`` or ``proj`` can be used to list symbolic unit names. -The default unit for projected coordinates is the meter. +name for a unit (i.e. ``us-ft``). Alternatively the translation to meters can be +specified with the ``+to_meter`` keyword (i.e. 0.304800609601219 for US feet). The +``-lu`` argument to :program:`cs2cs` or :program:`proj` can be used to list +symbolic unit names. The default unit for projected coordinates is the meter. A few special projections deviate from this behavior, most notably the latlong pseudo-projection that returns degrees. Vertical (Z) units can be specified using the ``+vunits`` keyword with a -symbolic name for a unit (ie. ``us-ft``). Alternatively the translation to -meters can be specified with the ``+vto_meter`` keyword (ie. 0.304800609601219 -for US feet). The ``-lu`` argument to ``cs2cs`` or ``proj`` can be used to list -symbolic unit names. If no vertical units are specified, the vertical units will -default to be the same as the horizontal coordinates. +symbolic name for a unit (i.e. ``us-ft``). Alternatively the translation to +meters can be specified with the ``+vto_meter`` keyword (i.e. 0.304800609601219 +for US feet). The ``-lu`` argument to :program:`cs2cs` or :program:`proj` can +be used to list symbolic unit names. If no vertical units are specified, the +vertical units will default to be the same as the horizontal coordinates. .. note:: - ``proj`` do not handle vertical units at all and hence the ``+vto_meter`` - argument will be ignored. + :program:`proj` does not handle vertical units at all and hence the + ``+vto_meter`` argument will be ignored. Scaling of output units can be done by applying the ``+k_0`` argument. The returned coordinates are scaled by the value assigned with the ``+k_0`` @@ -97,8 +97,8 @@ name, or the longitude of the alternative prime meridian relative to greenwich. Currently prime meridian declarations are only utilized by the ``pj_transform()`` API call, not the ``pj_inv()`` and ``pj_fwd()`` calls. -Consequently the user utility ``cs2cs`` does honour prime meridians but the -``proj`` user utility ignores them. +Consequently the user utility :program:`cs2cs` does honour prime meridians but +the :program:`proj` user utility ignores them. The following predeclared prime meridian names are supported. These can be listed using with ``cs2cs -lm``. @@ -157,7 +157,7 @@ They can be combined in +axis in forms like: .. note:: - The ``+axis`` argument does not work with the ``proj`` command line + The ``+axis`` argument does not work with the :program:`proj` command line utility. diff --git a/docs/source/usage/quickstart.rst b/docs/source/usage/quickstart.rst index 89ac2172..85e7aa95 100644 --- a/docs/source/usage/quickstart.rst +++ b/docs/source/usage/quickstart.rst @@ -26,16 +26,16 @@ projection in PROJ is identified by a shorthand such as ``merc`` in the above example. By using the above projection definition as parameters for the command line -utility ``proj`` we can convert the geodetic coordinates to projected space: +utility :program:`proj` we can convert the geodetic coordinates to projected space: :: $ proj +proj=merc +lat_ts=56.5 +ellps=GRS80 -If called as above ``proj`` will be in interactive mode, letting you type the -input data manually and getting a response presented on screen. ``proj`` -works as any UNIX filter though, which means that you can also pipe data to -the utility, for instance by using the ``echo`` command: +If called as above :program:`proj` will be in interactive mode, letting you +type the input data manually and getting a response presented on screen. +:program:`proj` works as any UNIX filter though, which means that you can also +pipe data to the utility, for instance by using the :program:`echo` command: :: @@ -43,9 +43,10 @@ the utility, for instance by using the ``echo`` command: 3399483.80 752085.60 -PROJ also comes bundled with the ``cs2cs`` utility which is used to transform -from one coordinate reference system to another. Say we want to convert -the above Mercator coordinates to UTM, we can do that with ``cs2cs``: +PROJ also comes bundled with the :program:`cs2cs` utility which is used to +transform from one coordinate reference system to another. Say we want to +convert the above Mercator coordinates to UTM, we can do that with +:program:`cs2cs`: :: @@ -56,7 +57,7 @@ Notice the ``+to`` parameter that separates the source and destination projection definitions. If you happen to know the EPSG identifiers for the two coordinates reference -systems you are transforming between you can use those with ``cs2cs``: +systems you are transforming between you can use those with :program:`cs2cs`: :: diff --git a/docs/source/usage/transformation.rst b/docs/source/usage/transformation.rst index 1f29126e..785ca65e 100644 --- a/docs/source/usage/transformation.rst +++ b/docs/source/usage/transformation.rst @@ -187,7 +187,7 @@ In contrast to the *transformation pipeline* framework, transformations with the *cs2cs* framework in PROJ 4 and 5 were expressed as two separate proj-strings. One proj-string *to* WGS84 and one *from* WGS84. Together they form the mapping from the source coordinate reference system to the destination coordinate reference system. -When used with the ``cs2cs`` the source and destination CRS's are separated by the +When used with the :program:`cs2cs` the source and destination CRS's are separated by the special ``+to`` parameter. The following example demonstrates converting from the Greek GGRS87 datum @@ -249,8 +249,8 @@ at each grid location. Actually grid shifts are normally computed based on an interpolation between the containing four grid points. PROJ supports use of grid files for shifting between various reference frames. -The grid shift table formats are ctable, NTv1 (the old Canadian format), and NTv2 (``.gsb`` - the new -Canadian and Australian format). +The grid shift table formats are CTable, NTv1 (the old Canadian format), and NTv2 +(:file:`.gsb` - the new Canadian and Australian format). The text in this section is based on the *cs2cs* framework. Gridshifting is off course also possible with the *pipeline* framework. The major difference between the @@ -258,7 +258,7 @@ two is that the *cs2cs* framework is limited to grid mappings to WGS84, whereas *transformation pipelines* it is possible to perform grid shifts between any two reference frames, as long as a grid exists. -Use of grid shifts with ``cs2cs`` is specified using the ``+nadgrids`` +Use of grid shifts with :program:`cs2cs` is specified using the ``+nadgrids`` keyword in a coordinate system definition. For example: :: @@ -269,7 +269,7 @@ keyword in a coordinate system definition. For example: EOF 111d0'2.952"W 50d0'0.111"N 0.000 -In this case the ``/usr/local/share/proj/ntv1_can.dat`` grid shift file was +In this case the :file:`/usr/local/share/proj/ntv1_can.dat` grid shift file was loaded, and used to get a grid shift value for the selected point. It is possible to list multiple grid shift files, in which case each will be @@ -291,8 +291,8 @@ Skipping Missing Grids The special prefix ``@`` may be prefixed to a grid to make it optional. If it not found, the search will continue to the next grid. Normally any grid not found will cause an error. For instance, the following would use the -``ntv2_0.gsb`` file if available, otherwise it would -fallback to using the ``ntv1_can.dat`` file. +:file:`ntv2_0.gsb` file if available, otherwise it would +fallback to using the :file:`ntv1_can.dat` file. :: @@ -305,7 +305,7 @@ fallback to using the ``ntv1_can.dat`` file. The null Grid ................................................................................ -A special ``null`` grid shift file is distributed with PROJ. +A special :file:`null` grid shift file is distributed with PROJ. This file provides a zero shift for the whole world. It may be listed at the end of a nadgrids file list if you want a zero shift to be applied to points outside the valid region of all the other grids. Normally if @@ -332,7 +332,7 @@ For more information see the chapter on :ref:`transformation_grids`. Caveats ................................................................................ -* Where grids overlap (such as conus and ntv1_can.dat for instance) the first +* Where grids overlap (such as conus and :file:`ntv1_can.dat` for instance) the first found for a point will be used regardless of whether it is appropriate or not. So, for instance, ``+nadgrids=ntv1_can.dat``,conus would result in the Canadian data being used for some areas in the northern United States |