git-help.html - external/gitster/git-htmldocs - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <meta name="generator" content="AsciiDoc 7.0.2" />
 <style type="text/css">
 /* Debug borders */
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
 /*
  border: 1px solid red;
 */
 }

 body {
  margin: 1em 5% 1em 5%;
 }

 a { color: blue; }
 a:visited { color: fuchsia; }

 em {
  font-style: italic;
 }

 strong {
  font-weight: bold;
 }

 tt {
  color: navy;
 }

 h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
 }

 h1 {
  border-bottom: 2px solid silver;
 }
 h2 {
  border-bottom: 2px solid silver;
  padding-top: 0.5em;
 }

 div.sectionbody {
  font-family: serif;
  margin-left: 0;
 }

 hr {
  border: 1px solid silver;
 }

 p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
 }

 pre {
  padding: 0;
  margin: 0;
 }

 span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.2em;
 }
 span#email {
 }
 span#revision {
  font-family: sans-serif;
 }

 div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
 }
 div#footer-text {
  float: left;
  padding-bottom: 0.5em;
 }
 div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
 }

 div#preamble,
 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 div.admonitionblock {
  margin-right: 10%;
  margin-top: 1.5em;
  margin-bottom: 1.5em;
 }
 div.admonitionblock {
  margin-top: 2.5em;
  margin-bottom: 2.5em;
 }

 div.content { /* Block element content. */
  padding: 0;
 }

 /* Block element titles. */
 div.title, caption.title {
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
 }
 div.title + * {
  margin-top: 0;
 }

 td div.title:first-child {
  margin-top: 0.0em;
 }
 div.content div.title:first-child {
  margin-top: 0.0em;
 }
 div.content + div.title {
  margin-top: 0.0em;
 }

 div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }

 div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock > div.content {
  padding-left: 2.0em;
 }
 div.quoteblock .attribution {
  text-align: right;
 }

 div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
 }
 div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 2px solid silver;
 }

 div.exampleblock > div.content {
  border-left: 2px solid silver;
  padding: 0.5em;
 }

 div.verseblock div.content {
  white-space: pre;
 }

 div.imageblock div.content { padding-left: 0; }
 div.imageblock img { border: 1px solid silver; }
 span.image img { border-style: none; }

 dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: italic;
 }
 dd > *:first-child {
  margin-top: 0;
 }

 ul, ol {
  list-style-position: outside;
 }
 ol.olist2 {
  list-style-type: lower-alpha;
 }

 div.tableblock > table {
  border-color: #527bbd;
  border-width: 3px;
 }
 thead {
  font-family: sans-serif;
  font-weight: bold;
 }
 tfoot {
  font-weight: bold;
 }

 div.hlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 td.hlist1 {
  vertical-align: top;
  font-style: italic;
  padding-right: 0.8em;
 }
 td.hlist2 {
  vertical-align: top;
 }

 @media print {
  div#footer-badges { display: none; }
 }
 include::./stylesheets/xhtml11-manpage.css[]
 /* Workarounds for IE6's broken and incomplete CSS2. */

 div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }
 div.sidebar-title, div.image-title {
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
 }

 div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock-content {
  padding-left: 2.0em;
 }

 div.exampleblock-content {
  border-left: 2px solid silver;
  padding-left: 0.5em;
 }
 </style>
 <title>git-help(1)</title>
 </head>
 <body>
 <div id="header">
 <h1>
 git-help(1) Manual Page
 </h1>
 <h2>NAME</h2>
 <div class="sectionbody">
 <p>git-help -
  display help information about git
 </p>
 </div>
 </div>
 <h2>SYNOPSIS</h2>
 <div class="sectionbody">
 <p><em>git help</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</p>
 </div>
 <h2>DESCRIPTION</h2>
 <div class="sectionbody">
 <p>With no options and no COMMAND given, the synopsis of the <em>git</em>
 command and a list of the most commonly used git commands are printed
 on the standard output.</p>
 <p>If the option <em>--all</em> or <em>-a</em> is given, then all available commands are
 printed on the standard output.</p>
 <p>If a git command is named, a manual page for that command is brought
 up. The <em>man</em> program is used by default for this purpose, but this
 can be overridden by other options or configuration variables.</p>
 <p>Note that <em>git --help &#8230;</em> is identical as <em>git help &#8230;</em> because the
 former is internally converted into the latter.</p>
 </div>
 <h2>OPTIONS</h2>
 <div class="sectionbody">
 <dl>
 <dt>
 -a|--all
 </dt>
 <dd>
 <p>
  Prints all the available commands on the standard output. This
  option supersedes any other option.
 </p>
 </dd>
 <dt>
 -i|--info
 </dt>
 <dd>
 <p>
  Display manual page for the command in the <em>info</em> format. The
  <em>info</em> program will be used for that purpose.
 </p>
 </dd>
 <dt>
 -m|--man
 </dt>
 <dd>
 <p>
  Display manual page for the command in the <em>man</em> format. This
  option may be used to override a value set in the
  <em>help.format</em> configuration variable.
 </p>
 <p>By default the <em>man</em> program will be used to display the manual page,
 but the <em>man.viewer</em> configuration variable may be used to choose
 other display programs (see below).</p>
 </dd>
 <dt>
 -w|--web
 </dt>
 <dd>
 <p>
  Display manual page for the command in the <em>web</em> (HTML)
  format. A web browser will be used for that purpose.
 </p>
 <p>The web browser can be specified using the configuration variable
 <em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of
 these config variables is set, the <em>git-web--browse</em> helper script
 (called by <em>git-help</em>) will pick a suitable default. See
 <a href="git-web--browse.html">git-web--browse(1)</a> for more information about this.</p>
 </dd>
 </dl>
 </div>
 <h2>CONFIGURATION VARIABLES</h2>
 <div class="sectionbody">
 <h3>help.format</h3>
 <p>If no command line option is passed, the <em>help.format</em> configuration
 variable will be checked. The following values are supported for this
 variable; they make <em>git-help</em> behave as their corresponding command
 line option:</p>
 <ul>
 <li>
 <p>
 "man" corresponds to <em>-m|--man</em>,
 </p>
 </li>
 <li>
 <p>
 "info" corresponds to <em>-i|--info</em>,
 </p>
 </li>
 <li>
 <p>
 "web" or "html" correspond to <em>-w|--web</em>.
 </p>
 </li>
 </ul>
 <h3>help.browser, web.browser and browser.&lt;tool&gt;.path</h3>
 <p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.&lt;tool&gt;.path</em> will also
 be checked if the <em>web</em> format is chosen (either by command line
 option or configuration variable). See <em>-w|--web</em> in the OPTIONS
 section above and <a href="git-web--browse.html">git-web--browse(1)</a>.</p>
 <h3>man.viewer</h3>
 <p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format
 is chosen. Only the following values are currently supported:</p>
 <ul>
 <li>
 <p>
 "man": use the <em>man</em> program as usual,
 </p>
 </li>
 <li>
 <p>
 "woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
 (this only works starting with emacsclient versions 22),
 </p>
 </li>
 <li>
 <p>
 "konqueror": use a man KIO slave in konqueror.
 </p>
 </li>
 </ul>
 <p>Multiple values may be given to this configuration variable. Their
 corresponding programs will be tried in the order listed in the
 configuration file.</p>
 <p>For example, this configuration:</p>
 <div class="literalblock">
 <div class="content">
 <pre><tt>[man]
  viewer = konqueror
  viewer = woman</tt></pre>
 </div></div>
 <p>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.</p>
 <p>If everything fails the <em>man</em> program will be tried anyway.</p>
 <h3>Note about git config --global</h3>
 <p>Note that all these configuration variables should probably be set
 using the <em>--global</em> flag, for example like this:</p>
 <div class="listingblock">
 <div class="content">
 <pre><tt>$ git config --global help.format web
 $ git config --global web.browser firefox</tt></pre>
 </div></div>
 <p>as they are probably more user specific than repository specific.
 See <a href="git-config.html">git-config(1)</a> for more information about this.</p>
 </div>
 <h2>Author</h2>
 <div class="sectionbody">
 <p>Written by Junio C Hamano &lt;gitster@pobox.com&gt; and the git-list
 &lt;git@vger.kernel.org&gt;.</p>
 </div>
 <h2>Documentation</h2>
 <div class="sectionbody">
 <p>Initial documentation was part of the <a href="git.html">git(7)</a> man page.
 Christian Couder &lt;chriscool@tuxfamily.org&gt; extracted and rewrote it a
 little. Maintenance is done by the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>
 <h2>GIT</h2>
 <div class="sectionbody">
 <p>Part of the <a href="git.html">git(7)</a> suite</p>
 </div>
 <div id="footer">
 <div id="footer-text">
 Last updated 15-Mar-2008 09:48:17 UTC
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<meta name="generator" content="AsciiDoc 7.0.2" />
	<style type="text/css">
	/* Debug borders */
	p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
	/*
	border: 1px solid red;
	*/
	}

	body {
	margin: 1em 5% 1em 5%;
	}

	a { color: blue; }
	a:visited { color: fuchsia; }

	em {
	font-style: italic;
	}

	strong {
	font-weight: bold;
	}

	tt {
	color: navy;
	}

	h1, h2, h3, h4, h5, h6 {
	color: #527bbd;
	font-family: sans-serif;
	margin-top: 1.2em;
	margin-bottom: 0.5em;
	line-height: 1.3;
	}

	h1 {
	border-bottom: 2px solid silver;
	}
	h2 {
	border-bottom: 2px solid silver;
	padding-top: 0.5em;
	}

	div.sectionbody {
	font-family: serif;
	margin-left: 0;
	}

	hr {
	border: 1px solid silver;
	}

	p {
	margin-top: 0.5em;
	margin-bottom: 0.5em;
	}

	pre {
	padding: 0;
	margin: 0;
	}

	span#author {
	color: #527bbd;
	font-family: sans-serif;
	font-weight: bold;
	font-size: 1.2em;
	}
	span#email {
	}
	span#revision {
	font-family: sans-serif;
	}

	div#footer {
	font-family: sans-serif;
	font-size: small;
	border-top: 2px solid silver;
	padding-top: 0.5em;
	margin-top: 4.0em;
	}
	div#footer-text {
	float: left;
	padding-bottom: 0.5em;
	}
	div#footer-badges {
	float: right;
	padding-bottom: 0.5em;
	}

	div#preamble,
	div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
	div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
	div.admonitionblock {
	margin-right: 10%;
	margin-top: 1.5em;
	margin-bottom: 1.5em;
	}
	div.admonitionblock {
	margin-top: 2.5em;
	margin-bottom: 2.5em;
	}

	div.content { /* Block element content. */
	padding: 0;
	}

	/* Block element titles. */
	div.title, caption.title {
	font-family: sans-serif;
	font-weight: bold;
	text-align: left;
	margin-top: 1.0em;
	margin-bottom: 0.5em;
	}
	div.title + * {
	margin-top: 0;
	}

	td div.title:first-child {
	margin-top: 0.0em;
	}
	div.content div.title:first-child {
	margin-top: 0.0em;
	}
	div.content + div.title {
	margin-top: 0.0em;
	}

	div.sidebarblock > div.content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}

	div.listingblock > div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock > div.content {
	padding-left: 2.0em;
	}
	div.quoteblock .attribution {
	text-align: right;
	}

	div.admonitionblock .icon {
	vertical-align: top;
	font-size: 1.1em;
	font-weight: bold;
	text-decoration: underline;
	color: #527bbd;
	padding-right: 0.5em;
	}
	div.admonitionblock td.content {
	padding-left: 0.5em;
	border-left: 2px solid silver;
	}

	div.exampleblock > div.content {
	border-left: 2px solid silver;
	padding: 0.5em;
	}

	div.verseblock div.content {
	white-space: pre;
	}

	div.imageblock div.content { padding-left: 0; }
	div.imageblock img { border: 1px solid silver; }
	span.image img { border-style: none; }

	dl {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	dt {
	margin-top: 0.5em;
	margin-bottom: 0;
	font-style: italic;
	}
	dd > *:first-child {
	margin-top: 0;
	}

	ul, ol {
	list-style-position: outside;
	}
	ol.olist2 {
	list-style-type: lower-alpha;
	}

	div.tableblock > table {
	border-color: #527bbd;
	border-width: 3px;
	}
	thead {
	font-family: sans-serif;
	font-weight: bold;
	}
	tfoot {
	font-weight: bold;
	}

	div.hlist {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	td.hlist1 {
	vertical-align: top;
	font-style: italic;
	padding-right: 0.8em;
	}
	td.hlist2 {
	vertical-align: top;
	}

	@media print {
	div#footer-badges { display: none; }
	}
	include::./stylesheets/xhtml11-manpage.css[]
	/* Workarounds for IE6's broken and incomplete CSS2. */

	div.sidebar-content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}
	div.sidebar-title, div.image-title {
	font-family: sans-serif;
	font-weight: bold;
	margin-top: 0.0em;
	margin-bottom: 0.5em;
	}

	div.listingblock div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock-content {
	padding-left: 2.0em;
	}

	div.exampleblock-content {
	border-left: 2px solid silver;
	padding-left: 0.5em;
	}
	</style>
	<title>git-help(1)</title>
	</head>
	<body>
	<div id="header">
	<h1>
	git-help(1) Manual Page
	</h1>
	<h2>NAME</h2>
	<div class="sectionbody">
	<p>git-help -
	display help information about git
	</p>
	</div>
	</div>
	<h2>SYNOPSIS</h2>
	<div class="sectionbody">
	<p><em>git help</em> [-a\|--all\|-i\|--info\|-m\|--man\|-w\|--web] [COMMAND]</p>
	</div>
	<h2>DESCRIPTION</h2>
	<div class="sectionbody">
	<p>With no options and no COMMAND given, the synopsis of the <em>git</em>
	command and a list of the most commonly used git commands are printed
	on the standard output.</p>
	<p>If the option <em>--all</em> or <em>-a</em> is given, then all available commands are
	printed on the standard output.</p>
	<p>If a git command is named, a manual page for that command is brought
	up. The <em>man</em> program is used by default for this purpose, but this
	can be overridden by other options or configuration variables.</p>
	<p>Note that <em>git --help …</em> is identical as <em>git help …</em> because the
	former is internally converted into the latter.</p>
	</div>
	<h2>OPTIONS</h2>
	<div class="sectionbody">
	<dl>
	<dt>
	-a\|--all
	</dt>
	<dd>
	<p>
	Prints all the available commands on the standard output. This
	option supersedes any other option.
	</p>
	</dd>
	<dt>
	-i\|--info
	</dt>
	<dd>
	<p>
	Display manual page for the command in the <em>info</em> format. The
	<em>info</em> program will be used for that purpose.
	</p>
	</dd>
	<dt>
	-m\|--man
	</dt>
	<dd>
	<p>
	Display manual page for the command in the <em>man</em> format. This
	option may be used to override a value set in the
	<em>help.format</em> configuration variable.
	</p>
	<p>By default the <em>man</em> program will be used to display the manual page,
	but the <em>man.viewer</em> configuration variable may be used to choose
	other display programs (see below).</p>
	</dd>
	<dt>
	-w\|--web
	</dt>
	<dd>
	<p>
	Display manual page for the command in the <em>web</em> (HTML)
	format. A web browser will be used for that purpose.
	</p>
	<p>The web browser can be specified using the configuration variable
	<em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of
	these config variables is set, the <em>git-web--browse</em> helper script
	(called by <em>git-help</em>) will pick a suitable default. See
	<a href="git-web--browse.html">git-web--browse(1)</a> for more information about this.</p>
	</dd>
	</dl>
	</div>
	<h2>CONFIGURATION VARIABLES</h2>
	<div class="sectionbody">
	<h3>help.format</h3>
	<p>If no command line option is passed, the <em>help.format</em> configuration
	variable will be checked. The following values are supported for this
	variable; they make <em>git-help</em> behave as their corresponding command
	line option:</p>
	<ul>
	<li>
	<p>
	"man" corresponds to <em>-m\|--man</em>,
	</p>
	</li>
	<li>
	<p>
	"info" corresponds to <em>-i\|--info</em>,
	</p>
	</li>
	<li>
	<p>
	"web" or "html" correspond to <em>-w\|--web</em>.
	</p>
	</li>
	</ul>
	<h3>help.browser, web.browser and browser.<tool>.path</h3>
	<p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.<tool>.path</em> will also
	be checked if the <em>web</em> format is chosen (either by command line
	option or configuration variable). See <em>-w\|--web</em> in the OPTIONS
	section above and <a href="git-web--browse.html">git-web--browse(1)</a>.</p>
	<h3>man.viewer</h3>
	<p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format
	is chosen. Only the following values are currently supported:</p>
	<ul>
	<li>
	<p>
	"man": use the <em>man</em> program as usual,
	</p>
	</li>
	<li>
	<p>
	"woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
	(this only works starting with emacsclient versions 22),
	</p>
	</li>
	<li>
	<p>
	"konqueror": use a man KIO slave in konqueror.
	</p>
	</li>
	</ul>
	<p>Multiple values may be given to this configuration variable. Their
	corresponding programs will be tried in the order listed in the
	configuration file.</p>
	<p>For example, this configuration:</p>
	<div class="literalblock">
	<div class="content">
	<pre><tt>[man]
	viewer = konqueror
	viewer = woman</tt></pre>
	</div></div>
	<p>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.</p>
	<p>If everything fails the <em>man</em> program will be tried anyway.</p>
	<h3>Note about git config --global</h3>
	<p>Note that all these configuration variables should probably be set
	using the <em>--global</em> flag, for example like this:</p>
	<div class="listingblock">
	<div class="content">
	<pre><tt>$ git config --global help.format web
	$ git config --global web.browser firefox</tt></pre>
	</div></div>
	<p>as they are probably more user specific than repository specific.
	See <a href="git-config.html">git-config(1)</a> for more information about this.</p>
	</div>
	<h2>Author</h2>
	<div class="sectionbody">
	<p>Written by Junio C Hamano <gitster@pobox.com> and the git-list
	<git@vger.kernel.org>.</p>
	</div>
	<h2>Documentation</h2>
	<div class="sectionbody">
	<p>Initial documentation was part of the <a href="git.html">git(7)</a> man page.
	Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a
	little. Maintenance is done by the git-list <git@vger.kernel.org>.</p>
	</div>
	<h2>GIT</h2>
	<div class="sectionbody">
	<p>Part of the <a href="git.html">git(7)</a> suite</p>
	</div>
	<div id="footer">
	<div id="footer-text">
	Last updated 15-Mar-2008 09:48:17 UTC
	</div>
	</div>
	</body>
	</html>