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