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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-06-01
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.41.0
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-WEB\-\-BROWSE" "1" "2023\-06\-01" "Git 2\&.41\&.0" "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 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 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\&.
  41 .sp
  42 The following browsers (or commands) are currently supported:
  43 .sp
  44 .RS 4
  45 .ie n \{\
  46 \h'-04'\(bu\h'+03'\c
  47 .\}
  48 .el \{\
  49 .sp -1
  50 .IP \(bu 2.3
  51 .\}
  52 firefox (this is the default under X Window when not using KDE)
  53 .RE
  54 .sp
  55 .RS 4
  56 .ie n \{\
  57 \h'-04'\(bu\h'+03'\c
  58 .\}
  59 .el \{\
  60 .sp -1
  61 .IP \(bu 2.3
  62 .\}
  63 iceweasel
  64 .RE
  65 .sp
  66 .RS 4
  67 .ie n \{\
  68 \h'-04'\(bu\h'+03'\c
  69 .\}
  70 .el \{\
  71 .sp -1
  72 .IP \(bu 2.3
  73 .\}
  74 seamonkey
  75 .RE
  76 .sp
  77 .RS 4
  78 .ie n \{\
  79 \h'-04'\(bu\h'+03'\c
  80 .\}
  81 .el \{\
  82 .sp -1
  83 .IP \(bu 2.3
  84 .\}
  85 iceape
  86 .RE
  87 .sp
  88 .RS 4
  89 .ie n \{\
  90 \h'-04'\(bu\h'+03'\c
  91 .\}
  92 .el \{\
  93 .sp -1
  94 .IP \(bu 2.3
  95 .\}
  96 chromium (also supported as chromium\-browser)
  97 .RE
  98 .sp
  99 .RS 4
 100 .ie n \{\
 101 \h'-04'\(bu\h'+03'\c
 102 .\}
 103 .el \{\
 104 .sp -1
 105 .IP \(bu 2.3
 106 .\}
 107 google\-chrome (also supported as chrome)
 108 .RE
 109 .sp
 110 .RS 4
 111 .ie n \{\
 112 \h'-04'\(bu\h'+03'\c
 113 .\}
 114 .el \{\
 115 .sp -1
 116 .IP \(bu 2.3
 117 .\}
 118 konqueror (this is the default under KDE, see
 119 \fINote about konqueror\fR
 120 below)
 121 .RE
 122 .sp
 123 .RS 4
 124 .ie n \{\
 125 \h'-04'\(bu\h'+03'\c
 126 .\}
 127 .el \{\
 128 .sp -1
 129 .IP \(bu 2.3
 130 .\}
 131 opera
 132 .RE
 133 .sp
 134 .RS 4
 135 .ie n \{\
 136 \h'-04'\(bu\h'+03'\c
 137 .\}
 138 .el \{\
 139 .sp -1
 140 .IP \(bu 2.3
 141 .\}
 142 w3m (this is the default outside graphical environments)
 143 .RE
 144 .sp
 145 .RS 4
 146 .ie n \{\
 147 \h'-04'\(bu\h'+03'\c
 148 .\}
 149 .el \{\
 150 .sp -1
 151 .IP \(bu 2.3
 152 .\}
 153 elinks
 154 .RE
 155 .sp
 156 .RS 4
 157 .ie n \{\
 158 \h'-04'\(bu\h'+03'\c
 159 .\}
 160 .el \{\
 161 .sp -1
 162 .IP \(bu 2.3
 163 .\}
 164 links
 165 .RE
 166 .sp
 167 .RS 4
 168 .ie n \{\
 169 \h'-04'\(bu\h'+03'\c
 170 .\}
 171 .el \{\
 172 .sp -1
 173 .IP \(bu 2.3
 174 .\}
 175 lynx
 176 .RE
 177 .sp
 178 .RS 4
 179 .ie n \{\
 180 \h'-04'\(bu\h'+03'\c
 181 .\}
 182 .el \{\
 183 .sp -1
 184 .IP \(bu 2.3
 185 .\}
 186 dillo
 187 .RE
 188 .sp
 189 .RS 4
 190 .ie n \{\
 191 \h'-04'\(bu\h'+03'\c
 192 .\}
 193 .el \{\
 194 .sp -1
 195 .IP \(bu 2.3
 196 .\}
 197 open (this is the default under Mac OS X GUI)
 198 .RE
 199 .sp
 200 .RS 4
 201 .ie n \{\
 202 \h'-04'\(bu\h'+03'\c
 203 .\}
 204 .el \{\
 205 .sp -1
 206 .IP \(bu 2.3
 207 .\}
 208 start (this is the default under MinGW)
 209 .RE
 210 .sp
 211 .RS 4
 212 .ie n \{\
 213 \h'-04'\(bu\h'+03'\c
 214 .\}
 215 .el \{\
 216 .sp -1
 217 .IP \(bu 2.3
 218 .\}
 219 cygstart (this is the default under Cygwin)
 220 .RE
 221 .sp
 222 .RS 4
 223 .ie n \{\
 224 \h'-04'\(bu\h'+03'\c
 225 .\}
 226 .el \{\
 227 .sp -1
 228 .IP \(bu 2.3
 229 .\}
 230 xdg\-open
 231 .RE
 232 .sp
 233 Custom commands may also be specified\&.
 234 .SH "OPTIONS"
 235 .PP
 236 \-b <browser>, \-\-browser=<browser>
 237 .RS 4
 238 Use the specified browser\&. It must be in the list of supported browsers\&.
 239 .RE
 240 .PP
 241 \-t <browser>, \-\-tool=<browser>
 242 .RS 4
 243 Same as above\&.
 244 .RE
 245 .PP
 246 \-c <conf\&.var>, \-\-config=<conf\&.var>
 247 .RS 4
 248 CONF\&.VAR is looked up in the Git config files\&. If it\(cqs set, then its value specifies the browser that should be used\&.
 249 .RE
 250 .SH "CONFIGURATION VARIABLES"
 251 .SS "CONF\&.VAR (from \-c option) and web\&.browser"
 252 .sp
 253 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\&.
 254 .SS "browser\&.<tool>\&.path"
 255 .sp
 256 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\&.
 257 .SS "browser\&.<tool>\&.cmd"
 258 .sp
 259 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\&.
 260 .SH "NOTE ABOUT KONQUEROR"
 261 .sp
 262 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\&.
 263 .sp
 264 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\&.
 265 .sp
 266 If you really want to use \fIkonqueror\fR, then you can use something like the following:
 267 .sp
 268 .if n \{\
 269 .RS 4
 270 .\}
 271 .nf
 272         [web]
 273                 browser = konq
 274
 275         [browser "konq"]
 276                 cmd = A_PATH_TO/konqueror
 277 .fi
 278 .if n \{\
 279 .RE
 280 .\}
 281 .sp
 282 .SS "Note about git\-config \-\-global"
 283 .sp
 284 Note that these configuration variables should probably be set using the \fB\-\-global\fR flag, for example like this:
 285 .sp
 286 .if n \{\
 287 .RS 4
 288 .\}
 289 .nf
 290 $ git config \-\-global web\&.browser firefox
 291 .fi
 292 .if n \{\
 293 .RE
 294 .\}
 295 .sp
 296 .sp
 297 as they are probably more user specific than repository specific\&. See \fBgit-config\fR(1) for more information about this\&.
 298 .SH "GIT"
 299 .sp
 300 Part of the \fBgit\fR(1) suite