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