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