Installing Git HTML help

his guide will help you install the local git HTML help files and set git to use them by default instead of the man pages.

Most git installations will install man files for help, but not the HTML help files (the same files seen on git's online documentation). Installing these help files is a fairly simple process.

Installing

To install web docs we simply need to clone the main git repo to the correct path and check out the "html" branch. Your documentation path may be different, pay attention to the output ofgit help --web commit for where your git is set to look for the HTML files.

git help --web commit# Attempt to open the html help for the commit command
# fatal: '/usr/local/git/share/doc/git-doc': not a documentation directory.

sudo mkdir -p /usr/local/git/share/doc# Create the path for the docs to be installed to
cd /usr/local/git/share/doc
$ sudo git clone git://git.kernel.org/pub/scm/git/git-htmldocs.git git-doc# Clone the git repo and check out the html documents branch

To verify that the web docs now work, run git help --web commit. If your browser launches then you're good to go. You can now set git to default to the web docs by runninggit config --global help.format web

Updating the docs

Updating is a simple matter of pulling:

$ cd /usr/local/git/share/doc/git-doc
$ sudo git pull

Nothing to see here folks...

Msysgit installs and sets the HTML help files as the default automatically. You don't need to do anything!

Installing

To install web docs we simply need to clone the main git repo to the correct path and check out the "html" branch. Your documentation path may be different, pay attention to the output ofgit help --web commit for where your git is set to look for the HTML files.

git help --web commit# Attempt to open the html help for the commit command
# fatal: '/usr/share/doc/git-doc': not a documentation directory.

sudo mkdir -p /usr/share/doc# Create the path for the docs to be installed to
cd /usr/share/doc
$ sudo git clone git://git.kernel.org/pub/scm/git/git-htmldocs.git git-doc# Clone the git repo and check out the html documents branch

To verify that the web docs now work, run git help --web commit. If your browser launches then you're good to go. You can now set git to default to the web docs by runninggit config --global help.format web

Updating the docs

Updating is a simple matter of pulling:

$ cd /usr/share/doc/git-doc
$ sudo git pull


转载:https://help.github.com/articles/installing-git-html-help#platform-linux


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值