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

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