Rename SSL instances to TLS
[surf.git] / surf.1
1 .TH SURF 1 surf\-VERSION
2 .SH NAME
3 surf \- simple webkit-based browser
4 .SH SYNOPSIS
5 .B surf
6 .RB [-bBdDfFgGiIkKmMnNpPsSvx]
7 .RB [-a\ cookiepolicies]
8 .RB [-c\ cookiefile]
9 .RB [-e\ xid]
10 .RB [-r\ scriptfile]
11 .RB [-t\ stylefile]
12 .RB [-u\ useragent]
13 .RB [-z\ zoomlevel]
14 .RB "URI"
15 .SH DESCRIPTION
16 surf is a simple Web browser based on WebKit/GTK+. It is able
17 to display websites and follow links. It supports the XEmbed protocol
18 which makes it possible to embed it in another application. Furthermore,
19 one can point surf to another URI by setting its XProperties.
20 .SH OPTIONS
21 .TP
22 .B \-a cookiepolicies
23 Define the order of
24 .I cookie policies.
25 The default is "Aa@" but could be
26 redefined in the
27 .I config.h,
28 with "A" meaning to
29 accept all cookies, "a" to deny all cookies and "@", which tells surf to
30 accept no third party cookies.
31 .TP
32 .B \-b
33 Disable Scrollbars
34 .TP
35 .B \-B
36 Enable Scrollbars
37 .TP
38 .B \-c cookiefile 
39 Specify the
40 .I cookiefile
41 to use.
42 .TP
43 .B \-d
44 Disable the disk cache.
45 .TP
46 .B \-D
47 Enable the disk cache.
48 .TP
49 .B \-e xid
50 Reparents to window specified by
51 .I xid.
52 .TP
53 .B \-f
54 Start surf in windowed mode (not fullscreen).
55 .TP
56 .B \-F
57 Start surf in fullscreen mode.
58 .TP
59 .B \-g
60 Disable giving the geolocation to websites.
61 .TP
62 .B \-G
63 Enable giving the geolocation to websites.
64 .TP
65 .B \-i
66 Disable Images
67 .TP
68 .B \-I
69 Enable Images
70 .TP
71 .B \-k
72 Disable kiosk mode (disable key strokes and right click)
73 .TP
74 .B \-K
75 Enable kiosk mode (disable key strokes and right click)
76 .TP
77 .B \-m
78 Disable application of user style sheets.
79 .TP
80 .B \-M
81 Enable application of user style sheets.
82 .TP
83 .B \-n
84 Disable the Web Inspector (Developer Tools).
85 .TP
86 .B \-N
87 Enable the Web Inspector (Developer Tools).
88 .TP
89 .B \-p
90 Disable Plugins
91 .TP
92 .B \-P
93 Enable Plugins
94 .TP
95 .B \-r scriptfile 
96 Specify the user
97 .I scriptfile.
98 .TP
99 .B \-s
100 Disable Javascript
101 .TP
102 .B \-S
103 Enable Javascript
104 .TP
105 .B \-t stylefile
106 Specify the user
107 .I stylefile.
108 This does disable the site-specific styles.
109 .TP
110 .B \-u useragent 
111 Specify the
112 .I useragent
113 which surf should use.
114 .TP
115 .B \-v
116 Prints version information to standard output, then exits.
117 .TP
118 .B \-x
119 Prints xid to standard output. This can be used to script the browser in for
120 example
121 .BR xdotool(1).
122 .TP
123 .B \-z zoomlevel 
124 Specify the
125 .I zoomlevel
126 which surf should use.
127 .BR xprop(1).
128 .SH USAGE
129 .B Escape
130 Stops loading current page or stops download.
131 .TP
132 .B Ctrl\-h
133 Walks back the history.
134 .TP
135 .B Ctrl\-l
136 Walks forward the history.
137 .TP
138 .B Ctrl\-k
139 Scrolls page upwards.
140 .TP
141 .B Ctrl\-j
142 Scrolls page downwards.
143 .TP
144 .B Ctrl\-b
145 Scroll up one whole page view.
146 .TP
147 .B Ctrl\-Space
148 Scroll down one whole page view.
149 .TP
150 .B Ctrl\-i
151 Scroll horizontally to the right.
152 .TP
153 .B Ctrl\-u
154 Scroll horizontally to the left.
155 .TP
156 .B Ctrl\-Shift\-k or Ctrl\-+
157 Zooms page in.
158 .TP
159 .B Ctrl\-Shift\-j or Ctrl\--
160 Zooms page out
161 .TP
162 .B Ctrl\-Shift\-q
163 Resets Zoom
164 .TP
165 .B Ctrl\-f and Ctrl\-/
166 Opens the search-bar.
167 .TP
168 .B Ctrl\-n
169 Go to next search result.
170 .TP
171 .B Ctrl\-Shift\-n
172 Go to previous search result.
173 .TP
174 .B Ctrl\-g
175 Opens the URL-bar (requires dmenu installed).
176 .TP
177 .B Ctrl\-p
178 Loads URI from primary selection.
179 .TP
180 .B Ctrl\-Shift\-p
181 Calls Printpage Dialog.
182 .TP
183 .B Ctrl\-r
184 Reloads the website.
185 .TP
186 .B Ctrl\-Shift\-r
187 Reloads the website without using the cache.
188 .TP
189 .B Ctrl\-y
190 Copies current URI to primary selection.
191 .TP
192 .B Ctrl\-o
193 Show the sourcecode of the current page.
194 .TP
195 .B Ctrl\-Shift\-a
196 Toggle through the the
197 .I cookie policies.
198 This will not reload the page.
199 .TP
200 .B Ctrl\-Shift\-b
201 Toggle scrollbars. This will reload the page.
202 .TP
203 .B Ctrl\-Shift\-c
204 Toggle caret browsing. This will reload the page.
205 .TP
206 .B Ctrl\-Shift\-i
207 Toggle auto-loading of images. This will reload the page.
208 .TP
209 .B Ctrl\-Shift\-m
210 Toggle if the
211 .I stylefile 
212 file should be loaded. This will reload the page.
213 .TP
214 .B Ctrl\-Shift\-o
215 Open the Web Inspector (Developer Tools) window for the current page.
216 .TP
217 .B Ctrl\-Shift\-s
218 Toggle script execution. This will reload the page.
219 .TP
220 .B Ctrl\-Shift\-v
221 Toggle the enabling of plugins on that surf instance. This will reload the
222 page.
223 .TP
224 .B F11
225 Toggle fullscreen mode.
226 .SH INDICATORS OF OPERATION
227 Surf is showing indicators of operation in front of the site title.
228 For all indicators, unless otherwise specified, a lower case letter means disabled and an upper case letter means enabled.
229 .TP
230 .B A
231 all cookies accepted
232 .TP
233 .B a
234 no cookies accepted
235 .TP
236 .B @
237 all except third-party cookies accepted
238 .TP
239 .B c C
240 caret browsing
241 .TP
242 .B g G
243 geolocation
244 .TP
245 .B d D
246 disk cache
247 .TP
248 .B i I
249 images
250 .TP
251 .B s S
252 scripts
253 .TP
254 .B v V
255 plugins
256 .TP
257 .B m M
258 styles
259 .SH INDICATORS OF WEB PAGE
260 The second part of the indicators specifies modes of the web page itself.
261 .SS First character: encryption
262 .TP
263 .B -
264 unencrypted
265 .TP
266 .B T
267 encrypted (TLS)
268 .TP
269 .B U
270 attempted encryption but failed
271 .SS Second character: proxying
272 .TP
273 .B -
274 no proxy
275 .TP
276 .B P
277 using proxy
278 .SH ENVIRONMENT
279 .B SURF_USERAGENT
280 If this variable is set upon startup, surf will use it as the
281 .I useragent
282 string
283 .TP
284 .B http_proxy
285 If this variable is set and not empty upon startup, surf will use it as the http proxy
286 .SH PLUGINS
287 For using plugins in surf, first determine your running architecture. Then get
288 the appropriate plugin for that architecture and copy it to
289 .BR /usr/lib/browser-plugins
290 or
291 .BR /usr/lib64/browser-plugins.
292 Surf should load them automatically.
293 .BR
294 If you want to use a 32bit plugin on a 64bit system,
295 .BR nspluginwrapper(1)
296 will help you.
297 .SH SEE ALSO
298 .BR dmenu(1),
299 .BR xprop(1),
300 .BR tabbed(1),
301 .BR nspluginwrapper(1),
302 .BR xdotool(1)
303 .SH BUGS
304 Please report them!