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

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