Scroll to navigation

DOCS(1gmt) GMT DOCS(1gmt)

NAME

docs - Show the HTML documentation of the specified module

SYNOPSIS

gmt docs [ -Q ] [ -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 cookbook, gallery, defaults, api and tutorial are also accepted.

OPTIONAL ARGUMENTS

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.

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

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.

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 documentation of the -B option in pscoast

gmt docs pscoast -B




To examine the list of GMT defaults, try

gmt docs defaults




To see the Gallery

gmt docs gallery




SEE ALSO

begin, clear, end, figure, inset, subplot, gmt

COPYRIGHT

2019, The GMT Team

September 7, 2019 6.0.0rc4