3 .\" Copyright (c) 2010 Marco Peereboom <marco@peereboom.us>
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 .Nd lightweight web browser with vi key bindings
32 is a minimalistic web browser that tries to stay out of the way so that
33 valuable screen real estate can be used for much more important stuff.
34 It has sane defaults and does not require one to learn a language to do any
36 It was written by hackers for hackers and it strives to be small, compact and
41 starts up, it reads settings from its configuration file,
44 .Sx CONFIGURATION FILES
47 The following notation is used throughout this page:
49 .Bl -tag -width Ds -offset indent -compact
61 is very simple in its use.
62 Most of the actions are initiated via key or mouse bindings.
65 section below for defaults and customizations.
67 The options are as follows:
70 Use alternate config file.
74 Disable visualization of tabs.
78 Display version and exit.
80 .Sh CONFIGURATION FILES
82 tries to open the user specific file,
84 If that file is unavailable,
85 it then uses built-in defaults.
87 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
90 .Dl http_proxy = http://127.0.0.1:8080
92 Enabling or disabling an option is done by using 1 or 0 respectively.
94 The file supports the following keywords:
96 .Bl -tag -width "title_class_enabledXXX" -offset indent -compact
97 .It Cm ctrl_click_focus
98 Give focus in newly created tab instead of opening it in the background.
99 .It Cm read_only_cookies
100 Mark cookies file read-only and discard all cookies once the sessions is
102 .It Cm cookies_enabled
104 .It Cm enable_scripts
106 .It Cm enable_plugins
108 .It Cm default_font_size
109 Set the default browsing font size.
111 Proxy server in URI format.
113 Locations where files are downloaded to.
114 This directory must exist and
116 validates that during startup.
118 Enables a backward, forward and stop button to the toolbar.
119 Additionally if search_string is set it'll enable an entry box for searches.
121 Default search engine string.
122 See xxxterm.conf file for details.
124 Sets an action for a specific or default MIME type.
125 For example, to download and view a pdf using kpdf set mime_type =
126 application/pdf,kpdf.
127 To set a default value use *, for example mime_type = video/*,mplayer.
128 Note that the action is only passed the URI and not all applications are
129 capable of downloading content and therefore one might have to create a wrapper
130 script to download the content first.
132 Defines an alias for a given URL, so that the URL is loaded when the alias is
133 entered in the address bar.
134 If the aliased URL includes a %s format specifier, then any argument given after
135 the alias on the address bar is substituted.
136 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
137 then the URL http://www.google.com/search?q=foo is loaded when navigating to
142 overrides http_proxy if it is specified as an environment variable.
145 provides many functions (or actions) accessed via key or mouse bindings.
147 The current mouse bindings are described below:
149 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
151 Open new tab with the clicked link.
154 The default key bindings are described below.
158 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
162 Start a backwards search
164 Next item matching search
166 Previous item matching search
171 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
175 Focus on search entry
180 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
187 .It Cm S-BackSpace, M-Right
192 Previous line on page
197 .It Cm Space, C-f, PageDown
215 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
217 Create new tab with focus in URI entry
223 Shrink font size by one point.
224 .It Cm C-plus, C-equal
225 Grow font size by one point.
228 Mouse-less browsing (a.k.a. link following):
230 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
232 Highlight all links and prefix them with a number.
233 Press number to follow link.
234 Alternatively one can type the name of the link and when there are no more
237 will follow the link.
242 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
247 Note: WebKit & GTK+ have many default key bindings that are not overruled and
248 therefore are available as-is.
250 Command mode is entered by typing a colon and exited by typing Esc.
251 The commands and descriptions are listed below:
253 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
260 Add current page to favorites
263 .It Cm open, op, o <URI>
265 .It Cm tabnew, tabedit, tabe [URI]
266 Create new tab and optionally open provided URI
267 .It Cm tabclose, tabc
270 Close current tab and quit
272 if it is the last tab.
273 .It Cm tabprevious, tabp
274 Go to the previous tab.
279 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
280 .It Pa ~/.xxxterm.conf
282 user specific settings.
289 was inspired by vimprobable2 and the bloat in other UNIX web browsers.
295 .An Marco Peereboom Aq marco@peereboom.us