diff options
author | Junio C Hamano <gitster@pobox.com> | 2013-04-11 19:14:19 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2013-04-11 19:14:19 -0700 |
commit | 0eb115024d67a8c849fedcbee89005ed62b0cf08 (patch) | |
tree | 03feadf23ef92ede9cd95471f8f855352f2b0082 /git-help.txt | |
parent | 63b6fdb8e5cadbb9ad619d06dcaf4a3b72c7d359 (diff) | |
download | git-htmldocs-0eb115024d67a8c849fedcbee89005ed62b0cf08.tar.gz |
Autogenerated HTML docs for v1.8.2.1-366-ge2af9
Diffstat (limited to 'git-help.txt')
-rw-r--r-- | git-help.txt | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/git-help.txt b/git-help.txt index e07b6dc19..b21e9d79b 100644 --- a/git-help.txt +++ b/git-help.txt @@ -8,31 +8,45 @@ git-help - Display help information about Git SYNOPSIS -------- [verse] -'git help' [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND] +'git help' [-a|--all] [-g|--guide] + [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE] DESCRIPTION ----------- -With no options and no COMMAND given, the synopsis of the 'git' +With no options and no COMMAND or GUIDE given, the synopsis of the 'git' command and a list of the most commonly used Git commands are printed on the standard output. -If the option '--all' or '-a' is given, then all available commands are +If the option '--all' or '-a' is given, all available commands are printed on the standard output. -If a Git subcommand is named, a manual page for that subcommand is brought -up. The 'man' program is used by default for this purpose, but this -can be overridden by other options or configuration variables. +If the option '--guide' or '-g' is given, a list of the useful +Git guides is also printed on the standard output. + +If a command, or a guide, is given, a manual page for that command or +guide is brought up. The 'man' program is used by default for this +purpose, but this can be overridden by other options or configuration +variables. Note that `git --help ...` is identical to `git help ...` because the former is internally converted into the latter. +To display the linkgit:git[1] man page, use `git help git`. + +This page can be displayed with 'git help help' or `git help --help` + OPTIONS ------- -a:: --all:: Prints all the available commands on the standard output. This - option supersedes any other option. + option overrides any given command or guide name. + +-g:: +--guides:: + Prints a list of useful guides on the standard output. This + option overrides any given command or guide name. -i:: --info:: |