.. index:: ! docs
.. include:: module_core_purpose.rst_
****
docs
****
|docs_purpose|
Synopsis
--------
.. include:: common_SYN_OPTs.rst_
**gmt docs** [ |-Q| ] [ |-S| ] [ |SYN_OPT-V| ] *module-name* [*-option*]
|No-spaces|
Description
-----------
**docs** tells GMT to display the HTML version of a module's documentation using the default browser.
Besides the modules names, some special targets
*gmt*, *api*, *colors*, *reference*, *data*, *gallery*, *home*, *settings*, and *tutorial*
are also accepted. You can also give *forum* (takes you to the `GMT Discourse Forum `_) and
*website* (or just *site*; takes you to the `GMT main website `_).
Required Arguments
------------------
*module-name*
One of the core or supplemental modules,
or one of *gmt*, *api*, *colors*, *reference*, *data*, *gallery* *home*, *settings*, and *tutorial*,
plus external targets *forum* and *website*.
Optional Arguments
------------------
.. _-Q:
**-Q**
This option means we are doing a "dry-run" and simply want the final URL to be
printed to standard output. No file open command will take place. This is useful
if you are working remotely on a server and do not wish to launch a GUI browser.
If used, |-Q| must be the first option to **docs**.
.. _-S:
**-S**
Normally, **docs** will open documentation files from the local computer if the document can
be found there; otherwise it will use the GMT server. The |-S| option forces **docs** to
read the file from the web server first.
.. |Add_-V| replace:: |Add_-V_links|
.. include:: explain_-V.rst_
:start-after: **Syntax**
:end-before: **Description**
.. include:: explain_help_nopar.rst_
Optional Module Arguments
-------------------------
*-option*
Where *-option* is the one-letter option of the module in question (e.g, |-R|).
We then display the *module* documentation positioned at that specific option. Note
that this operation is only valid for an actual URL, hence we implicitly set
|-S| when an option anchor is specified.
Examples
--------
To see the documentation of *grdimage*::
gmt docs grdimage
To see the link to the documentation of *grdimage*::
gmt docs -Q grdimage
To see the link to the documentation of *grdimage* on the GMT server::
gmt docs -Q -S grdimage
To see the documentation of the |-B| option in *coast*::
gmt docs coast -B
To examine the list of GMT default settings, try::
gmt docs settings
To see the Gallery::
gmt docs gallery
See Also
--------
:doc:`begin`,
:doc:`clear`,
:doc:`end`,
:doc:`figure`,
:doc:`inset`,
:doc:`subplot`,
:doc:`gmt`