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