Skip to content

Commit a133737

Browse files
Philip Oakleygitster
authored andcommitted
doc: include --guide option description for "git help"
Note that the ability to display an individual guide was always possible. Include this in the update. Also tell readers how git(1) can be accessed, especially for Git for Windows users who do not have the 'man' command. Likewise include a commentary on how to access this page (Catch 22). Signed-off-by: Philip Oakley <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 73903d0 commit a133737

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

Documentation/git-help.txt

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,45 @@ git-help - Display help information about Git
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git help' [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]
11+
'git help' [-a|--all] [-g|--guide]
12+
[-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
1213

1314
DESCRIPTION
1415
-----------
1516

16-
With no options and no COMMAND given, the synopsis of the 'git'
17+
With no options and no COMMAND or GUIDE given, the synopsis of the 'git'
1718
command and a list of the most commonly used Git commands are printed
1819
on the standard output.
1920

20-
If the option '--all' or '-a' is given, then all available commands are
21+
If the option '--all' or '-a' is given, all available commands are
2122
printed on the standard output.
2223

23-
If a Git subcommand is named, a manual page for that subcommand is brought
24-
up. The 'man' program is used by default for this purpose, but this
25-
can be overridden by other options or configuration variables.
24+
If the option '--guide' or '-g' is given, a list of the useful
25+
Git guides is also printed on the standard output.
26+
27+
If a command, or a guide, is given, a manual page for that command or
28+
guide is brought up. The 'man' program is used by default for this
29+
purpose, but this can be overridden by other options or configuration
30+
variables.
2631

2732
Note that `git --help ...` is identical to `git help ...` because the
2833
former is internally converted into the latter.
2934

35+
To display the linkgit:git[1] man page, use `git help git`.
36+
37+
This page can be displayed with 'git help help' or `git help --help`
38+
3039
OPTIONS
3140
-------
3241
-a::
3342
--all::
3443
Prints all the available commands on the standard output. This
35-
option supersedes any other option.
44+
option overrides any given command or guide name.
45+
46+
-g::
47+
--guides::
48+
Prints a list of useful guides on the standard output. This
49+
option overrides any given command or guide name.
3650

3751
-i::
3852
--info::

0 commit comments

Comments
 (0)