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