docs

Show HTML documentation of specified module

Synopsis

gmt docs [ -Q ] [ -S ] [ -V[level] ] module-name [-option]

Note: No space is allowed between the option flag and the associated arguments.

Description

docs tells GMT to display the HTML version of a module’s documentation using the default browser. Besides the modules names, the special targets gmt, cookbook, gallery, settings, api and tutorial are also accepted.

Required Arguments

module-name
One of the core or supplemental modules, or one of api, cookbook, gallery, settings, and tutorial.

Optional Arguments

-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
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.
-V[level] (more …)
Select verbosity level [c].
-^ or just -
Print a short message about the syntax of the command, then exits (NOTE: on Windows just use -).
-+ or just +
Print an extensive usage (help) message, including the explanation of any module-specific option (but not the GMT common options), then exits.
-? or no arguments
Print a complete usage (help) message, including the explanation of all options, then exits.

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