doc/source/en/TortoiseGit/git_doc/git-web--browse.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-web&#45;&#45;browse(1)">\r
   5 <articleinfo>\r
   6     <title>git-web&#45;&#45;browse(1)</title>\r
   7 <indexterm>\r
   8 <primary>git-web&#45;&#45;browse(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-web--browse - git helper script to launch a web browser</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git web&#45;&#45;browse</emphasis> [OPTIONS] URL/FILE &#8230;</literallayout>\r
  19 </blockquote>\r
  20 </simplesect>\r
  21 <simplesect id="_description">\r
  22 <title>DESCRIPTION</title>\r
  23 <simpara>This script tries, as much as possible, to display the URLs and FILEs\r
  24 that are passed as arguments, as HTML pages in new tabs on an already\r
  25 opened web browser.</simpara>\r
  26 <simpara>The following browsers (or commands) are currently supported:</simpara>\r
  27 <itemizedlist>\r
  28 <listitem>\r
  29 <simpara>\r
  30 firefox (this is the default under X Window when not using KDE)\r
  31 </simpara>\r
  32 </listitem>\r
  33 <listitem>\r
  34 <simpara>\r
  35 iceweasel\r
  36 </simpara>\r
  37 </listitem>\r
  38 <listitem>\r
  39 <simpara>\r
  40 seamonkey\r
  41 </simpara>\r
  42 </listitem>\r
  43 <listitem>\r
  44 <simpara>\r
  45 iceape\r
  46 </simpara>\r
  47 </listitem>\r
  48 <listitem>\r
  49 <simpara>\r
  50 chromium (also supported as chromium-browser)\r
  51 </simpara>\r
  52 </listitem>\r
  53 <listitem>\r
  54 <simpara>\r
  55 google-chrome (also supported as chrome)\r
  56 </simpara>\r
  57 </listitem>\r
  58 <listitem>\r
  59 <simpara>\r
  60 konqueror (this is the default under KDE, see <emphasis>Note about konqueror</emphasis> below)\r
  61 </simpara>\r
  62 </listitem>\r
  63 <listitem>\r
  64 <simpara>\r
  65 opera\r
  66 </simpara>\r
  67 </listitem>\r
  68 <listitem>\r
  69 <simpara>\r
  70 w3m (this is the default outside graphical environments)\r
  71 </simpara>\r
  72 </listitem>\r
  73 <listitem>\r
  74 <simpara>\r
  75 elinks\r
  76 </simpara>\r
  77 </listitem>\r
  78 <listitem>\r
  79 <simpara>\r
  80 links\r
  81 </simpara>\r
  82 </listitem>\r
  83 <listitem>\r
  84 <simpara>\r
  85 lynx\r
  86 </simpara>\r
  87 </listitem>\r
  88 <listitem>\r
  89 <simpara>\r
  90 dillo\r
  91 </simpara>\r
  92 </listitem>\r
  93 <listitem>\r
  94 <simpara>\r
  95 open (this is the default under Mac OS X GUI)\r
  96 </simpara>\r
  97 </listitem>\r
  98 <listitem>\r
  99 <simpara>\r
 100 start (this is the default under MinGW)\r
 101 </simpara>\r
 102 </listitem>\r
 103 </itemizedlist>\r
 104 <simpara>Custom commands may also be specified.</simpara>\r
 105 </simplesect>\r
 106 <simplesect id="_options">\r
 107 <title>OPTIONS</title>\r
 108 <variablelist>\r
 109 <varlistentry>\r
 110 <term>\r
 111 -b &lt;browser&gt;\r
 112 </term>\r
 113 <term>\r
 114 --browser=&lt;browser&gt;\r
 115 </term>\r
 116 <listitem>\r
 117 <simpara>\r
 118         Use the specified browser. It must be in the list of supported\r
 119         browsers.\r
 120 </simpara>\r
 121 </listitem>\r
 122 </varlistentry>\r
 123 <varlistentry>\r
 124 <term>\r
 125 -t &lt;browser&gt;\r
 126 </term>\r
 127 <term>\r
 128 --tool=&lt;browser&gt;\r
 129 </term>\r
 130 <listitem>\r
 131 <simpara>\r
 132         Same as above.\r
 133 </simpara>\r
 134 </listitem>\r
 135 </varlistentry>\r
 136 <varlistentry>\r
 137 <term>\r
 138 -c &lt;conf.var&gt;\r
 139 </term>\r
 140 <term>\r
 141 --config=&lt;conf.var&gt;\r
 142 </term>\r
 143 <listitem>\r
 144 <simpara>\r
 145         CONF.VAR is looked up in the git config files. If it's set,\r
 146         then its value specifies the browser that should be used.\r
 147 </simpara>\r
 148 </listitem>\r
 149 </varlistentry>\r
 150 </variablelist>\r
 151 </simplesect>\r
 152 <simplesect id="_configuration_variables">\r
 153 <title>CONFIGURATION VARIABLES</title>\r
 154 <section id="_conf_var_from_c_option_and_web_browser">\r
 155 <title>CONF.VAR (from -c option) and web.browser</title>\r
 156 <simpara>The web browser can be specified using a configuration variable passed\r
 157 with the -c (or --config) command line option, or the <emphasis>web.browser</emphasis>\r
 158 configuration variable if the former is not used.</simpara>\r
 159 </section>\r
 160 <section id="_browser_lt_tool_gt_path">\r
 161 <title>browser.&lt;tool&gt;.path</title>\r
 162 <simpara>You can explicitly provide a full path to your preferred browser by\r
 163 setting the configuration variable <emphasis>browser.&lt;tool&gt;.path</emphasis>. For example,\r
 164 you can configure the absolute path to firefox by setting\r
 165 <emphasis>browser.firefox.path</emphasis>. Otherwise, <emphasis>git web&#45;&#45;browse</emphasis> assumes the tool\r
 166 is available in PATH.</simpara>\r
 167 </section>\r
 168 <section id="_browser_lt_tool_gt_cmd">\r
 169 <title>browser.&lt;tool&gt;.cmd</title>\r
 170 <simpara>When the browser, specified by options or configuration variables, is\r
 171 not among the supported ones, then the corresponding\r
 172 <emphasis>browser.&lt;tool&gt;.cmd</emphasis> configuration variable will be looked up. If this\r
 173 variable exists then <emphasis>git web&#45;&#45;browse</emphasis> will treat the specified tool\r
 174 as a custom command and will use a shell eval to run the command with\r
 175 the URLs passed as arguments.</simpara>\r
 176 </section>\r
 177 </simplesect>\r
 178 <simplesect id="_note_about_konqueror">\r
 179 <title>Note about konqueror</title>\r
 180 <simpara>When <emphasis>konqueror</emphasis> is specified by a command line option or a\r
 181 configuration variable, we launch <emphasis>kfmclient</emphasis> to try to open the HTML\r
 182 man page on an already opened konqueror in a new tab if possible.</simpara>\r
 183 <simpara>For consistency, we also try such a trick if <emphasis>browser.konqueror.path</emphasis> is\r
 184 set to something like <emphasis>A_PATH_TO/konqueror</emphasis>. That means we will try to\r
 185 launch <emphasis>A_PATH_TO/kfmclient</emphasis> instead.</simpara>\r
 186 <simpara>If you really want to use <emphasis>konqueror</emphasis>, then you can use something like\r
 187 the following:</simpara>\r
 188 <screen>        [web]\r
 189                 browser = konq\r
 190 \r
 191         [browser "konq"]\r
 192                 cmd = A_PATH_TO/konqueror</screen>\r
 193 <section id="_note_about_git_config_global">\r
 194 <title>Note about git-config --global</title>\r
 195 <simpara>Note that these configuration variables should probably be set using\r
 196 the <emphasis>--global</emphasis> flag, for example like this:</simpara>\r
 197 <screen>$ git config --global web.browser firefox</screen>\r
 198 <simpara>as they are probably more user specific than repository specific.\r
 199 See <xref linkend="git-config(1)" /> for more information about this.</simpara>\r
 200 </section>\r
 201 </simplesect>\r
 202 <simplesect id="_git">\r
 203 <title>GIT</title>\r
 204 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 205 </simplesect>\r
 206 </article>\r