Documentation/git-web--browse.txt

   1 git-web{litdd}browse(1)
   2 =======================
   3
   4 NAME
   5 ----
   6 git-web--browse - git helper script to launch a web browser
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git web{litdd}browse' [OPTIONS] URL/FILE ...
  12
  13 DESCRIPTION
  14 -----------
  15
  16 This script tries, as much as possible, to display the URLs and FILEs
  17 that are passed as arguments, as HTML pages in new tabs on an already
  18 opened web browser.
  19
  20 The 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
  38 Custom commands may also be specified.
  39
  40 OPTIONS
  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
  56 CONFIGURATION VARIABLES
  57 -----------------------
  58
  59 CONF.VAR (from -c option) and web.browser
  60 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  61
  62 The web browser can be specified using a configuration variable passed
  63 with the -c (or --config) command line option, or the 'web.browser'
  64 configuration variable if the former is not used.
  65
  66 browser.<tool>.path
  67 ~~~~~~~~~~~~~~~~~~~
  68
  69 You can explicitly provide a full path to your preferred browser by
  70 setting the configuration variable 'browser.<tool>.path'. For example,
  71 you can configure the absolute path to firefox by setting
  72 'browser.firefox.path'. Otherwise, 'git web--browse' assumes the tool
  73 is available in PATH.
  74
  75 browser.<tool>.cmd
  76 ~~~~~~~~~~~~~~~~~~
  77
  78 When the browser, specified by options or configuration variables, is
  79 not among the supported ones, then the corresponding
  80 'browser.<tool>.cmd' configuration variable will be looked up. If this
  81 variable exists then 'git web{litdd}browse' will treat the specified tool
  82 as a custom command and will use a shell eval to run the command with
  83 the URLs passed as arguments.
  84
  85 Note about konqueror
  86 --------------------
  87
  88 When 'konqueror' is specified by a command line option or a
  89 configuration variable, we launch 'kfmclient' to try to open the HTML
  90 man page on an already opened konqueror in a new tab if possible.
  91
  92 For consistency, we also try such a trick if 'browser.konqueror.path' is
  93 set to something like 'A_PATH_TO/konqueror'. That means we will try to
  94 launch 'A_PATH_TO/kfmclient' instead.
  95
  96 If you really want to use 'konqueror', then you can use something like
  97 the following:
  98
  99 ------------------------------------------------
 100         [web]
 101                 browser = konq
 102
 103         [browser "konq"]
 104                 cmd = A_PATH_TO/konqueror
 105 ------------------------------------------------
 106
 107 Note about git-config --global
 108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 109
 110 Note that these configuration variables should probably be set using
 111 the '--global' flag, for example like this:
 112
 113 ------------------------------------------------
 114 $ git config --global web.browser firefox
 115 ------------------------------------------------
 116
 117 as they are probably more user specific than repository specific.
 118 See linkgit:git-config[1] for more information about this.
 119
 120 GIT
 121 ---
 122 Part of the linkgit:git[1] suite