man1/git-help.1

   1 '\" t
   2 .\"     Title: git-help
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-01
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.46.g406f326d27
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-HELP" "1" "2024-08-01" "Git 2\&.46\&.0\&.46\&.g406f326" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-help \- Display help information about Git
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit help\fR [\-a|\-\-all] [\-\-[no\-]verbose] [\-\-[no\-]external\-commands] [\-\-[no\-]aliases]
  36 \fIgit help\fR [[\-i|\-\-info] [\-m|\-\-man] [\-w|\-\-web]] [<command>|<doc>]
  37 \fIgit help\fR [\-g|\-\-guides]
  38 \fIgit help\fR [\-c|\-\-config]
  39 \fIgit help\fR [\-\-user\-interfaces]
  40 \fIgit help\fR [\-\-developer\-interfaces]
  41 .fi
  42 .SH "DESCRIPTION"
  43 .sp
  44 With no options and no \fI<command>\fR or \fI<doc>\fR given, the synopsis of the \fIgit\fR command and a list of the most commonly used Git commands are printed on the standard output\&.
  45 .sp
  46 If the option \fB\-\-all\fR or \fB\-a\fR is given, all available commands are printed on the standard output\&.
  47 .sp
  48 If the option \fB\-\-guides\fR or \fB\-g\fR is given, a list of the Git concept guides is also printed on the standard output\&.
  49 .sp
  50 If a command or other documentation is given, the relevant manual page will be brought up\&. The \fIman\fR program is used by default for this purpose, but this can be overridden by other options or configuration variables\&.
  51 .sp
  52 If an alias is given, git shows the definition of the alias on standard output\&. To get the manual page for the aliased command, use \fBgit <command> \-\-help\fR\&.
  53 .sp
  54 Note that \fBgit \-\-help \&.\&.\&.\fR is identical to \fBgit help \&.\&.\&.\fR because the former is internally converted into the latter\&.
  55 .sp
  56 To display the \fBgit\fR(1) man page, use \fBgit help git\fR\&.
  57 .sp
  58 This page can be displayed with \fIgit help help\fR or \fBgit help \-\-help\fR\&.
  59 .SH "OPTIONS"
  60 .PP
  61 \-a, \-\-all
  62 .RS 4
  63 Print all the available commands on the standard output\&.
  64 .RE
  65 .PP
  66 \-\-no\-external\-commands
  67 .RS 4
  68 When used with
  69 \fB\-\-all\fR, exclude the listing of external "git\-*" commands found in the
  70 \fB$PATH\fR\&.
  71 .RE
  72 .PP
  73 \-\-no\-aliases
  74 .RS 4
  75 When used with
  76 \fB\-\-all\fR, exclude the listing of configured aliases\&.
  77 .RE
  78 .PP
  79 \-\-verbose
  80 .RS 4
  81 When used with
  82 \fB\-\-all\fR, print description for all recognized commands\&. This is the default\&.
  83 .RE
  84 .PP
  85 \-c, \-\-config
  86 .RS 4
  87 List all available configuration variables\&. This is a short summary of the list in
  88 \fBgit-config\fR(1)\&.
  89 .RE
  90 .PP
  91 \-g, \-\-guides
  92 .RS 4
  93 Print a list of the Git concept guides on the standard output\&.
  94 .RE
  95 .PP
  96 \-\-user\-interfaces
  97 .RS 4
  98 Print a list of the repository, command and file interfaces documentation on the standard output\&.
  99 .sp
 100 In\-repository file interfaces such as
 101 \fB\&.git/info/exclude\fR
 102 are documented here (see
 103 \fBgitrepository-layout\fR(5)), as well as in\-tree configuration such as
 104 \fB\&.mailmap\fR
 105 (see
 106 \fBgitmailmap\fR(5))\&.
 107 .sp
 108 This section of the documentation also covers general or widespread user\-interface conventions (e\&.g\&.
 109 \fBgitcli\fR(7)), and pseudo\-configuration such as the file\-based
 110 \fB\&.git/hooks/*\fR
 111 interface described in
 112 \fBgithooks\fR(5)\&.
 113 .RE
 114 .PP
 115 \-\-developer\-interfaces
 116 .RS 4
 117 Print a list of file formats, protocols and other developer interfaces documentation on the standard output\&.
 118 .RE
 119 .PP
 120 \-i, \-\-info
 121 .RS 4
 122 Display manual page for the command in the
 123 \fIinfo\fR
 124 format\&. The
 125 \fIinfo\fR
 126 program will be used for that purpose\&.
 127 .RE
 128 .PP
 129 \-m, \-\-man
 130 .RS 4
 131 Display manual page for the command in the
 132 \fIman\fR
 133 format\&. This option may be used to override a value set in the
 134 \fBhelp\&.format\fR
 135 configuration variable\&.
 136 .sp
 137 By default the
 138 \fIman\fR
 139 program will be used to display the manual page, but the
 140 \fBman\&.viewer\fR
 141 configuration variable may be used to choose other display programs (see below)\&.
 142 .RE
 143 .PP
 144 \-w, \-\-web
 145 .RS 4
 146 Display manual page for the command in the
 147 \fIweb\fR
 148 (HTML) format\&. A web browser will be used for that purpose\&.
 149 .sp
 150 The web browser can be specified using the configuration variable
 151 \fBhelp\&.browser\fR, or
 152 \fBweb\&.browser\fR
 153 if the former is not set\&. If neither of these config variables is set, the
 154 \fIgit web\-\-browse\fR
 155 helper script (called by
 156 \fIgit help\fR) will pick a suitable default\&. See
 157 \fBgit-web--browse\fR(1)
 158 for more information about this\&.
 159 .RE
 160 .SH "CONFIGURATION VARIABLES"
 161 .SS "help\&.format"
 162 .sp
 163 If no command\-line option is passed, the \fBhelp\&.format\fR configuration variable will be checked\&. The following values are supported for this variable; they make \fIgit help\fR behave as their corresponding command\- line option:
 164 .sp
 165 .RS 4
 166 .ie n \{\
 167 \h'-04'\(bu\h'+03'\c
 168 .\}
 169 .el \{\
 170 .sp -1
 171 .IP \(bu 2.3
 172 .\}
 173 "man" corresponds to
 174 \fI\-m|\-\-man\fR,
 175 .RE
 176 .sp
 177 .RS 4
 178 .ie n \{\
 179 \h'-04'\(bu\h'+03'\c
 180 .\}
 181 .el \{\
 182 .sp -1
 183 .IP \(bu 2.3
 184 .\}
 185 "info" corresponds to
 186 \fI\-i|\-\-info\fR,
 187 .RE
 188 .sp
 189 .RS 4
 190 .ie n \{\
 191 \h'-04'\(bu\h'+03'\c
 192 .\}
 193 .el \{\
 194 .sp -1
 195 .IP \(bu 2.3
 196 .\}
 197 "web" or "html" correspond to
 198 \fI\-w|\-\-web\fR\&.
 199 .RE
 200 .SS "help\&.browser, web\&.browser, and browser\&.<tool>\&.path"
 201 .sp
 202 The \fBhelp\&.browser\fR, \fBweb\&.browser\fR and \fBbrowser\&.<tool>\&.path\fR will also be checked if the \fIweb\fR format is chosen (either by command\-line option or configuration variable)\&. See \fI\-w|\-\-web\fR in the OPTIONS section above and \fBgit-web--browse\fR(1)\&.
 203 .SS "man\&.viewer"
 204 .sp
 205 The \fBman\&.viewer\fR configuration variable will be checked if the \fIman\fR format is chosen\&. The following values are currently supported:
 206 .sp
 207 .RS 4
 208 .ie n \{\
 209 \h'-04'\(bu\h'+03'\c
 210 .\}
 211 .el \{\
 212 .sp -1
 213 .IP \(bu 2.3
 214 .\}
 215 "man": use the
 216 \fIman\fR
 217 program as usual,
 218 .RE
 219 .sp
 220 .RS 4
 221 .ie n \{\
 222 \h'-04'\(bu\h'+03'\c
 223 .\}
 224 .el \{\
 225 .sp -1
 226 .IP \(bu 2.3
 227 .\}
 228 "woman": use
 229 \fIemacsclient\fR
 230 to launch the "woman" mode in emacs (this only works starting with emacsclient versions 22),
 231 .RE
 232 .sp
 233 .RS 4
 234 .ie n \{\
 235 \h'-04'\(bu\h'+03'\c
 236 .\}
 237 .el \{\
 238 .sp -1
 239 .IP \(bu 2.3
 240 .\}
 241 "konqueror": use
 242 \fIkfmclient\fR
 243 to open the man page in a new konqueror tab (see
 244 \fINote about konqueror\fR
 245 below)\&.
 246 .RE
 247 .sp
 248 Values for other tools can be used if there is a corresponding \fBman\&.<tool>\&.cmd\fR configuration entry (see below)\&.
 249 .sp
 250 Multiple values may be given to the \fBman\&.viewer\fR configuration variable\&. Their corresponding programs will be tried in the order listed in the configuration file\&.
 251 .sp
 252 For example, this configuration:
 253 .sp
 254 .if n \{\
 255 .RS 4
 256 .\}
 257 .nf
 258         [man]
 259                 viewer = konqueror
 260                 viewer = woman
 261 .fi
 262 .if n \{\
 263 .RE
 264 .\}
 265 .sp
 266 will try to use konqueror first\&. But this may fail (for example, if DISPLAY is not set) and in that case emacs\*(Aq woman mode will be tried\&.
 267 .sp
 268 If everything fails, or if no viewer is configured, the viewer specified in the \fBGIT_MAN_VIEWER\fR environment variable will be tried\&. If that fails too, the \fIman\fR program will be tried anyway\&.
 269 .SS "man\&.<tool>\&.path"
 270 .sp
 271 You can explicitly provide a full path to your preferred man viewer by setting the configuration variable \fBman\&.<tool>\&.path\fR\&. For example, you can configure the absolute path to konqueror by setting \fIman\&.konqueror\&.path\fR\&. Otherwise, \fIgit help\fR assumes the tool is available in PATH\&.
 272 .SS "man\&.<tool>\&.cmd"
 273 .sp
 274 When the man viewer, specified by the \fBman\&.viewer\fR configuration variables, is not among the supported ones, then the corresponding \fBman\&.<tool>\&.cmd\fR configuration variable will be looked up\&. If this variable exists then the specified tool will be treated as a custom command and a shell eval will be used to run the command with the man page passed as arguments\&.
 275 .SS "Note about konqueror"
 276 .sp
 277 When \fIkonqueror\fR is specified in the \fBman\&.viewer\fR configuration variable, we launch \fIkfmclient\fR to try to open the man page on an already opened konqueror in a new tab if possible\&.
 278 .sp
 279 For consistency, we also try such a trick if \fIman\&.konqueror\&.path\fR is set to something like \fBA_PATH_TO/konqueror\fR\&. That means we will try to launch \fBA_PATH_TO/kfmclient\fR instead\&.
 280 .sp
 281 If you really want to use \fIkonqueror\fR, then you can use something like the following:
 282 .sp
 283 .if n \{\
 284 .RS 4
 285 .\}
 286 .nf
 287         [man]
 288                 viewer = konq
 289
 290         [man "konq"]
 291                 cmd = A_PATH_TO/konqueror
 292 .fi
 293 .if n \{\
 294 .RE
 295 .\}
 296 .SS "Note about git config \-\-global"
 297 .sp
 298 Note that all these configuration variables should probably be set using the \fB\-\-global\fR flag, for example like this:
 299 .sp
 300 .if n \{\
 301 .RS 4
 302 .\}
 303 .nf
 304 $ git config \-\-global help\&.format web
 305 $ git config \-\-global web\&.browser firefox
 306 .fi
 307 .if n \{\
 308 .RE
 309 .\}
 310 .sp
 311 as they are probably more user specific than repository specific\&. See \fBgit-config\fR(1) for more information about this\&.
 312 .SH "GIT"
 313 .sp
 314 Part of the \fBgit\fR(1) suite