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