Fix a typo in surf manual.
[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 [-bBfFgGiIkKnNpPsSvx]
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 \-e xid
44 Reparents to window specified by
45 .I xid.
46 .TP
47 .B \-f
48 Run surf in fullscreen mode.
49 .TP
50 .B \-F
51 Disable to run in fullscreen by default.
52 .TP
53 .B \-g
54 Disable giving the geolocation to websites.
55 .TP
56 .B \-G
57 Enable giving the geolocation to websites.
58 .TP
59 .B \-i
60 Disable Images
61 .TP
62 .B \-I
63 Enable Images
64 .TP
65 .B \-k
66 Disable kiosk mode (disable key strokes and right click)
67 .TP
68 .B \-K
69 Enable kiosk mode (disable key strokes and right click)
70 .TP
71 .B \-n
72 Disable the Web Inspector (Developer Tools).
73 .TP
74 .B \-N
75 Enable the Web Inspector (Developer Tools).
76 .TP
77 .B \-p
78 Disable Plugins
79 .TP
80 .B \-P
81 Enable Plugins
82 .TP
83 .B \-r scriptfile 
84 Specify the user
85 .I scriptfile.
86 .TP
87 .B \-s
88 Disable Javascript
89 .TP
90 .B \-S
91 Enable Javascript
92 .TP
93 .B \-t stylefile
94 Specify the user
95 .I stylefile.
96 .TP
97 .B \-u useragent 
98 Specify the
99 .I useragent
100 which surf should use.
101 .TP
102 .B \-v
103 Prints version information to standard output, then exits.
104 .TP
105 .B \-x
106 Prints xid to standard output. This can be used to script the browser in for
107 example
108 .BR xdotool(1).
109 .TP
110 .B \-z zoomlevel 
111 Specify the
112 .I zoomlevel
113 which surf should use.
114 .BR xprop(1).
115 .SH USAGE
116 .B Escape
117 Stops loading current page or stops download.
118 .TP
119 .B Ctrl\-h
120 Walks back the history.
121 .TP
122 .B Ctrl\-l
123 Walks forward the history.
124 .TP
125 .B Ctrl\-k
126 Scrolls page upwards.
127 .TP
128 .B Ctrl\-j
129 Scrolls page downwards.
130 .TP
131 .B Ctrl\-b
132 Scroll up one whole page view.
133 .TP
134 .B Ctrl\-Space
135 Scroll down one whole page view.
136 .TP
137 .B Ctrl\-i
138 Scroll horizontally to the right.
139 .TP
140 .B Ctrl\-u
141 Scroll horizontally to the left.
142 .TP
143 .B Ctrl\-Shift\-k or Ctrl\-+
144 Zooms page in.
145 .TP
146 .B Ctrl\-Shift\-j or Ctrl\--
147 Zooms page out
148 .TP
149 .B Ctrl\-Shift\-q
150 Resets Zoom
151 .TP
152 .B Ctrl\-f and Ctrl\-/
153 Opens the search-bar.
154 .TP
155 .B Ctrl\-n
156 Go to next search result.
157 .TP
158 .B Ctrl\-Shift\-n
159 Go to previous search result.
160 .TP
161 .B Ctrl\-g
162 Opens the URL-bar (requires dmenu installed).
163 .TP
164 .B Ctrl\-p
165 Loads URI from primary selection.
166 .TP
167 .B Ctrl\-Shift\-p
168 Calls Printpage Dialog.
169 .TP
170 .B Ctrl\-r
171 Reloads the website.
172 .TP
173 .B Ctrl\-Shift\-r
174 Reloads the website without using the cache.
175 .TP
176 .B Ctrl\-y
177 Copies current URI to primary selection.
178 .TP
179 .B Ctrl\-o
180 Show the sourcecode of the current page.
181 .TP
182 .B Ctrl\-Shift\-a
183 Toggle through the the
184 .I cookie policies.
185 This will not reload the page.
186 .TP
187 .B Ctrl\-Shift\-b
188 Toggle scrollbars. This will reload the page.
189 .TP
190 .B Ctrl\-Shift\-c
191 Toggle caret browsing. This will reload the page.
192 .TP
193 .B Ctrl\-Shift\-i
194 Toggle auto-loading of images. This will reload the page.
195 .TP
196 .B Ctrl\-Shift\-m
197 Toggle if the
198 .I stylefile 
199 file should be loaded. This will reload the page.
200 .TP
201 .B Ctrl\-Shift\-o
202 Open the Web Inspector (Developer Tools) window for the current page.
203 .TP
204 .B Ctrl\-Shift\-s
205 Toggle script execution. This will reload the page.
206 .TP
207 .B Ctrl\-Shift\-v
208 Toggle the enabling of plugins on that surf instance. This will reload the
209 page.
210 .TP
211 .B F11
212 Toggle fullscreen mode.
213 .SH ENVIRONMENT
214 .B SURF_USERAGENT
215 If this variable is set upon startup, surf will use it as the
216 .I useragent
217 string
218 .TP
219 .B http_proxy
220 If this variable is set and not empty upon startup, surf will use it as the http proxy
221 .SH PLUGINS
222 For using plugins in surf, first determine your running architecture. Then get
223 the appropriate plugin for that architecture and copy it to
224 .BR /usr/lib/browser-plugins
225 or
226 .BR /usr/lib64/browser-plugins.
227 Surf should load them automatically.
228 .BR
229 If you want to use a 32bit plugin on a 64bit system,
230 .BR nspluginwrapper(1)
231 will help you.
232 .SH SEE ALSO
233 .BR dmenu(1),
234 .BR xprop(1),
235 .BR tabbed(1),
236 .BR nspluginwrapper(1),
237 .BR xdotool(1)
238 .SH BUGS
239 Please report them!