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