logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

git-help.1 (9837B)


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