Documentation / git-web--browse.txton commit Merge branch 'jk/alt-odb-cleanup' (0538b84)
   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* xdg-open
  39
  40Custom commands may also be specified.
  41
  42OPTIONS
  43-------
  44-b <browser>::
  45--browser=<browser>::
  46        Use the specified browser. It must be in the list of supported
  47        browsers.
  48
  49-t <browser>::
  50--tool=<browser>::
  51        Same as above.
  52
  53-c <conf.var>::
  54--config=<conf.var>::
  55        CONF.VAR is looked up in the Git config files. If it's set,
  56        then its value specifies the browser that should be used.
  57
  58CONFIGURATION VARIABLES
  59-----------------------
  60
  61CONF.VAR (from -c option) and web.browser
  62~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63
  64The web browser can be specified using a configuration variable passed
  65with the -c (or --config) command-line option, or the `web.browser`
  66configuration variable if the former is not used.
  67
  68browser.<tool>.path
  69~~~~~~~~~~~~~~~~~~~
  70
  71You can explicitly provide a full path to your preferred browser by
  72setting the configuration variable `browser.<tool>.path`. For example,
  73you can configure the absolute path to firefox by setting
  74'browser.firefox.path'. Otherwise, 'git web{litdd}browse' assumes the tool
  75is available in PATH.
  76
  77browser.<tool>.cmd
  78~~~~~~~~~~~~~~~~~~
  79
  80When the browser, specified by options or configuration variables, is
  81not among the supported ones, then the corresponding
  82`browser.<tool>.cmd` configuration variable will be looked up. If this
  83variable exists then 'git web{litdd}browse' will treat the specified tool
  84as a custom command and will use a shell eval to run the command with
  85the URLs passed as arguments.
  86
  87Note about konqueror
  88--------------------
  89
  90When 'konqueror' is specified by a command-line option or a
  91configuration variable, we launch 'kfmclient' to try to open the HTML
  92man page on an already opened konqueror in a new tab if possible.
  93
  94For consistency, we also try such a trick if 'browser.konqueror.path' is
  95set to something like 'A_PATH_TO/konqueror'. That means we will try to
  96launch 'A_PATH_TO/kfmclient' instead.
  97
  98If you really want to use 'konqueror', then you can use something like
  99the following:
 100
 101------------------------------------------------
 102        [web]
 103                browser = konq
 104
 105        [browser "konq"]
 106                cmd = A_PATH_TO/konqueror
 107------------------------------------------------
 108
 109Note about git-config --global
 110~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 111
 112Note that these configuration variables should probably be set using
 113the `--global` flag, for example like this:
 114
 115------------------------------------------------
 116$ git config --global web.browser firefox
 117------------------------------------------------
 118
 119as they are probably more user specific than repository specific.
 120See linkgit:git-config[1] for more information about this.
 121
 122GIT
 123---
 124Part of the linkgit:git[1] suite