g.manual
Displays the manual pages of GRASS modules.
g.manual [-itmo] entry=string [--verbose] [--quiet] [--qq] [--ui]
Example:
g.manual entry=string
grass.script.run_command("g.manual", entry, flags=None, verbose=False, quiet=False, superquiet=False)
Example:
gs.run_command("g.manual", entry="string")
Parameters
entry=string [required]
Manual entry to be displayed
-i
Display index
-t
Display topics
-m
Display as MAN text page instead of HTML page in browser
-o
Display online manuals instead of locally installed
Use online manuals available at https://grass.osgeo.org website. This flag has no effect when displaying MAN text pages.
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--qq
Very quiet module output
--ui
Force launching GUI dialog
entry : str, required
Manual entry to be displayed
flags : str, optional
Allowed values: i, t, m, o
i
Display index
t
Display topics
m
Display as MAN text page instead of HTML page in browser
o
Display online manuals instead of locally installed
Use online manuals available at https://grass.osgeo.org website. This flag has no effect when displaying MAN text pages.
verbose: bool, optional
Verbose module output
Default: False
quiet: bool, optional
Quiet module output
Default: False
superquiet: bool, optional
Very quiet module output
Default: False
DESCRIPTION
g.manual displays the manual pages of GRASS in HTML and MAN format.
NOTES
The name of the browser is defined in the environment variable
GRASS_HTML_BROWSER
. For most platforms this should be an executable in
your PATH, or the full path to an executable. See
variables for details.
EXAMPLES
Show index page in the browser.
g.manual -i
Show manual page of d.vect module in the browser.
g.manual d.vect
Show module manual page in terminal.
g.manual -m d.vect
AUTHOR
Markus Neteler
SOURCE CODE
Available at: g.manual source code
(history)
Latest change: Thursday Feb 13 15:25:35 2025 in commit 442bd61