Documentation / git-web--browse.txton commit Merge branch 'ml/cygwin-updates' (f01723a)
   1git-web{litdd}browse(1)
   2=======================
   3
   4NAME
   5----
   6git-web--browse - Git helper script to launch a web browser
   7
   8SYNOPSIS
   9--------
  10[verse]
  11'git web{litdd}browse' [OPTIONS] URL/FILE ...
  12
  13DESCRIPTION
  14-----------
  15
  16This script tries, as much as possible, to display the URLs and FILEs
  17that are passed as arguments, as HTML pages in new tabs on an already
  18opened web browser.
  19
  20The following browsers (or commands) are currently supported:
  21
  22* firefox (this is the default under X Window when not using KDE)
  23* iceweasel
  24* seamonkey
  25* iceape
  26* chromium (also supported as chromium-browser)
  27* google-chrome (also supported as chrome)
  28* konqueror (this is the default under KDE, see 'Note about konqueror' below)
  29* opera
  30* w3m (this is the default outside graphical environments)
  31* elinks
  32* links
  33* lynx
  34* dillo
  35* open (this is the default under Mac OS X GUI)
  36* start (this is the default under MinGW)
  37* cygstart (this is the default under Cygwin)
  38
  39Custom commands may also be specified.
  40
  41OPTIONS
  42-------
  43-b <browser>::
  44--browser=<browser>::
  45        Use the specified browser. It must be in the list of supported
  46        browsers.
  47
  48-t <browser>::
  49--tool=<browser>::
  50        Same as above.
  51
  52-c <conf.var>::
  53--config=<conf.var>::
  54        CONF.VAR is looked up in the Git config files. If it's set,
  55        then its value specifies the browser that should be used.
  56
  57CONFIGURATION VARIABLES
  58-----------------------
  59
  60CONF.VAR (from -c option) and web.browser
  61~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62
  63The web browser can be specified using a configuration variable passed
  64with the -c (or --config) command line option, or the 'web.browser'
  65configuration variable if the former is not used.
  66
  67browser.<tool>.path
  68~~~~~~~~~~~~~~~~~~~
  69
  70You can explicitly provide a full path to your preferred browser by
  71setting the configuration variable 'browser.<tool>.path'. For example,
  72you can configure the absolute path to firefox by setting
  73'browser.firefox.path'. Otherwise, 'git web{litdd}browse' assumes the tool
  74is available in PATH.
  75
  76browser.<tool>.cmd
  77~~~~~~~~~~~~~~~~~~
  78
  79When the browser, specified by options or configuration variables, is
  80not among the supported ones, then the corresponding
  81'browser.<tool>.cmd' configuration variable will be looked up. If this
  82variable exists then 'git web{litdd}browse' will treat the specified tool
  83as a custom command and will use a shell eval to run the command with
  84the URLs passed as arguments.
  85
  86Note about konqueror
  87--------------------
  88
  89When 'konqueror' is specified by a command line option or a
  90configuration variable, we launch 'kfmclient' to try to open the HTML
  91man page on an already opened konqueror in a new tab if possible.
  92
  93For consistency, we also try such a trick if 'browser.konqueror.path' is
  94set to something like 'A_PATH_TO/konqueror'. That means we will try to
  95launch 'A_PATH_TO/kfmclient' instead.
  96
  97If you really want to use 'konqueror', then you can use something like
  98the following:
  99
 100------------------------------------------------
 101        [web]
 102                browser = konq
 103
 104        [browser "konq"]
 105                cmd = A_PATH_TO/konqueror
 106------------------------------------------------
 107
 108Note about git-config --global
 109~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 110
 111Note that these configuration variables should probably be set using
 112the '--global' flag, for example like this:
 113
 114------------------------------------------------
 115$ git config --global web.browser firefox
 116------------------------------------------------
 117
 118as they are probably more user specific than repository specific.
 119See linkgit:git-config[1] for more information about this.
 120
 121GIT
 122---
 123Part of the linkgit:git[1] suite