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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-06-24
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.45.2.648.g1e1586e4ed
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-HELP" "1" "2024\-06\-24" "Git 2\&.45\&.2\&.648\&.g1e1586" "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 .sp
  43 .SH "DESCRIPTION"
  44 .sp
  45 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\&.
  46 .sp
  47 If the option \fB\-\-all\fR or \fB\-a\fR is given, all available commands are printed on the standard output\&.
  48 .sp
  49 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\&.
  50 .sp
  51 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\&.
  52 .sp
  53 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\&.
  54 .sp
  55 Note that \fBgit \-\-help \&.\&.\&.\fR is identical to \fBgit help \&.\&.\&.\fR because the former is internally converted into the latter\&.
  56 .sp
  57 To display the \fBgit\fR(1) man page, use \fBgit help git\fR\&.
  58 .sp
  59 This page can be displayed with \fIgit help help\fR or \fBgit help \-\-help\fR\&.
  60 .SH "OPTIONS"
  61 .PP
  62 \-a, \-\-all
  63 .RS 4
  64 Print all the available commands on the standard output\&.
  65 .RE
  66 .PP
  67 \-\-no\-external\-commands
  68 .RS 4
  69 When used with
  70 \fB\-\-all\fR, exclude the listing of external "git\-*" commands found in the
  71 \fB$PATH\fR\&.
  72 .RE
  73 .PP
  74 \-\-no\-aliases
  75 .RS 4
  76 When used with
  77 \fB\-\-all\fR, exclude the listing of configured aliases\&.
  78 .RE
  79 .PP
  80 \-\-verbose
  81 .RS 4
  82 When used with
  83 \fB\-\-all\fR, print description for all recognized commands\&. This is the default\&.
  84 .RE
  85 .PP
  86 \-c, \-\-config
  87 .RS 4
  88 List all available configuration variables\&. This is a short summary of the list in
  89 \fBgit-config\fR(1)\&.
  90 .RE
  91 .PP
  92 \-g, \-\-guides
  93 .RS 4
  94 Print a list of the Git concept guides on the standard output\&.
  95 .RE
  96 .PP
  97 \-\-user\-interfaces
  98 .RS 4
  99 Print a list of the repository, command and file interfaces documentation on the standard output\&.
 100 .sp
 101 In\-repository file interfaces such as
 102 \fB\&.git/info/exclude\fR
 103 are documented here (see
 104 \fBgitrepository-layout\fR(5)), as well as in\-tree configuration such as
 105 \fB\&.mailmap\fR
 106 (see
 107 \fBgitmailmap\fR(5))\&.
 108 .sp
 109 This section of the documentation also covers general or widespread user\-interface conventions (e\&.g\&.
 110 \fBgitcli\fR(7)), and pseudo\-configuration such as the file\-based
 111 \fB\&.git/hooks/*\fR
 112 interface described in
 113 \fBgithooks\fR(5)\&.
 114 .RE
 115 .PP
 116 \-\-developer\-interfaces
 117 .RS 4
 118 Print a list of file formats, protocols and other developer interfaces documentation on the standard output\&.
 119 .RE
 120 .PP
 121 \-i, \-\-info
 122 .RS 4
 123 Display manual page for the command in the
 124 \fIinfo\fR
 125 format\&. The
 126 \fIinfo\fR
 127 program will be used for that purpose\&.
 128 .RE
 129 .PP
 130 \-m, \-\-man
 131 .RS 4
 132 Display manual page for the command in the
 133 \fIman\fR
 134 format\&. This option may be used to override a value set in the
 135 \fBhelp\&.format\fR
 136 configuration variable\&.
 137 .sp
 138 By default the
 139 \fIman\fR
 140 program will be used to display the manual page, but the
 141 \fBman\&.viewer\fR
 142 configuration variable may be used to choose other display programs (see below)\&.
 143 .RE
 144 .PP
 145 \-w, \-\-web
 146 .RS 4
 147 Display manual page for the command in the
 148 \fIweb\fR
 149 (HTML) format\&. A web browser will be used for that purpose\&.
 150 .sp
 151 The web browser can be specified using the configuration variable
 152 \fBhelp\&.browser\fR, or
 153 \fBweb\&.browser\fR
 154 if the former is not set\&. If neither of these config variables is set, the
 155 \fIgit web\-\-browse\fR
 156 helper script (called by
 157 \fIgit help\fR) will pick a suitable default\&. See
 158 \fBgit-web--browse\fR(1)
 159 for more information about this\&.
 160 .RE
 161 .SH "CONFIGURATION VARIABLES"
 162 .SS "help\&.format"
 163 .sp
 164 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:
 165 .sp
 166 .RS 4
 167 .ie n \{\
 168 \h'-04'\(bu\h'+03'\c
 169 .\}
 170 .el \{\
 171 .sp -1
 172 .IP \(bu 2.3
 173 .\}
 174 "man" corresponds to
 175 \fI\-m|\-\-man\fR,
 176 .RE
 177 .sp
 178 .RS 4
 179 .ie n \{\
 180 \h'-04'\(bu\h'+03'\c
 181 .\}
 182 .el \{\
 183 .sp -1
 184 .IP \(bu 2.3
 185 .\}
 186 "info" corresponds to
 187 \fI\-i|\-\-info\fR,
 188 .RE
 189 .sp
 190 .RS 4
 191 .ie n \{\
 192 \h'-04'\(bu\h'+03'\c
 193 .\}
 194 .el \{\
 195 .sp -1
 196 .IP \(bu 2.3
 197 .\}
 198 "web" or "html" correspond to
 199 \fI\-w|\-\-web\fR\&.
 200 .RE
 201 .SS "help\&.browser, web\&.browser, and browser\&.<tool>\&.path"
 202 .sp
 203 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)\&.
 204 .SS "man\&.viewer"
 205 .sp
 206 The \fBman\&.viewer\fR configuration variable will be checked if the \fIman\fR format is chosen\&. The following values are currently supported:
 207 .sp
 208 .RS 4
 209 .ie n \{\
 210 \h'-04'\(bu\h'+03'\c
 211 .\}
 212 .el \{\
 213 .sp -1
 214 .IP \(bu 2.3
 215 .\}
 216 "man": use the
 217 \fIman\fR
 218 program as usual,
 219 .RE
 220 .sp
 221 .RS 4
 222 .ie n \{\
 223 \h'-04'\(bu\h'+03'\c
 224 .\}
 225 .el \{\
 226 .sp -1
 227 .IP \(bu 2.3
 228 .\}
 229 "woman": use
 230 \fIemacsclient\fR
 231 to launch the "woman" mode in emacs (this only works starting with emacsclient versions 22),
 232 .RE
 233 .sp
 234 .RS 4
 235 .ie n \{\
 236 \h'-04'\(bu\h'+03'\c
 237 .\}
 238 .el \{\
 239 .sp -1
 240 .IP \(bu 2.3
 241 .\}
 242 "konqueror": use
 243 \fIkfmclient\fR
 244 to open the man page in a new konqueror tab (see
 245 \fINote about konqueror\fR
 246 below)\&.
 247 .RE
 248 .sp
 249 Values for other tools can be used if there is a corresponding \fBman\&.<tool>\&.cmd\fR configuration entry (see below)\&.
 250 .sp
 251 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\&.
 252 .sp
 253 For example, this configuration:
 254 .sp
 255 .if n \{\
 256 .RS 4
 257 .\}
 258 .nf
 259         [man]
 260                 viewer = konqueror
 261                 viewer = woman
 262 .fi
 263 .if n \{\
 264 .RE
 265 .\}
 266 .sp
 267 .sp
 268 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\&.
 269 .sp
 270 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\&.
 271 .SS "man\&.<tool>\&.path"
 272 .sp
 273 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\&.
 274 .SS "man\&.<tool>\&.cmd"
 275 .sp
 276 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\&.
 277 .SS "Note about konqueror"
 278 .sp
 279 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\&.
 280 .sp
 281 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\&.
 282 .sp
 283 If you really want to use \fIkonqueror\fR, then you can use something like the following:
 284 .sp
 285 .if n \{\
 286 .RS 4
 287 .\}
 288 .nf
 289         [man]
 290                 viewer = konq
 291
 292         [man "konq"]
 293                 cmd = A_PATH_TO/konqueror
 294 .fi
 295 .if n \{\
 296 .RE
 297 .\}
 298 .sp
 299 .SS "Note about git config \-\-global"
 300 .sp
 301 Note that all these configuration variables should probably be set using the \fB\-\-global\fR flag, for example like this:
 302 .sp
 303 .if n \{\
 304 .RS 4
 305 .\}
 306 .nf
 307 $ git config \-\-global help\&.format web
 308 $ git config \-\-global web\&.browser firefox
 309 .fi
 310 .if n \{\
 311 .RE
 312 .\}
 313 .sp
 314 .sp
 315 as they are probably more user specific than repository specific\&. See \fBgit-config\fR(1) for more information about this\&.
 316 .SH "GIT"
 317 .sp
 318 Part of the \fBgit\fR(1) suite