man1/git-web--browse.1

   1 '\" t
   2 .\"     Title: git-web--browse
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-19
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.267.gbb9c16bd4f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-WEB\-\-BROWSE" "1" "2024-08-19" "Git 2\&.46\&.0\&.267\&.gbb9c16" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-web--browse \- Git helper script to launch a web browser
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit web\-\-browse\fR [<options>] (<URL>|<file>)\&...\:
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 This script tries, as much as possible, to display the URLs and FILEs that are passed as arguments, as HTML pages in new tabs on an already opened web browser\&.
  40 .sp
  41 The following browsers (or commands) are currently supported:
  42 .sp
  43 .RS 4
  44 .ie n \{\
  45 \h'-04'\(bu\h'+03'\c
  46 .\}
  47 .el \{\
  48 .sp -1
  49 .IP \(bu 2.3
  50 .\}
  51 firefox (this is the default under X Window when not using KDE)
  52 .RE
  53 .sp
  54 .RS 4
  55 .ie n \{\
  56 \h'-04'\(bu\h'+03'\c
  57 .\}
  58 .el \{\
  59 .sp -1
  60 .IP \(bu 2.3
  61 .\}
  62 iceweasel
  63 .RE
  64 .sp
  65 .RS 4
  66 .ie n \{\
  67 \h'-04'\(bu\h'+03'\c
  68 .\}
  69 .el \{\
  70 .sp -1
  71 .IP \(bu 2.3
  72 .\}
  73 seamonkey
  74 .RE
  75 .sp
  76 .RS 4
  77 .ie n \{\
  78 \h'-04'\(bu\h'+03'\c
  79 .\}
  80 .el \{\
  81 .sp -1
  82 .IP \(bu 2.3
  83 .\}
  84 iceape
  85 .RE
  86 .sp
  87 .RS 4
  88 .ie n \{\
  89 \h'-04'\(bu\h'+03'\c
  90 .\}
  91 .el \{\
  92 .sp -1
  93 .IP \(bu 2.3
  94 .\}
  95 chromium (also supported as chromium\-browser)
  96 .RE
  97 .sp
  98 .RS 4
  99 .ie n \{\
 100 \h'-04'\(bu\h'+03'\c
 101 .\}
 102 .el \{\
 103 .sp -1
 104 .IP \(bu 2.3
 105 .\}
 106 google\-chrome (also supported as chrome)
 107 .RE
 108 .sp
 109 .RS 4
 110 .ie n \{\
 111 \h'-04'\(bu\h'+03'\c
 112 .\}
 113 .el \{\
 114 .sp -1
 115 .IP \(bu 2.3
 116 .\}
 117 konqueror (this is the default under KDE, see
 118 \fINote about konqueror\fR
 119 below)
 120 .RE
 121 .sp
 122 .RS 4
 123 .ie n \{\
 124 \h'-04'\(bu\h'+03'\c
 125 .\}
 126 .el \{\
 127 .sp -1
 128 .IP \(bu 2.3
 129 .\}
 130 opera
 131 .RE
 132 .sp
 133 .RS 4
 134 .ie n \{\
 135 \h'-04'\(bu\h'+03'\c
 136 .\}
 137 .el \{\
 138 .sp -1
 139 .IP \(bu 2.3
 140 .\}
 141 w3m (this is the default outside graphical environments)
 142 .RE
 143 .sp
 144 .RS 4
 145 .ie n \{\
 146 \h'-04'\(bu\h'+03'\c
 147 .\}
 148 .el \{\
 149 .sp -1
 150 .IP \(bu 2.3
 151 .\}
 152 elinks
 153 .RE
 154 .sp
 155 .RS 4
 156 .ie n \{\
 157 \h'-04'\(bu\h'+03'\c
 158 .\}
 159 .el \{\
 160 .sp -1
 161 .IP \(bu 2.3
 162 .\}
 163 links
 164 .RE
 165 .sp
 166 .RS 4
 167 .ie n \{\
 168 \h'-04'\(bu\h'+03'\c
 169 .\}
 170 .el \{\
 171 .sp -1
 172 .IP \(bu 2.3
 173 .\}
 174 lynx
 175 .RE
 176 .sp
 177 .RS 4
 178 .ie n \{\
 179 \h'-04'\(bu\h'+03'\c
 180 .\}
 181 .el \{\
 182 .sp -1
 183 .IP \(bu 2.3
 184 .\}
 185 dillo
 186 .RE
 187 .sp
 188 .RS 4
 189 .ie n \{\
 190 \h'-04'\(bu\h'+03'\c
 191 .\}
 192 .el \{\
 193 .sp -1
 194 .IP \(bu 2.3
 195 .\}
 196 open (this is the default under Mac OS X GUI)
 197 .RE
 198 .sp
 199 .RS 4
 200 .ie n \{\
 201 \h'-04'\(bu\h'+03'\c
 202 .\}
 203 .el \{\
 204 .sp -1
 205 .IP \(bu 2.3
 206 .\}
 207 start (this is the default under MinGW)
 208 .RE
 209 .sp
 210 .RS 4
 211 .ie n \{\
 212 \h'-04'\(bu\h'+03'\c
 213 .\}
 214 .el \{\
 215 .sp -1
 216 .IP \(bu 2.3
 217 .\}
 218 cygstart (this is the default under Cygwin)
 219 .RE
 220 .sp
 221 .RS 4
 222 .ie n \{\
 223 \h'-04'\(bu\h'+03'\c
 224 .\}
 225 .el \{\
 226 .sp -1
 227 .IP \(bu 2.3
 228 .\}
 229 xdg\-open
 230 .RE
 231 .sp
 232 Custom commands may also be specified\&.
 233 .SH "OPTIONS"
 234 .PP
 235 \-b <browser>, \-\-browser=<browser>
 236 .RS 4
 237 Use the specified browser\&. It must be in the list of supported browsers\&.
 238 .RE
 239 .PP
 240 \-t <browser>, \-\-tool=<browser>
 241 .RS 4
 242 Same as above\&.
 243 .RE
 244 .PP
 245 \-c <conf\&.var>, \-\-config=<conf\&.var>
 246 .RS 4
 247 CONF\&.VAR is looked up in the Git config files\&. If it\(cqs set, then its value specifies the browser that should be used\&.
 248 .RE
 249 .SH "CONFIGURATION VARIABLES"
 250 .SS "CONF\&.VAR (from \-c option) and web\&.browser"
 251 .sp
 252 The web browser can be specified using a configuration variable passed with the \-c (or \-\-config) command\-line option, or the \fBweb\&.browser\fR configuration variable if the former is not used\&.
 253 .SS "browser\&.<tool>\&.path"
 254 .sp
 255 You can explicitly provide a full path to your preferred browser by setting the configuration variable \fBbrowser\&.<tool>\&.path\fR\&. For example, you can configure the absolute path to firefox by setting \fIbrowser\&.firefox\&.path\fR\&. Otherwise, \fIgit web\-\-browse\fR assumes the tool is available in PATH\&.
 256 .SS "browser\&.<tool>\&.cmd"
 257 .sp
 258 When the browser, specified by options or configuration variables, is not among the supported ones, then the corresponding \fBbrowser\&.<tool>\&.cmd\fR configuration variable will be looked up\&. If this variable exists then \fIgit web\-\-browse\fR will treat the specified tool as a custom command and will use a shell eval to run the command with the URLs passed as arguments\&.
 259 .SH "NOTE ABOUT KONQUEROR"
 260 .sp
 261 When \fIkonqueror\fR is specified by a command\-line option or a configuration variable, we launch \fIkfmclient\fR to try to open the HTML man page on an already opened konqueror in a new tab if possible\&.
 262 .sp
 263 For consistency, we also try such a trick if \fIbrowser\&.konqueror\&.path\fR is set to something like \fBA_PATH_TO/konqueror\fR\&. That means we will try to launch \fBA_PATH_TO/kfmclient\fR instead\&.
 264 .sp
 265 If you really want to use \fIkonqueror\fR, then you can use something like the following:
 266 .sp
 267 .if n \{\
 268 .RS 4
 269 .\}
 270 .nf
 271         [web]
 272                 browser = konq
 273
 274         [browser "konq"]
 275                 cmd = A_PATH_TO/konqueror
 276 .fi
 277 .if n \{\
 278 .RE
 279 .\}
 280 .SS "Note about git\-config \-\-global"
 281 .sp
 282 Note that these configuration variables should probably be set using the \fB\-\-global\fR flag, for example like this:
 283 .sp
 284 .if n \{\
 285 .RS 4
 286 .\}
 287 .nf
 288 $ git config \-\-global web\&.browser firefox
 289 .fi
 290 .if n \{\
 291 .RE
 292 .\}
 293 .sp
 294 as they are probably more user specific than repository specific\&. See \fBgit-config\fR(1) for more information about this\&.
 295 .SH "GIT"
 296 .sp
 297 Part of the \fBgit\fR(1) suite