path: root/Documentation/git-web--browse.txt
diff options
Diffstat (limited to 'Documentation/git-web--browse.txt')
1 files changed, 78 insertions, 0 deletions
diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
new file mode 100644
index 0000000..df57d01
--- /dev/null
+++ b/Documentation/git-web--browse.txt
@@ -0,0 +1,78 @@
+git-web--browse - git helper script to launch a web browser
+'git-web--browse' [OPTIONS] URL/FILE ...
+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)
+-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.
+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.
+Written by Christian Couder <> and the git-list
+<>, based on git-mergetool by Theodore Y. Ts'o.
+Documentation by Christian Couder <> and the
+git-list <>.
+Part of the linkgit:git[7] suite