Fix possible oob access of cmd in newwindow()
[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 \-x
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 \-z zoomlevel 
130 Specify the
131 .I zoomlevel
132 which surf should use.
133 .BR xprop(1).
134 .SH USAGE
135 .B Escape
136 Stops loading current page or stops download.
137 .TP
138 .B Ctrl\-h
139 Walks back the history.
140 .TP
141 .B Ctrl\-l
142 Walks forward the history.
143 .TP
144 .B Ctrl\-k
145 Scrolls page upwards.
146 .TP
147 .B Ctrl\-j
148 Scrolls page downwards.
149 .TP
150 .B Ctrl\-b
151 Scroll up one whole page view.
152 .TP
153 .B Ctrl\-Space
154 Scroll down one whole page view.
155 .TP
156 .B Ctrl\-i
157 Scroll horizontally to the right.
158 .TP
159 .B Ctrl\-u
160 Scroll horizontally to the left.
161 .TP
162 .B Ctrl\-Shift\-k or Ctrl\-+
163 Zooms page in.
164 .TP
165 .B Ctrl\-Shift\-j or Ctrl\--
166 Zooms page out
167 .TP
168 .B Ctrl\-Shift\-q
169 Resets Zoom
170 .TP
171 .B Ctrl\-f and Ctrl\-/
172 Opens the search-bar.
173 .TP
174 .B Ctrl\-n
175 Go to next search result.
176 .TP
177 .B Ctrl\-Shift\-n
178 Go to previous search result.
179 .TP
180 .B Ctrl\-g
181 Opens the URL-bar (requires dmenu installed).
182 .TP
183 .B Ctrl\-p
184 Loads URI from primary selection.
185 .TP
186 .B Ctrl\-Shift\-p
187 Calls Printpage Dialog.
188 .TP
189 .B Ctrl\-r
190 Reloads the website.
191 .TP
192 .B Ctrl\-Shift\-r
193 Reloads the website without using the cache.
194 .TP
195 .B Ctrl\-y
196 Copies current URI to primary selection.
197 .TP
198 .B Ctrl\-o
199 Show the sourcecode of the current page.
200 .TP
201 .B Ctrl\-Shift\-a
202 Toggle through the the
203 .I cookie policies.
204 This will not reload the page.
205 .TP
206 .B Ctrl\-Shift\-b
207 Toggle scrollbars. This will reload the page.
208 .TP
209 .B Ctrl\-Shift\-c
210 Toggle caret browsing. This will reload the page.
211 .TP
212 .B Ctrl\-Shift\-i
213 Toggle auto-loading of images. This will reload the page.
214 .TP
215 .B Ctrl\-Shift\-m
216 Toggle if the
217 .I stylefile 
218 file should be loaded. This will reload the page.
219 .TP
220 .B Ctrl\-Shift\-o
221 Open the Web Inspector (Developer Tools) window for the current page.
222 .TP
223 .B Ctrl\-Shift\-s
224 Toggle script execution. This will reload the page.
225 .TP
226 .B Ctrl\-Shift\-t
227 Toggle strict TLS check. This will reload the page.
228 .TP
229 .B Ctrl\-Shift\-v
230 Toggle the enabling of plugins on that surf instance. This will reload the
231 page.
232 .TP
233 .B F11
234 Toggle fullscreen mode.
235 .SH INDICATORS OF OPERATION
236 Surf is showing indicators of operation in front of the site title.
237 For all indicators, unless otherwise specified, a lower case letter means disabled and an upper case letter means enabled.
238 .TP
239 .B A
240 all cookies accepted
241 .TP
242 .B a
243 no cookies accepted
244 .TP
245 .B @
246 all except third-party cookies accepted
247 .TP
248 .B c C
249 caret browsing
250 .TP
251 .B g G
252 geolocation
253 .TP
254 .B d D
255 disk cache
256 .TP
257 .B i I
258 images
259 .TP
260 .B s S
261 scripts
262 .TP
263 .B v V
264 plugins
265 .TP
266 .B m M
267 styles
268 .SH INDICATORS OF WEB PAGE
269 The second part of the indicators specifies modes of the web page itself.
270 .SS First character: encryption
271 .TP
272 .B -
273 unencrypted
274 .TP
275 .B T
276 encrypted (TLS)
277 .TP
278 .B U
279 attempted encryption but failed
280 .SS Second character: proxying
281 .TP
282 .B -
283 no proxy
284 .TP
285 .B P
286 using proxy
287 .SH ENVIRONMENT
288 .B SURF_USERAGENT
289 If this variable is set upon startup, surf will use it as the
290 .I useragent
291 string
292 .TP
293 .B http_proxy
294 If this variable is set and not empty upon startup, surf will use it as the http proxy
295 .SH PLUGINS
296 For using plugins in surf, first determine your running architecture. Then get
297 the appropriate plugin for that architecture and copy it to
298 .BR /usr/lib/browser-plugins
299 or
300 .BR /usr/lib64/browser-plugins.
301 Surf should load them automatically.
302 .BR
303 If you want to use a 32bit plugin on a 64bit system,
304 .BR nspluginwrapper(1)
305 will help you.
306 .SH SEE ALSO
307 .BR dmenu(1),
308 .BR xprop(1),
309 .BR tabbed(1),
310 .BR nspluginwrapper(1),
311 .BR xdotool(1)
312 .SH BUGS
313 Please report them!