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