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