Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
normally hide the root commit will now show it. True by default.
+man.viewer::
+ Specify the programs that may be used to display help in the
+ 'man' format. See linkgit:git-help[1].
+
merge.summary::
Whether to include summaries of merged commits in newly created
merge commit messages. False by default.
</p>\r
</dd>\r
<dt>\r
+man.viewer\r
+</dt>\r
+<dd>\r
+<p>\r
+ Specify the programs that may be used to display help in the\r
+ <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.\r
+</p>\r
+</dd>\r
+<dt>\r
merge.summary\r
</dt>\r
<dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 14-Mar-2008 08:58:15 UTC\r
+Last updated 15-Mar-2008 09:48:17 UTC\r
</div>\r
</div>\r
</body>\r
</dt>\r
<dd>\r
<p>\r
- Use the <em>info</em> program to display the manual page, instead of\r
- the <em>man</em> program that is used by default.\r
+ Display manual page for the command in the <em>info</em> format. The\r
+ <em>info</em> program will be used for that purpose.\r
</p>\r
</dd>\r
<dt>\r
</dt>\r
<dd>\r
<p>\r
- Use the <em>man</em> program to display the manual page. This may be\r
- used to override a value set in the <em>help.format</em>\r
- configuration variable.\r
+ Display manual page for the command in the <em>man</em> format. This\r
+ option may be used to override a value set in the\r
+ <em>help.format</em> configuration variable.\r
</p>\r
+<p>By default the <em>man</em> program will be used to display the manual page,\r
+but the <em>man.viewer</em> configuration variable may be used to choose\r
+other display programs (see below).</p>\r
</dd>\r
<dt>\r
-w|--web\r
</dt>\r
<dd>\r
<p>\r
- Use a web browser to display the HTML manual page, instead of\r
- the <em>man</em> program that is used by default.\r
+ Display manual page for the command in the <em>web</em> (HTML)\r
+ format. A web browser will be used for that purpose.\r
</p>\r
<p>The web browser can be specified using the configuration variable\r
<em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of\r
</div>\r
<h2>CONFIGURATION VARIABLES</h2>\r
<div class="sectionbody">\r
+<h3>help.format</h3>\r
<p>If no command line option is passed, the <em>help.format</em> configuration\r
variable will be checked. The following values are supported for this\r
variable; they make <em>git-help</em> behave as their corresponding command\r
</li>\r
<li>\r
<p>\r
-"web" or "html" correspond to <em>-w|--web</em>,\r
+"web" or "html" correspond to <em>-w|--web</em>.\r
</p>\r
</li>\r
</ul>\r
+<h3>help.browser, web.browser and browser.<tool>.path</h3>\r
<p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.<tool>.path</em> will also\r
be checked if the <em>web</em> format is chosen (either by command line\r
option or configuration variable). See <em>-w|--web</em> in the OPTIONS\r
section above and <a href="git-web--browse.html">git-web--browse(1)</a>.</p>\r
-<p>Note that these configuration variables should probably be set using\r
-the <em>--global</em> flag, for example like this:</p>\r
+<h3>man.viewer</h3>\r
+<p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format\r
+is chosen. Only the following values are currently supported:</p>\r
+<ul>\r
+<li>\r
+<p>\r
+"man": use the <em>man</em> program as usual,\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+"woman": use <em>emacsclient</em> to launch the "woman" mode in emacs\r
+(this only works starting with emacsclient versions 22),\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+"konqueror": use a man KIO slave in konqueror.\r
+</p>\r
+</li>\r
+</ul>\r
+<p>Multiple values may be given to this configuration variable. Their\r
+corresponding programs will be tried in the order listed in the\r
+configuration file.</p>\r
+<p>For example, this configuration:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>[man]\r
+ viewer = konqueror\r
+ viewer = woman</tt></pre>\r
+</div></div>\r
+<p>will try to use konqueror first. But this may fail (for example if\r
+DISPLAY is not set) and in that case emacs' woman mode will be tried.</p>\r
+<p>If everything fails the <em>man</em> program will be tried anyway.</p>\r
+<h3>Note about git config --global</h3>\r
+<p>Note that all these configuration variables should probably be set\r
+using the <em>--global</em> flag, for example like this:</p>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ git config --global help.format web\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 17-Feb-2008 03:50:06 UTC\r
+Last updated 15-Mar-2008 09:48:17 UTC\r
</div>\r
</div>\r
</body>\r
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.
+ Display manual page for the command in the 'info' format. The
+ 'info' program will be used for that purpose.
-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.
+ Display manual page for the command in the 'man' format. This
+ option may be used to override a value set in the
+ 'help.format' configuration variable.
++
+By default the 'man' program will be used to display the manual page,
+but the 'man.viewer' configuration variable may be used to choose
+other display programs (see below).
-w|--web::
- Use a web browser to display the HTML manual page, instead of
- the 'man' program that is used by default.
+ Display manual page for the command in the 'web' (HTML)
+ format. A web browser will be used for that purpose.
+
The web browser can be specified using the configuration variable
'help.browser', or 'web.browser' if the former is not set. If none of
CONFIGURATION VARIABLES
-----------------------
+help.format
+~~~~~~~~~~~
+
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
* "man" corresponds to '-m|--man',
* "info" corresponds to '-i|--info',
-* "web" or "html" correspond to '-w|--web',
+* "web" or "html" correspond to '-w|--web'.
+
+help.browser, web.browser and browser.<tool>.path
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 and linkgit:git-web--browse[1].
-Note that these configuration variables should probably be set using
-the '--global' flag, for example like this:
+man.viewer
+~~~~~~~~~~
+
+The 'man.viewer' config variable will be checked if the 'man' format
+is chosen. Only the following values are currently supported:
+
+* "man": use the 'man' program as usual,
+* "woman": use 'emacsclient' to launch the "woman" mode in emacs
+(this only works starting with emacsclient versions 22),
+* "konqueror": use a man KIO slave in konqueror.
+
+Multiple values may be given to this configuration variable. Their
+corresponding programs will be tried in the order listed in the
+configuration file.
+
+For example, this configuration:
+
+ [man]
+ viewer = konqueror
+ viewer = woman
+
+will try to use konqueror first. But this may fail (for example if
+DISPLAY is not set) and in that case emacs' woman mode will be tried.
+
+If everything fails the 'man' program will be tried anyway.
+
+Note about git config --global
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Note that all these configuration variables should probably be set
+using the '--global' flag, for example like this:
------------------------------------------------
$ git config --global help.format web
<div class="verseblock">\r
<div class="content"><em>git-submodule</em> [--quiet] add [-b branch] [--] <repository> [<path>]\r
<em>git-submodule</em> [--quiet] status [--cached] [--] [<path>…]\r
-<em>git-submodule</em> [--quiet] [init|update] [--] [<path>…]</div></div>\r
+<em>git-submodule</em> [--quiet] [init|update] [--] [<path>…]\r
+<em>git-submodule</em> [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>…]</div></div>\r
</div>\r
<h2>COMMANDS</h2>\r
<div class="sectionbody">\r
This will make the submodules HEAD be detached.\r
</p>\r
</dd>\r
+<dt>\r
+summary\r
+</dt>\r
+<dd>\r
+<p>\r
+ Show commit summary between the given commit (defaults to HEAD) and\r
+ working tree/index. For a submodule in question, a series of commits\r
+ in the submodule between the given super project commit and the\r
+ index or working tree (switched by --cached) are shown.\r
+</p>\r
+</dd>\r
</dl>\r
</div>\r
<h2>OPTIONS</h2>\r
</dt>\r
<dd>\r
<p>\r
- Display the SHA-1 stored in the index, not the SHA-1 of the currently\r
- checked out submodule commit. This option is only valid for the\r
- status command.\r
+ This option is only valid for status and summary commands. These\r
+ commands typically use the commit found in the submodule HEAD, but\r
+ with this option, the commit stored in the index is used instead.\r
+</p>\r
+</dd>\r
+<dt>\r
+-n, --summary-limit\r
+</dt>\r
+<dd>\r
+<p>\r
+ This option is only valid for the summary command.\r
+ Limit the summary size (number of commits shown in total).\r
+ Giving 0 will disable the summary; a negative number means unlimted\r
+ (the default). This limit only applies to modified submodules. The\r
+ size is always limited to 1 for added/deleted/typechanged submodules.\r
</p>\r
</dd>\r
<dt>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 09-Mar-2008 10:38:33 UTC\r
+Last updated 15-Mar-2008 09:48:17 UTC\r
</div>\r
</div>\r
</body>\r
'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>]
'git-submodule' [--quiet] status [--cached] [--] [<path>...]
'git-submodule' [--quiet] [init|update] [--] [<path>...]
+'git-submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
COMMANDS
checkout the commit specified in the index of the containing repository.
This will make the submodules HEAD be detached.
+summary::
+ Show commit summary between the given commit (defaults to HEAD) and
+ working tree/index. For a submodule in question, a series of commits
+ in the submodule between the given super project commit and the
+ index or working tree (switched by --cached) are shown.
OPTIONS
-------
Branch of repository to add as submodule.
--cached::
- Display the SHA-1 stored in the index, not the SHA-1 of the currently
- checked out submodule commit. This option is only valid for the
- status command.
+ This option is only valid for status and summary commands. These
+ commands typically use the commit found in the submodule HEAD, but
+ with this option, the commit stored in the index is used instead.
+
+-n, --summary-limit::
+ This option is only valid for the summary command.
+ Limit the summary size (number of commits shown in total).
+ Giving 0 will disable the summary; a negative number means unlimted
+ (the default). This limit only applies to modified submodules. The
+ size is always limited to 1 for added/deleted/typechanged submodules.
<path>::
Path to submodule(s). When specified this will restrict the command
projects / git.git / commitdiff