Adding web inspector support to surf.
[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\-h
91 Navigate back one step in history.
92 .TP
93 .B Ctrl\-l
94 Navigate forward one step in history.
95 .TP
96 .B Ctrl\-f and Ctrl\-\\
97 Opens the search-bar.
98 .TP
99 .B Ctrl\-n
100 Go to next search result.
101 .TP
102 .B Ctrl\-Shift\-n
103 Go to previous search result.
104 .TP
105 .B Ctrl\-g
106 Opens the URL-bar.
107 .TP
108 .B Ctrl\-p
109 Loads URI from primary selection.
110 .TP
111 .B Esc
112 Stop loading the page.
113 .TP
114 .B Ctrl\-Shift\-p
115 Calls Printpage Dialog.
116 .TP
117 .B Ctrl\-r
118 Reloads the website.
119 .TP
120 .B Ctrl\-Shift\-r
121 Reloads the website without using cache.
122 .TP
123 .B Ctrl\-y
124 Copies current URI to primary selection.
125 .TP
126 .B Ctrl\-o
127 Show the sourcecode of the current page.
128 .TP
129 .B Ctrl\-Shift\-o
130 Open the Web Inspector (Developer Tools) window for the current page.
131 .TP
132 .B Ctrl\-Shift\-c
133 Toggle caret browsing.
134 .TP
135 .B Ctrl\-Shift\-i
136 Toggle auto-loading of images.
137 .TP
138 .B Ctrl\-Shift\-s
139 Toggle script execution.
140 .TP
141 .B Ctrl\-Shift\-v
142 Toggle the enabling of plugins on that surf instance.
143 .TP
144 .B F11
145 Toggle fullscreen mode.
146 .SH ENVIRONMENT
147 .B SURF_USERAGENT
148 If this variable is set upon startup, surf will use it as the useragent string
149 .TP
150 .B http_proxy
151 If this variable is set and not empty upon startup, surf will use it as the http proxy
152 .SH PLUGINS
153 For using plugins in surf, first determine your running architecture. Then get
154 the appropriate plugin for that architecture and copy it to
155 .BR /usr/lib/browser-plugins
156 or
157 .BR /usr/lib64/browser-plugins.
158 Surf should load them automatically.
159 .BR
160 If you want to use a 32bit plugin on a 64bit system,
161 .BR nspluginwrapper(1)
162 will help you.
163 .SH SEE ALSO
164 .BR dmenu(1),
165 .BR xprop(1),
166 .BR tabbed(1),
167 .BR nspluginwrapper(1)
168 .SH BUGS
169 Please report them!