.\" Man page generated from reStructuredText.
.
.TH "DOCS" "1gmt" "Sep 07, 2019" "6.0.0rc4" "GMT"
.SH NAME
docs \- Show the HTML documentation of the specified module
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBgmt docs\fP [ \fB\-Q\fP ] [  \fB\-V\fP[\fIlevel\fP] ] \fImodule\-name\fP [\fI\-option\fP]
.sp
\fBNote:\fP No space is allowed between the option flag and the associated arguments.
.SH DESCRIPTION
.sp
\fBdocs\fP tells GMT to display the HTML version of a module\(aqs documentation using the default browser.
Besides the modules names, the special targets \fIcookbook\fP, \fIgallery\fP, \fIdefaults\fP, \fIapi\fP and \fItutorial\fP
are also accepted.
.SH OPTIONAL ARGUMENTS
.INDENT 0.0
.TP
\fB\-Q\fP
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, \fB\-Q\fP must be the first option to \fBdocs\fP\&.
.UNINDENT
.INDENT 0.0
.TP
\fB\-V\fP[\fIlevel\fP] (more ...)
Select verbosity level [c].  
.UNINDENT
.INDENT 0.0
.TP
\fB\-^\fP or just \fB\-\fP
Print a short message about the syntax of the command, then exits (NOTE: on Windows just use \fB\-\fP).
.TP
\fB\-+\fP or just \fB+\fP
Print an extensive usage (help) message, including the explanation of
any module\-specific option (but not the GMT common options), then exits.
.TP
\fB\-?\fP or no arguments
Print a complete usage (help) message, including the explanation of all options, then exits.
.UNINDENT
.SH OPTIONAL MODULE ARGUMENTS
.INDENT 0.0
.TP
.B \fI\-option\fP
Where \fI\-option\fP is the one\-letter option of the module in question (e.g, \fB\-R\fP).
We then display the \fImodule\fP documentation positioned at that specific option.
.UNINDENT
.SH EXAMPLES
.sp
To see the documentation of \fIgrdimage\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt docs grdimage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To see the link to the documentation of \fIgrdimage\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt docs \-Q grdimage
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To see the documentation of the \fB\-B\fP option in \fIpscoast\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt docs pscoast \-B
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To examine the list of GMT defaults, try
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt docs defaults
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To see the Gallery
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt docs gallery
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
begin,
clear,
end,
figure,
inset,
subplot,
gmt
.SH COPYRIGHT
2019, The GMT Team
.\" Generated by docutils manpage writer.
.