mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-29 04:52:50 +08:00
8 lines
9.8 KiB
HTML
8 lines
9.8 KiB
HTML
<div class="c-markdown doc-markdown"><div class="doc-postil"><div class="c-markdown"><h2>Name</h2></div></div><div class="doc-postil"><div class="c-markdown"><p>git-help - 显示关于 Git 的帮助信息</p></div></div><div class="doc-postil"><div class="c-markdown"><h2>概要</h2></div></div><div class="doc-postil"><div class="c-markdown"><pre class="prism-token token language-javascript">git help [-a|--all] [-g|--guide] [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]</pre></div></div><div class="doc-postil"><div class="c-markdown"><h2>描述</h2></div></div><div class="doc-postil"><div class="c-markdown"><p>如果没有选项，也没有 COMMAND 或 GUIDE ，<code>git</code>命令的概要和最常用的 Git 命令列表将打印在标准输出中。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>如果选项<code>--all</code>或<code>-a</code>给定，所有可用的命令都打印在标准输出上。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>如果选项<code>--guide</code>或者<code>-g</code>给出，有用的 Git 指南列表也会打印在标准输出中。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>如果给出命令或指南，则提供该命令或指南的手册页。该<code>man</code>程序默认用于此目的，但这可以被其他选项或配置变量覆盖。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>注意，<code>git --help ...</code>是相同的<code>git help ...</code>，因为前者在内部转换成后者。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>要显示 git [1] 手册页，请使用<code>git help git</code>。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>此页面可以用<code>git help help</code>或显示<code>git help --help</code></p></div></div><div class="doc-postil"><div class="c-markdown"><h2>选项</h2></div></div><div class="doc-postil"><div class="c-markdown"><p>-a --all</p></div></div><div class="doc-postil"><div class="c-markdown"><p>在标准输出上打印所有可用的命令。该选项将覆盖任何给定的命令或指南名称。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>-g --guides</p></div></div><div class="doc-postil"><div class="c-markdown"><p>在标准输出上打印有用的指南列表。该选项将覆盖任何给定的命令或指南名称。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>-i --info</p></div></div><div class="doc-postil"><div class="c-markdown"><p>以<code>info</code>格式显示命令的手册页。该<code>info</code>计划将用于此目的。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>-m --man</p></div></div><div class="doc-postil"><div class="c-markdown"><p>以<code>man</code>格式显示命令的手册页。该选项可用于覆盖<code>help.format</code>配置变量中设置的值。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>默认情况下，<code>man</code>程序将用于显示手册页，但<code>man.viewer</code>配置变量可用于选择其他显示程序（见下文）。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>-w --web</p></div></div><div class="doc-postil"><div class="c-markdown"><p>以<code>web</code>（HTML）格式显示命令的手册页。网页浏览器将用于此目的。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>Web浏览器可以使用配置变量指定<code>help.browser</code>，或者<code>web.browser</code>前者未设置。如果这些配置变量都没有设置，<code>git web{litdd}browse</code>助手脚本（调用者<code>git help</code>）会选择合适的默认值。有关详细信息，请参阅 git-web {litdd} 浏览[1]。</p></div></div><div class="doc-postil"><div class="c-markdown"><h2>配置变量</h2></div></div><div class="doc-postil"><div class="c-markdown"><h3>help.format</h3></div></div><div class="doc-postil"><div class="c-markdown"><p>如果没有传递任何命令行选项，<code>help.format</code>则会检查配置变量。该变量支持以下值; 它们会<code>git help</code>表现为相应的命令行选项：</p></div></div><div class="doc-postil"><div class="c-markdown"><ul class="ul-level-0 list-paddingleft-2" style="margin: 10px 0px 10px 20px;"><li><p>"man" corresponds to <code>-m|--man</code>,</p></li></ul></div></div><div class="doc-postil"><div class="c-markdown"><ul class="ul-level-0 list-paddingleft-2" style="margin: 10px 0px 10px 20px;"><li><p>"info" corresponds to <code>-i|--info</code>,</p></li></ul></div></div><div class="doc-postil"><div class="c-markdown"><ul class="ul-level-0 list-paddingleft-2" style="margin: 10px 0px 10px 20px;"><li><p>“web”或“html”对应于<code>-w|--web</code>.help.browser，web.browser 和 browser。<tool> .pathThe <code>help.browser</code>，<code>web.browser</code> 并且 <code>browser.<tool>.path</code> 如果<code>web</code>格式被选择（通过命令行选项或配置变量），也将被检查。请参阅<code>-w|--web</code>上面的选项部分和 git-web {litdd} browse [1] .man.viewer <code>man.viewer</code>如果<code>man</code>选择了格式，将检查配置变量。目前支持以下值：</p></li></ul></div></div><div class="doc-postil"><div class="c-markdown"><ul class="ul-level-0 list-paddingleft-2" style="margin: 10px 0px 10px 20px;"><li><p>“man”：<code>man</code>像往常一样使用该程序，</p></li></ul></div></div><div class="doc-postil"><div class="c-markdown"><ul class="ul-level-0 list-paddingleft-2" style="margin: 10px 0px 10px 20px;"><li><p>“woman”：用于<code>emacsclient</code>在 emacs 中启动“woman”模式（这只能从 emacsclient 版本22开始），</p></li></ul></div></div><div class="doc-postil"><div class="c-markdown"><ul class="ul-level-0 list-paddingleft-2" style="margin: 10px 0px 10px 20px;"><li><p>“konqueror”：用于<code>kfmclient</code>在新的 konqueror 选项卡中打开手册页（见<code>Note about konqueror</code>下文）。</p></li></ul></div></div><div class="doc-postil"><div class="c-markdown"><p>如果有相应的<code>man.<tool>.cmd</code>配置条目，可以使用其他工具的值（见下文）。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>可以给<code>man.viewer</code>配置变量多个值。他们相应的程序将按照配置文件中列出的顺序进行尝试。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>例如，这种配置：</p></div></div><div class="doc-postil"><div class="c-markdown"><pre class="prism-token token language-javascript"> [man]
|
||
|
||
viewer = konqueror
|
||
|
||
viewer = woman</pre></div></div><div class="doc-postil"><div class="c-markdown"><p>将尝试首先使用 konqueror。但是这可能会失败（例如，如果没有设置 DISPLAY），那么 emacs 的女性模式将被尝试。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>如果一切都失败了，或者没有配置查看器，那么<code>GIT_MAN_VIEWER</code>环境变量中指定的查看器将被尝试。如果这也失败了，该<code>man</code>程序将被尝试。</p></div></div><div class="doc-postil"><div class="c-markdown"><h3>man.<tool>.path</h3></div></div><div class="doc-postil"><div class="c-markdown"><p>您可以通过设置配置变量，明确提供一个完整路径给您的首选人查看器<code>man.<tool>.path</code>。例如，您可以通过设置配置
|
||
|
||
konqueror 的绝对路径<code>man.konqueror.path</code>。否则，<code>git help</code>假定该工具在 PATH 中可用。</p></div></div><div class="doc-postil"><div class="c-markdown"><h3>man.<tool>.cmd</h3></div></div><div class="doc-postil"><div class="c-markdown"><p>当由<code>man.viewer</code>配置变量指定的 man 查看器不在支持的查看器中时，<code>man.<tool>.cmd</code>将查找相应的配置变量。如果此变量存在，那么指定的工具将被视为自定义命令，并且将使用 shell eval 来运行该命令，并将 man 页面作为参数传递。</p></div></div><div class="doc-postil"><div class="c-markdown"><h3>Note about konqueror</h3></div></div><div class="doc-postil"><div class="c-markdown"><p>当<code>konqueror</code>在<code>man.viewer</code>配置变量中指定时，我们启动<code>kfmclient</code>以尝试在可能的情况下在新选项卡上打开已打开的
|
||
|
||
konqueror 上的手册页。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>为了保持一致性，如果<code>man.konqueror.path</code>设置为类似的东西，我们也会尝试这种技巧<code>A_PATH_TO/konqueror</code>。这意味着我们将尝试启动<code>A_PATH_TO/kfmclient</code>。</p></div></div><div class="doc-postil"><div class="c-markdown"><p>如果你真的想使用<code>konqueror</code>，那么你可以使用类似下面的东西：</p></div></div><div class="doc-postil"><div class="c-markdown"><pre class="prism-token token language-javascript"> [man]
|
||
|
||
viewer = konq [man "konq"]
|
||
|
||
cmd = A_PATH_TO/konqueror</pre></div></div><div class="doc-postil"><div class="c-markdown"><h3>关于 git config --global 的说明</h3></div></div><div class="doc-postil"><div class="c-markdown"><p>请注意，所有这些配置变量都应该使用<code>--global</code>标志来设置，例如像这样：</p></div></div><div class="doc-postil"><div class="c-markdown"><pre class="prism-token token language-javascript">$ git config --global help.format web
|
||
|
||
$ git config --global web.browser firefox</pre></div></div><div class="doc-postil"><div class="c-markdown"><p>因为它们可能比特定于存储库的用户更具体。有关更多信息，请参阅 git-config [1]。</p></div></div></div> |