Documentation/git-web--browse.txt

   1 git-web--browse(1)
   2 ==================
   3
   4 NAME
   5 ----
   6 git-web--browse - git helper script to launch a web browser
   7
   8 SYNOPSIS
   9 --------
  10 'git-web--browse' [OPTIONS] URL/FILE ...
  11
  12 DESCRIPTION
  13 -----------
  14
  15 This script tries, as much as possible, to display the URLs and FILEs
  16 that are passed as arguments, as HTML pages in new tabs on an already
  17 opened web browser.
  18
  19 The 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)
  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
  30 OPTIONS
  31 -------
  32 -b BROWSER|--browser=BROWSER::
  33         Use the specified BROWSER. It must be in the list of supported
  34         browsers.
  35
  36 -t BROWSER|--tool=BROWSER::
  37         Same as above.
  38
  39 -c CONF.VAR|--config=CONF.VAR::
  40         CONF.VAR is looked up in the git config files. If it's set,
  41         then its value specify the browser that should be used.
  42
  43 CONFIGURATION VARIABLES
  44 -----------------------
  45
  46 The web browser can be specified using a configuration variable passed
  47 with the -c (or --config) command line option, or the 'web.browser'
  48 configuration variable if the former is not used.
  49
  50 You can explicitly provide a full path to your preferred browser by
  51 setting the configuration variable 'browser.<tool>.path'. For example,
  52 you can configure the absolute path to firefox by setting
  53 'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
  54 is available in PATH.
  55
  56 Note that these configuration variables should probably be set using
  57 the '--global' flag, for example like this:
  58
  59 ------------------------------------------------
  60 $ git config --global web.browser firefox
  61 ------------------------------------------------
  62
  63 as they are probably more user specific than repository specific.
  64 See linkgit:git-config[1] for more information about this.
  65
  66 Author
  67 ------
  68 Written by Christian Couder <chriscool@tuxfamily.org> and the git-list
  69 <git@vger.kernel.org>, based on git-mergetool by Theodore Y. Ts'o.
  70
  71 Documentation
  72 -------------
  73 Documentation by Christian Couder <chriscool@tuxfamily.org> and the
  74 git-list <git@vger.kernel.org>.
  75
  76 GIT
  77 ---
  78 Part of the linkgit:git[7] suite