зеркало из https://github.com/microsoft/git.git
Documentation: add 'git-web--browse.txt' and simplify other docs.
'git-help.txt' and 'git-instaweb.txt' contained duplicated information about 'git-web--browse'. This patch puts this information where it belongs. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Родитель
8e08689959
Коммит
cb45f83cbd
|
@ -48,26 +48,8 @@ OPTIONS
|
|||
The web browser can be specified using the configuration variable
|
||||
'help.browser', or 'web.browser' if the former is not set. If none of
|
||||
these config variables is set, the 'git-web--browse' helper script
|
||||
(called by 'git-help') will pick a suitable default.
|
||||
+
|
||||
You can explicitly provide a full path to your preferred browser by
|
||||
setting the configuration variable 'browser.<tool>.path'. For example,
|
||||
you can configure the absolute path to firefox by setting
|
||||
'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
|
||||
is available in PATH.
|
||||
+
|
||||
Note that the script tries, as much as possible, to display the HTML
|
||||
page in a new tab on an already opened browser.
|
||||
+
|
||||
The following browsers are currently supported by 'git-web--browse':
|
||||
+
|
||||
* firefox (this is the default under X Window when not using KDE)
|
||||
* iceweasel
|
||||
* konqueror (this is the default under KDE)
|
||||
* w3m (this is the default outside X Window)
|
||||
* links
|
||||
* lynx
|
||||
* dillo
|
||||
(called by 'git-help') will pick a suitable default. See
|
||||
linkgit:git-web--browse[1] for more information about this.
|
||||
|
||||
CONFIGURATION VARIABLES
|
||||
-----------------------
|
||||
|
@ -84,7 +66,7 @@ line option:
|
|||
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.
|
||||
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:
|
||||
|
|
|
@ -40,21 +40,9 @@ OPTIONS
|
|||
-b|--browser::
|
||||
The web browser that should be used to view the gitweb
|
||||
page. This will be passed to the 'git-web--browse' helper
|
||||
script along with the URL of the gitweb instance. If the
|
||||
script fails, the URL will be printed to stdout.
|
||||
+
|
||||
Note that the 'git-web--browse' script tries, as much as possible, to
|
||||
display the HTML page in a new tab on an already opened browser.
|
||||
+
|
||||
The following browsers are currently supported by 'git-web--browse':
|
||||
+
|
||||
* firefox (this is the default under X Window when not using KDE)
|
||||
* iceweasel
|
||||
* konqueror (this is the default under KDE)
|
||||
* w3m (this is the default outside X Window)
|
||||
* links
|
||||
* lynx
|
||||
* dillo
|
||||
script along with the URL of the gitweb instance. See
|
||||
linkgit:git-web--browse[1] for more information about this. If
|
||||
the script fails, the URL will be printed to stdout.
|
||||
|
||||
--start::
|
||||
Start the httpd instance and exit. This does not generate
|
||||
|
@ -85,13 +73,8 @@ You may specify configuration in your .git/config
|
|||
-----------------------------------------------------------------------
|
||||
|
||||
If the configuration variable 'instaweb.browser' is not set,
|
||||
'web.browser' will be used instead if it is defined.
|
||||
|
||||
You can explicitly provide a full path to your preferred browser by
|
||||
setting the configuration variable 'browser.<tool>.path'. For example,
|
||||
you can configure the absolute path to firefox by setting
|
||||
'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
|
||||
is available in PATH.
|
||||
'web.browser' will be used instead if it is defined. See
|
||||
linkgit:git-web--browse[1] for more information about this.
|
||||
|
||||
Author
|
||||
------
|
||||
|
|
|
@ -0,0 +1,78 @@
|
|||
git-web--browse(1)
|
||||
==================
|
||||
|
||||
NAME
|
||||
----
|
||||
git-web--browse - git helper script to launch a web browser
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
'git-web--browse' [OPTIONS] URL/FILE ...
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
This script tries, as much as possible, to display the URLs and FILEs
|
||||
that are passed as arguments, as HTML pages in new tabs on an already
|
||||
opened web browser.
|
||||
|
||||
The following browsers (or commands) are currently supported:
|
||||
|
||||
* firefox (this is the default under X Window when not using KDE)
|
||||
* iceweasel
|
||||
* konqueror (this is the default under KDE)
|
||||
* w3m (this is the default outside graphical environments)
|
||||
* links
|
||||
* lynx
|
||||
* dillo
|
||||
* open (this is the default under Mac OS X GUI)
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
-b BROWSER|--browser=BROWSER::
|
||||
Use the specified BROWSER. It must be in the list of supported
|
||||
browsers.
|
||||
|
||||
-t BROWSER|--tool=BROWSER::
|
||||
Same as above.
|
||||
|
||||
-c CONF.VAR|--config=CONF.VAR::
|
||||
CONF.VAR is looked up in the git config files. If it's set,
|
||||
then its value specify the browser that should be used.
|
||||
|
||||
CONFIGURATION VARIABLES
|
||||
-----------------------
|
||||
|
||||
The web browser can be specified using a configuration variable passed
|
||||
with the -c (or --config) command line option, or the 'web.browser'
|
||||
configuration variable if the former is not used.
|
||||
|
||||
You can explicitly provide a full path to your preferred browser by
|
||||
setting the configuration variable 'browser.<tool>.path'. For example,
|
||||
you can configure the absolute path to firefox by setting
|
||||
'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
|
||||
is available in PATH.
|
||||
|
||||
Note that these configuration variables should probably be set using
|
||||
the '--global' flag, for example like this:
|
||||
|
||||
------------------------------------------------
|
||||
$ git config --global web.browser firefox
|
||||
------------------------------------------------
|
||||
|
||||
as they are probably more user specific than repository specific.
|
||||
See linkgit:git-config[1] for more information about this.
|
||||
|
||||
Author
|
||||
------
|
||||
Written by Christian Couder <chriscool@tuxfamily.org> and the git-list
|
||||
<git@vger.kernel.org>, based on git-mergetool by Theodore Y. Ts'o.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Documentation by Christian Couder <chriscool@tuxfamily.org> and the
|
||||
git-list <git@vger.kernel.org>.
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the linkgit:git[7] suite
|
Загрузка…
Ссылка в новой задаче