summaryrefslogtreecommitdiff
path: root/Documentation/git-help.txt
blob: ad41aabeb0ec85cd1ee3d67e9496111f2a4cfc3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
git-help(1)
===========
 
NAME
----
git-help - display help information about git
 
SYNOPSIS
--------
'git help' [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]
 
DESCRIPTION
-----------
 
With no options and no COMMAND 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
printed on the standard output.
 
If a git command is named, a manual page for that command 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 as 'git help ...' because the
former is internally converted into the latter.
 
OPTIONS
-------
-a|--all::
	Prints all the available commands on the standard output. This
	option supersedes any other option.
 
-i|--info::
	Use the 'info' program to display the manual page, instead of
	the 'man' program that is used by default.
 
-m|--man::
	Use the 'man' program to display the manual page. This may be
	used to override a value set in the 'help.format'
	configuration variable.
 
-w|--web::
	Use a web browser to display the HTML manual page, instead of
	the 'man' program that is used by default.
+
The web browser can be specified using the configuration variable
'help.browser', or 'web.browser' if the former is not set. If none of
these config variables is set, the 'git-web--browse' helper script
(called by 'git-help') will pick a suitable default.
+
You can explicitly provide a full path to your preferred browser by
setting the configuration variable 'browser.<tool>.path'. For example,
you can configure the absolute path to firefox by setting
'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
is available in PATH.
+
Note that the script tries, as much as possible, to display the HTML
page in a new tab on an already opened browser.
+
The following browsers are currently supported by 'git-web--browse':
+
* firefox (this is the default under X Window when not using KDE)
* iceweasel
* konqueror (this is the default under KDE)
* w3m (this is the default outside X Window)
* links
* lynx
* dillo
 
CONFIGURATION VARIABLES
-----------------------
 
If no command line option is passed, the 'help.format' configuration
variable will be checked. The following values are supported for this
variable; they make 'git-help' behave as their corresponding command
line option:
 
* "man" corresponds to '-m|--man',
* "info" corresponds to '-i|--info',
* "web" or "html" correspond to '-w|--web',
 
The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
be checked if the 'web' format is chosen (either by command line
option or configuration variable). See '-w|--web' in the OPTIONS
section above.
 
Note that these configuration variables should probably be set using
the '--global' flag, for example like this:
 
------------------------------------------------
$ git config --global help.format web
$ git config --global web.browser firefox
------------------------------------------------
 
as they are probably more user specific than repository specific.
See linkgit:git-config[1] for more information about this.
 
Author
------
Written by Junio C Hamano <gitster@pobox.com> and the git-list
<git@vger.kernel.org>.
 
Documentation
-------------
Initial documentation was part of the linkgit:git[7] man page.
Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a
little. Maintenance is done by the git-list <git@vger.kernel.org>.
 
GIT
---
Part of the linkgit:git[7] suite