Add a way to define the cookie policy.
[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 all 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 by using
107 .TP
108 .B \-z zoomlevel 
109 Specify the
110 .I zoomlevel
111 which surf should use.
112 .BR xprop(1).
113 .SH USAGE
114 .B Escape
115 Stops loading current page or stops download.
116 .TP
117 .B Ctrl\-h
118 Walks back the history.
119 .TP
120 .B Ctrl\-l
121 Walks forward the history.
122 .TP
123 .B Ctrl\-k
124 Scrolls page upwards.
125 .TP
126 .B Ctrl\-j
127 Scrolls page downwards.
128 .TP
129 .B Ctrl\-b
130 Scroll up one whole page view.
131 .TP
132 .B Ctrl\-Space
133 Scroll down one whole page view.
134 .TP
135 .B Ctrl\-i
136 Scroll horizontally to the right.
137 .TP
138 .B Ctrl\-u
139 Scroll horizontally to the left.
140 .TP
141 .B Ctrl\-Shift\-k or Ctrl\-+
142 Zooms page in.
143 .TP
144 .B Ctrl\-Shift\-j or Ctrl\--
145 Zooms page out
146 .TP
147 .B Ctrl\-Shift\-q
148 Resets Zoom
149 .TP
150 .B Ctrl\-f and Ctrl\-\e
151 Opens the search-bar.
152 .TP
153 .B Ctrl\-n
154 Go to next search result.
155 .TP
156 .B Ctrl\-Shift\-n
157 Go to previous search result.
158 .TP
159 .B Ctrl\-g
160 Opens the URL-bar.
161 .TP
162 .B Ctrl\-p
163 Loads URI from primary selection.
164 .TP
165 .B Ctrl\-Shift\-p
166 Calls Printpage Dialog.
167 .TP
168 .B Ctrl\-r
169 Reloads the website.
170 .TP
171 .B Ctrl\-Shift\-r
172 Reloads the website without using the cache.
173 .TP
174 .B Ctrl\-y
175 Copies current URI to primary selection.
176 .TP
177 .B Ctrl\-o
178 Show the sourcecode of the current page.
179 .TP
180 .B Ctrl\-Shift\-a
181 Toggle through the the
182 .I cookie policies.
183 This will not reload the page.
184 .TP
185 .B Ctrl\-Shift\-b
186 Toggle scrollbars. This will reload the page.
187 .TP
188 .B Ctrl\-Shift\-c
189 Toggle caret browsing. This will reload the page.
190 .TP
191 .B Ctrl\-Shift\-i
192 Toggle auto-loading of images. This will reload the page.
193 .TP
194 .B Ctrl\-Shift\-m
195 Toggle if the
196 .I stylefile 
197 file should be loaded. This will reload the page.
198 .TP
199 .B Ctrl\-Shift\-o
200 Open the Web Inspector (Developer Tools) window for the current page.
201 .TP
202 .B Ctrl\-Shift\-s
203 Toggle script execution. This will reload the page.
204 .TP
205 .B Ctrl\-Shift\-v
206 Toggle the enabling of plugins on that surf instance. This will reload the
207 page.
208 .TP
209 .B F11
210 Toggle fullscreen mode.
211 .SH ENVIRONMENT
212 .B SURF_USERAGENT
213 If this variable is set upon startup, surf will use it as the
214 .I useragent
215 string
216 .TP
217 .B http_proxy
218 If this variable is set and not empty upon startup, surf will use it as the http proxy
219 .SH PLUGINS
220 For using plugins in surf, first determine your running architecture. Then get
221 the appropriate plugin for that architecture and copy it to
222 .BR /usr/lib/browser-plugins
223 or
224 .BR /usr/lib64/browser-plugins.
225 Surf should load them automatically.
226 .BR
227 If you want to use a 32bit plugin on a 64bit system,
228 .BR nspluginwrapper(1)
229 will help you.
230 .SH SEE ALSO
231 .BR dmenu(1),
232 .BR xprop(1),
233 .BR tabbed(1),
234 .BR nspluginwrapper(1)
235 .SH BUGS
236 Please report them!