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