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