--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
+\r
+<article lang="en" id="git-help(1)">\r
+<articleinfo>\r
+ <title>git-help(1)</title>\r
+ <indexterm>\r
+ <primary>git-help(1)</primary>\r
+ </indexterm>\r
+</articleinfo>\r
+<simplesect id="_name">\r
+<title>NAME</title>\r
+<simpara>git-help - display help information about git</simpara>\r
+</simplesect>\r
+<simplesect id="_synopsis">\r
+<title>SYNOPSIS</title>\r
+<simpara><emphasis>git help</emphasis> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</simpara>\r
+</simplesect>\r
+<simplesect id="_description">\r
+<title>DESCRIPTION</title>\r
+<simpara>With no options and no COMMAND given, the synopsis of the <emphasis>git</emphasis>\r
+command and a list of the most commonly used git commands are printed\r
+on the standard output.</simpara>\r
+<simpara>If the option <emphasis>--all</emphasis> or <emphasis>-a</emphasis> is given, then all available commands are\r
+printed on the standard output.</simpara>\r
+<simpara>If a git command is named, a manual page for that command is brought\r
+up. The <emphasis>man</emphasis> program is used by default for this purpose, but this\r
+can be overridden by other options or configuration variables.</simpara>\r
+<simpara>Note that <literal>git --help …</literal> is identical to <literal>git help …</literal> because the\r
+former is internally converted into the latter.</simpara>\r
+</simplesect>\r
+<simplesect id="_options">\r
+<title>OPTIONS</title>\r
+<variablelist>\r
+<varlistentry>\r
+<term>\r
+-a\r
+</term>\r
+<term>\r
+--all\r
+</term>\r
+<listitem>\r
+<simpara>\r
+ Prints all the available commands on the standard output. This\r
+ option supersedes any other option.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+-i\r
+</term>\r
+<term>\r
+--info\r
+</term>\r
+<listitem>\r
+<simpara>\r
+ Display manual page for the command in the <emphasis>info</emphasis> format. The\r
+ <emphasis>info</emphasis> program will be used for that purpose.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+-m\r
+</term>\r
+<term>\r
+--man\r
+</term>\r
+<listitem>\r
+<simpara>\r
+ Display manual page for the command in the <emphasis>man</emphasis> format. This\r
+ option may be used to override a value set in the\r
+ <emphasis>help.format</emphasis> configuration variable.\r
+</simpara>\r
+<simpara>By default the <emphasis>man</emphasis> program will be used to display the manual page,\r
+but the <emphasis>man.viewer</emphasis> configuration variable may be used to choose\r
+other display programs (see below).</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+-w\r
+</term>\r
+<term>\r
+--web\r
+</term>\r
+<listitem>\r
+<simpara>\r
+ Display manual page for the command in the <emphasis>web</emphasis> (HTML)\r
+ format. A web browser will be used for that purpose.\r
+</simpara>\r
+<simpara>The web browser can be specified using the configuration variable\r
+<emphasis>help.browser</emphasis>, or <emphasis>web.browser</emphasis> if the former is not set. If none of\r
+these config variables is set, the <emphasis>git-web—browse</emphasis> helper script\r
+(called by <emphasis>git-help</emphasis>) will pick a suitable default. See\r
+<xref linkend="git-web—browse(1)"/> for more information about this.</simpara>\r
+</listitem>\r
+</varlistentry>\r
+</variablelist>\r
+</simplesect>\r
+<simplesect id="_configuration_variables">\r
+<title>CONFIGURATION VARIABLES</title>\r
+<simplesect id="_help_format">\r
+<title>help.format</title>\r
+<simpara>If no command line option is passed, the <emphasis>help.format</emphasis> configuration\r
+variable will be checked. The following values are supported for this\r
+variable; they make <emphasis>git-help</emphasis> behave as their corresponding command\r
+line option:</simpara>\r
+<itemizedlist>\r
+<listitem>\r
+<simpara>\r
+"man" corresponds to <emphasis>-m|--man</emphasis>,\r
+</simpara>\r
+</listitem>\r
+<listitem>\r
+<simpara>\r
+"info" corresponds to <emphasis>-i|--info</emphasis>,\r
+</simpara>\r
+</listitem>\r
+<listitem>\r
+<simpara>\r
+"web" or "html" correspond to <emphasis>-w|--web</emphasis>.\r
+</simpara>\r
+</listitem>\r
+</itemizedlist>\r
+</simplesect>\r
+<simplesect id="_help_browser_web_browser_and_browser_lt_tool_gt_path">\r
+<title>help.browser, web.browser and browser.<tool>.path</title>\r
+<simpara>The <emphasis>help.browser</emphasis>, <emphasis>web.browser</emphasis> and <emphasis>browser.<tool>.path</emphasis> will also\r
+be checked if the <emphasis>web</emphasis> format is chosen (either by command line\r
+option or configuration variable). See <emphasis>-w|--web</emphasis> in the OPTIONS\r
+section above and <xref linkend="git-web—browse(1)"/>.</simpara>\r
+</simplesect>\r
+<simplesect id="_man_viewer">\r
+<title>man.viewer</title>\r
+<simpara>The <emphasis>man.viewer</emphasis> config variable will be checked if the <emphasis>man</emphasis> format\r
+is chosen. The following values are currently supported:</simpara>\r
+<itemizedlist>\r
+<listitem>\r
+<simpara>\r
+"man": use the <emphasis>man</emphasis> program as usual,\r
+</simpara>\r
+</listitem>\r
+<listitem>\r
+<simpara>\r
+"woman": use <emphasis>emacsclient</emphasis> to launch the "woman" mode in emacs\r
+(this only works starting with emacsclient versions 22),\r
+</simpara>\r
+</listitem>\r
+<listitem>\r
+<simpara>\r
+"konqueror": use <emphasis>kfmclient</emphasis> to open the man page in a new konqueror\r
+tab (see <emphasis>Note about konqueror</emphasis> below).\r
+</simpara>\r
+</listitem>\r
+</itemizedlist>\r
+<simpara>Values for other tools can be used if there is a corresponding\r
+<emphasis>man.<tool>.cmd</emphasis> configuration entry (see below).</simpara>\r
+<simpara>Multiple values may be given to the <emphasis>man.viewer</emphasis> configuration\r
+variable. Their corresponding programs will be tried in the order\r
+listed in the configuration file.</simpara>\r
+<simpara>For example, this configuration:</simpara>\r
+<literallayout> [man]\r
+ viewer = konqueror\r
+ viewer = woman</literallayout>\r
+<simpara>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.</simpara>\r
+<simpara>If everything fails, or if no viewer is configured, the viewer specified\r
+in the GIT_MAN_VIEWER environment variable will be tried. If that\r
+fails too, the <emphasis>man</emphasis> program will be tried anyway.</simpara>\r
+</simplesect>\r
+<simplesect id="_man_lt_tool_gt_path">\r
+<title>man.<tool>.path</title>\r
+<simpara>You can explicitly provide a full path to your preferred man viewer by\r
+setting the configuration variable <emphasis>man.<tool>.path</emphasis>. For example, you\r
+can configure the absolute path to konqueror by setting\r
+<emphasis>man.konqueror.path</emphasis>. Otherwise, <emphasis>git-help</emphasis> assumes the tool is\r
+available in PATH.</simpara>\r
+</simplesect>\r
+<simplesect id="_man_lt_tool_gt_cmd">\r
+<title>man.<tool>.cmd</title>\r
+<simpara>When the man viewer, specified by the <emphasis>man.viewer</emphasis> configuration\r
+variables, is not among the supported ones, then the corresponding\r
+<emphasis>man.<tool>.cmd</emphasis> configuration variable will be looked up. If this\r
+variable exists then the specified tool will be treated as a custom\r
+command and a shell eval will be used to run the command with the man\r
+page passed as arguments.</simpara>\r
+</simplesect>\r
+<simplesect id="_note_about_konqueror">\r
+<title>Note about konqueror</title>\r
+<simpara>When <emphasis>konqueror</emphasis> is specified in the <emphasis>man.viewer</emphasis> configuration\r
+variable, we launch <emphasis>kfmclient</emphasis> to try to open the man page on an\r
+already opened konqueror in a new tab if possible.</simpara>\r
+<simpara>For consistency, we also try such a trick if <emphasis>man.konqueror.path</emphasis> is\r
+set to something like <emphasis>A_PATH_TO/konqueror</emphasis>. That means we will try to\r
+launch <emphasis>A_PATH_TO/kfmclient</emphasis> instead.</simpara>\r
+<simpara>If you really want to use <emphasis>konqueror</emphasis>, then you can use something like\r
+the following:</simpara>\r
+<literallayout> [man]\r
+ viewer = konq\r
+\r
+ [man "konq"]\r
+ cmd = A_PATH_TO/konqueror</literallayout>\r
+</simplesect>\r
+<simplesect id="_note_about_git_config_global">\r
+<title>Note about git config --global</title>\r
+<simpara>Note that all these configuration variables should probably be set\r
+using the <emphasis>--global</emphasis> flag, for example like this:</simpara>\r
+<literallayout>$ git config --global help.format web\r
+$ git config --global web.browser firefox</literallayout>\r
+<simpara>as they are probably more user specific than repository specific.\r
+See <xref linkend="git-config(1)"/> for more information about this.</simpara>\r
+</simplesect>\r
+</simplesect>\r
+<simplesect id="_author">\r
+<title>Author</title>\r
+<simpara>Written by Junio C Hamano <<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>> and the git-list\r
+<<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>>.</simpara>\r
+</simplesect>\r
+<simplesect id="_documentation">\r
+<title>Documentation</title>\r
+<simpara>Initial documentation was part of the <xref linkend="git(1)"/> man page.\r
+Christian Couder <<ulink url="mailto:chriscool@tuxfamily.org">chriscool@tuxfamily.org</ulink>> extracted and rewrote it a\r
+little. Maintenance is done by the git-list <<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>>.</simpara>\r
+</simplesect>\r
+<simplesect id="_git">\r
+<title>GIT</title>\r
+<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
+</simplesect>\r
+</article>\r
OSDN Git Service
