Documentation / git-web--browse.txton commit Documentation: improve "add", "pull" and "format-patch" examples (921177f)
   1git-web--browse(1)
   2==================
   3
   4NAME
   5----
   6git-web--browse - git helper script to launch a web browser
   7
   8SYNOPSIS
   9--------
  10'git-web--browse' [OPTIONS] URL/FILE ...
  11
  12DESCRIPTION
  13-----------
  14
  15This script tries, as much as possible, to display the URLs and FILEs
  16that are passed as arguments, as HTML pages in new tabs on an already
  17opened web browser.
  18
  19The following browsers (or commands) are currently supported:
  20
  21* firefox (this is the default under X Window when not using KDE)
  22* iceweasel
  23* konqueror (this is the default under KDE)
  24* w3m (this is the default outside graphical environments)
  25* links
  26* lynx
  27* dillo
  28* open (this is the default under Mac OS X GUI)
  29
  30Custom commands may also be specified.
  31
  32OPTIONS
  33-------
  34-b BROWSER|--browser=BROWSER::
  35        Use the specified BROWSER. It must be in the list of supported
  36        browsers.
  37
  38-t BROWSER|--tool=BROWSER::
  39        Same as above.
  40
  41-c CONF.VAR|--config=CONF.VAR::
  42        CONF.VAR is looked up in the git config files. If it's set,
  43        then its value specify the browser that should be used.
  44
  45CONFIGURATION VARIABLES
  46-----------------------
  47
  48CONF.VAR (from -c option) and web.browser
  49~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51The web browser can be specified using a configuration variable passed
  52with the -c (or --config) command line option, or the 'web.browser'
  53configuration variable if the former is not used.
  54
  55browser.<tool>.path
  56~~~~~~~~~~~~~~~~~~~
  57
  58You can explicitly provide a full path to your preferred browser by
  59setting the configuration variable 'browser.<tool>.path'. For example,
  60you can configure the absolute path to firefox by setting
  61'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
  62is available in PATH.
  63
  64browser.<tool>.cmd
  65~~~~~~~~~~~~~~~~~~
  66
  67When the browser, specified by options or configuration variables, is
  68not among the supported ones, then the corresponding
  69'browser.<tool>.cmd' configuration variable will be looked up. If this
  70variable exists then "git web--browse" will treat the specified tool
  71as a custom command and will use a shell eval to run the command with
  72the URLs passed as arguments.
  73
  74Note about git config --global
  75~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  76
  77Note that these configuration variables should probably be set using
  78the '--global' flag, for example like this:
  79
  80------------------------------------------------
  81$ git config --global web.browser firefox
  82------------------------------------------------
  83
  84as they are probably more user specific than repository specific.
  85See linkgit:git-config[1] for more information about this.
  86
  87Author
  88------
  89Written by Christian Couder <chriscool@tuxfamily.org> and the git-list
  90<git@vger.kernel.org>, based on git-mergetool by Theodore Y. Ts'o.
  91
  92Documentation
  93-------------
  94Documentation by Christian Couder <chriscool@tuxfamily.org> and the
  95git-list <git@vger.kernel.org>.
  96
  97GIT
  98---
  99Part of the linkgit:git[7] suite