Documentation Source Text

Help: help
Login

The "help" command:

Usage: fossil help [OPTIONS] [TOPIC] [SUBCOMMAND]

Display information on how to use TOPIC, which may be a command, webpage, or setting. Webpage names begin with "/". If TOPIC is omitted, a list of topics is returned. If there is an extra argument after TOPIC, it is the name of a subcommand, in which case only the help text for that one subcommand is shown.

The following options can be used when TOPIC is omitted:

-a|--all
List both common and auxiliary commands
-e|--everything
List all help on all topics
-f|--full
List full set of commands (including auxiliary and unsupported "test" commands), options, settings, and web pages
-o|--options
List command-line options common to all commands
-s|--setting
List setting names
-t|--test
List unsupported "test" commands
-v|--verbose
List both names and help text
-x|--aux
List only auxiliary commands
-w|--www
List all web pages

These options can be used when TOPIC is present:

-c|--commands
Restrict TOPIC search to commands
-h|--html
Format output as HTML rather than plain text
-o|--options
Show command-line options for TOPIC
--raw
Output raw, unformatted help text
-u|--usage
Show a succinct usage summary, not full help text

See also: usage, options, search with the -h option