Adding a common way to enable and disable features.
[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 [-bBgGiIkKnNpPsSvx]
7 .RB [-c\ cookiefile]
8 .RB [-e\ xid]
9 .RB [-r\ scriptfile]
10 .RB [-t\ stylefile]
11 .RB [-u\ useragent]
12 .RB "URI"
13 .SH DESCRIPTION
14 surf is a simple Web browser based on WebKit/GTK+. It is able
15 to display websites and follow links. It supports the XEmbed protocol
16 which makes it possible to embed it in another application. Furthermore,
17 one can point surf to another URI by setting its XProperties.
18 .SH OPTIONS
19 .TP
20 .B \-b
21 Disable Scrollbars
22 .TP
23 .B \-B
24 Enable Scrollbars
25 .TP
26 .B \-c cookiefile 
27 Specify the
28 .I cookiefile
29 to use.
30 .TP
31 .B \-e xid
32 Reparents to window specified by
33 .I xid.
34 .TP
35 .B \-g
36 Disable giving the geolocation to websites.
37 .TP
38 .B \-G
39 Enable giving the geolocation to websites.
40 .TP
41 .B \-i
42 Disable Images
43 .TP
44 .B \-I
45 Enable Images
46 .TP
47 .B \-k
48 Disable kiosk mode (disable key strokes and right click)
49 .TP
50 .B \-K
51 Enable kiosk mode (disable key strokes and right click)
52 .TP
53 .B \-n
54 Disable the Web Inspector (Developer Tools).
55 .TP
56 .B \-N
57 Enable the Web Inspector (Developer Tools).
58 .TP
59 .B \-p
60 Disable Plugins
61 .TP
62 .B \-P
63 Enable Plugins
64 .TP
65 .B \-r scriptfile 
66 Specify the user
67 .I scriptfile.
68 .TP
69 .B \-s
70 Disable Javascript
71 .TP
72 .B \-S
73 Enable Javascript
74 .TP
75 .B \-t stylefile
76 Specify the user
77 .I stylefile.
78 .TP
79 .B \-u useragent 
80 Specify the
81 .I useragent
82 which surf should use.
83 .TP
84 .B \-v
85 Prints version information to standard output, then exits.
86 .TP
87 .B \-x
88 Prints xid to standard output. This can be used to script the browser by using
89 .BR xprop(1).
90 .SH USAGE
91 .B Escape
92 Stops loading current page or stops download.
93 .TP
94 .B Ctrl\-h
95 Walks back the history.
96 .TP
97 .B Ctrl\-l
98 Walks forward the history.
99 .TP
100 .B Ctrl\-k
101 Scrolls page upwards.
102 .TP
103 .B Ctrl\-j
104 Scrolls page downwards.
105 .TP
106 .B Ctrl\-b
107 Scroll up one whole page view.
108 .TP
109 .B Ctrl\-Space
110 Scroll down one whole page view.
111 .TP
112 .B Ctrl\-i
113 Scroll horizontally to the right.
114 .TP
115 .B Ctrl\-u
116 Scroll horizontally to the left.
117 .TP
118 .B Ctrl\-Shift\-k or Ctrl\-+
119 Zooms page in.
120 .TP
121 .B Ctrl\-Shift\-j or Ctrl\--
122 Zooms page out
123 .TP
124 .B Ctrl\-Shift\-q
125 Resets Zoom
126 .TP
127 .B Ctrl\-f and Ctrl\-\e
128 Opens the search-bar.
129 .TP
130 .B Ctrl\-n
131 Go to next search result.
132 .TP
133 .B Ctrl\-Shift\-n
134 Go to previous search result.
135 .TP
136 .B Ctrl\-g
137 Opens the URL-bar.
138 .TP
139 .B Ctrl\-p
140 Loads URI from primary selection.
141 .TP
142 .B Ctrl\-Shift\-p
143 Calls Printpage Dialog.
144 .TP
145 .B Ctrl\-r
146 Reloads the website.
147 .TP
148 .B Ctrl\-Shift\-r
149 Reloads the website without using cache.
150 .TP
151 .B Ctrl\-y
152 Copies current URI to primary selection.
153 .TP
154 .B Ctrl\-o
155 Show the sourcecode of the current page.
156 .TP
157 .B Ctrl\-Shift\-b
158 Toggle scrollbars
159 .TP
160 .B Ctrl\-Shift\-c
161 Toggle caret browsing.
162 .TP
163 .B Ctrl\-Shift\-i
164 Toggle auto-loading of images.
165 .TP
166 .B Ctrl\-Shift\-m
167 Toggle if the
168 .I stylefile 
169 file should be loaded.
170 .TP
171 .B Ctrl\-Shift\-o
172 Open the Web Inspector (Developer Tools) window for the current page.
173 .TP
174 .B Ctrl\-Shift\-s
175 Toggle script execution.
176 .TP
177 .B Ctrl\-Shift\-v
178 Toggle the enabling of plugins on that surf instance.
179 .TP
180 .B F11
181 Toggle fullscreen mode.
182 .SH ENVIRONMENT
183 .B SURF_USERAGENT
184 If this variable is set upon startup, surf will use it as the
185 .I useragent
186 string
187 .TP
188 .B http_proxy
189 If this variable is set and not empty upon startup, surf will use it as the http proxy
190 .SH PLUGINS
191 For using plugins in surf, first determine your running architecture. Then get
192 the appropriate plugin for that architecture and copy it to
193 .BR /usr/lib/browser-plugins
194 or
195 .BR /usr/lib64/browser-plugins.
196 Surf should load them automatically.
197 .BR
198 If you want to use a 32bit plugin on a 64bit system,
199 .BR nspluginwrapper(1)
200 will help you.
201 .SH SEE ALSO
202 .BR dmenu(1),
203 .BR xprop(1),
204 .BR tabbed(1),
205 .BR nspluginwrapper(1)
206 .SH BUGS
207 Please report them!