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