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