src/chrome/app/resources/manpage.1.in

   1 ." This file is processed by chrome.gyp to generate manpages in the
   2 ." build diretory.
   3 .TH @@FILENAME@@ 1 "" "" "USER COMMANDS"
   4
   5 .SH NAME
   6 @@FILENAME@@ \- the web browser from Google
   7
   8 .SH SYNOPSIS
   9 .B @@FILENAME@@
  10 [\fIOPTION\fR] [\fIPATH\fR|\fIURL\fR]
  11
  12 .SH DESCRIPTION
  13 See the Google Chrome help center for help on using the browser.
  14 .IP
  15 <http://www.google.com/support/chrome/>
  16 .PP
  17 This manpage only describes invocation, environment, and arguments.
  18
  19 .SH OPTIONS
  20 @@NAME@@ has hundreds of undocumented command-line flags that are added
  21 and removed at the whim of the developers.  Here, we document relatively
  22 stable flags.
  23 .TP
  24 \fB\-\-user\-data\-dir\fR=\fIDIR\fR
  25 Specifies the directory that user data (your "profile") is kept in.
  26 Defaults to
  27 .I ~/.config/@@CONFDIR@@ .
  28 Separate instances of @@NAME@@ must use separate user data directories;
  29 repeated invocations of @@FILENAME@@ will reuse an existing process for
  30 a given user data directory.
  31
  32 .TP
  33 \fB\-\-app\fR=\fIURL\fR
  34 Runs
  35 .I URL
  36 in "app mode": with no browser toolbars.
  37
  38 .TP
  39 \fB\-\-incognito\fR
  40 Open in incognito mode.
  41
  42 .TP
  43 \fB\-\-proxy-server\fR=\fIhost:port\fR
  44 Specify the HTTP/SOCKS4/SOCKS5 proxy server to use for requests.  This
  45 overrides any environment variables or settings picked via the options dialog.
  46 An individual proxy server is specified using the format:
  47
  48   [<proxy-scheme>://]<proxy-host>[:<proxy-port>]
  49
  50 Where <proxy-scheme> is the protocol of the proxy server, and is one of:
  51
  52   "http", "socks", "socks4", "socks5".
  53
  54 If the <proxy-scheme> is omitted, it defaults to "http". Also note that
  55 "socks" is equivalent to "socks5".
  56
  57 Examples:
  58
  59   --proxy-server="foopy:99"
  60       Use the HTTP proxy "foopy:99" to load all URLs.
  61
  62   --proxy-server="socks://foobar:1080"
  63       Use the SOCKS v5 proxy "foobar:1080" to load all URLs.
  64
  65   --proxy-server="socks4://foobar:1080"
  66       Use the SOCKS v4 proxy "foobar:1080" to load all URLs.
  67
  68   --proxy-server="socks5://foobar:66"
  69       Use the SOCKS v5 proxy "foobar:66" to load all URLs.
  70
  71 It is also possible to specify a separate proxy server for different URL types,
  72 by prefixing the proxy server specifier with a URL specifier:
  73
  74 Example:
  75
  76   --proxy-server="https=proxy1:80;http=socks4://baz:1080"
  77       Load https://* URLs using the HTTP proxy "proxy1:80". And load http://*
  78       URLs using the SOCKS v4 proxy "baz:1080".
  79
  80 .TP
  81 \fB\-\-no-proxy-server\fR
  82 Disables the proxy server.  Overrides any environment variables or
  83 settings picked via the options dialog.
  84
  85 .TP
  86 \fB\-\-proxy-auto-detect\fR
  87 Autodetect proxy configuration.  Overrides any environment variables
  88 or settings picked via the options dialog.
  89
  90 .TP
  91 \fB\-\-proxy-pac-url\fR=\fIURL\fR
  92 Specify proxy autoconfiguration URL.  Overrides any environment variables
  93 or settings picked via the options dialog.
  94
  95 .TP
  96 \fB\-\-password-store\fR=<\fIbasic\fR|\fIgnome\fR|\fIkwallet\fR>
  97 Set the password store to use.  The default is to automatically detect based
  98 on the desktop environment.  \fIbasic\fR selects the built in, unencrypted
  99 password store.  \fIgnome\fR selects Gnome keyring.  \fIkwallet\fR selects
 100 (KDE) KWallet.  (Note that KWallet may not work reliably outside KDE.)
 101
 102 .TP
 103 \fB\-\-version\fR
 104 Show version information.
 105
 106 .PP
 107 As a GTK+ app, @@NAME@@ also obeys GTK+ command-line flags, such
 108 as
 109 .BR \-\-display .
 110 See the GTK documentation for more:
 111 .IP
 112 <http://library.gnome.org/devel/gtk/stable/gtk-running.html>
 113 <http://library.gnome.org/devel/gtk/stable/gtk-x11.html>
 114
 115 .SH ENVIRONMENT
 116 @@NAME@@ obeys the following environment variables:
 117
 118 .TP
 119 .B all_proxy
 120 Shorthand for specifying all of
 121 .B http_proxy, https_proxy, ftp_proxy
 122
 123 .TP
 124 .B http_proxy, https_proxy, ftp_proxy
 125 The proxy servers used for HTTP, HTTPS, and FTP.
 126 .I Note:
 127 because Gnome/KDE proxy settings may propagate into these variables
 128 in some terminals, this variable is ignored (in preference for actual
 129 system proxy settings) when running under Gnome or KDE.  Use the
 130 command-line flags to set these when you want to force their values.
 131
 132 .TP
 133 .B auto_proxy
 134 Specify proxy autoconfiguration.  Defined and empty autodetects; otherwise,
 135 it should be an autoconfig URL.  But see above note about Gnome/KDE.
 136
 137 .TP
 138 .B SOCKS_SERVER
 139 SOCKS proxy server (defaults to SOCKS v4, also set
 140 .B SOCKS_VERSION=5
 141 to use SOCKS v5).
 142
 143 .TP
 144 .B no_proxy
 145 Comma separated list of hosts or patterns to bypass proxying.
 146
 147 .SH FILES
 148 .TP
 149 .I ~/.config/@@CONFDIR@@
 150 Default directory for configuration data.
 151
 152 .TP
 153 .I ~/.cache/@@CONFDIR@@
 154 Default directory for cache data.  (Why?  See
 155 <http://standards.freedesktop.org/basedir-spec/latest/> .)
 156
 157 .SH BUGS
 158 Bug tracker:
 159 .IP
 160 http://code.google.com/p/chromium/issues/list
 161 .PP
 162 Be sure to do your search within "All Issues" before reporting bugs,
 163 and be sure to pick the "Defect on Linux" template when filing a new one.
 164
 165 .SH AUTHOR
 166 The Chromium team \- <http://www.chromium.org>