Skip to content

Commit

Permalink
Port OGR common options
Browse files Browse the repository at this point in the history
  • Loading branch information
mloskot committed May 17, 2019
1 parent 669eb22 commit 091b0e7
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
2 changes: 1 addition & 1 deletion gdal/doc/source/programs/raster_common_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Common options for raster programs
================================================================================

All GDAL command line programs support the following common general options.
All GDAL command line programs support the following common options.

.. option:: --version

Expand Down
48 changes: 48 additions & 0 deletions gdal/doc/source/programs/vector_common_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,51 @@
================================================================================
Common options for vector programs
================================================================================

All GDAL OGR command line programs support the following common options.

.. option:: --version

Report the version of GDAL and exit.

.. option:: --formats

List all vector formats supported by this GDAL build (read-only and
read-write) and exit. The format support is indicated as follows:
``ro`` is read-only driver; ``rw`` is read or write (i.e. supports
:c:func:`CreateCopy`); ``rw+`` is read, write and update (i.e. supports
Create). A ``v`` is appended for formats supporting virtual IO
(``/vsimem``, ``/vsigzip``, ``/vsizip``, etc). A ``s`` is appended for
formats supporting subdatasets.

.. option:: --format <format>

List detailed information about a single format driver.
The format should be the short name reported in the :option:`--formats`
list, such as GML.

.. option:: --optfile <filename>

Read the named file and substitute the contents into the command line
options list. Lines beginning with ``#`` will be ignored.
Multi-word arguments may be kept together with double quotes.

.. option:: --config <key> <value>

Sets the named configuration keyword to the given value, as opposed to
setting them as environment variables. Some common configuration keywords
are SHAPE_ENCODING (force shapefile driver to read DBF files with the given
character encoding) and CPL_TEMPDIR (define the location of temporary files).
Individual drivers may be influenced by other configuration options.

.. option:: --debug <value>

Control what debugging messages are emitted.
A value of ON will enable all debug messages.
A value of OFF will disable all debug messages.
Another value will select only debug messages containing
that string in the debug prefix code.

.. option:: --help-general

Gives a brief usage message for the generic GDAL OGR command line options and exit.

0 comments on commit 091b0e7

Please sign in to comment.