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