| blob | 312ad5ef535229d056422366bceb08a6513c6177 |
1 .\" $xxxterm$
2 .\"
3 .\" Copyright (c) 2010 Marco Peereboom <marco@peereboom.us>
4 .\"
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.
8 .\"
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.
16 .\"
17 .Dd $Mdocdate$
18 .Dt XXXTERM 1
19 .Os
20 .Sh NAME
21 .Nm xxxterm
22 .Nd Lightweight web browser with vi key bindings
23 .Sh SYNOPSIS
24 .Nm xxxterm [-STVft] [uri ...]
25 .Sh DESCRIPTION
26 .Nm
27 is a minimalistic web browser that tries to stay out of the way so that
28 valuable screen real estate can be used for much more important stuff.
29 It has sane defaults and does not require one to learn a language to do any
30 configuration.
31 It was written by hackers for hackers and it strives to be small, compact and
32 fast.
33 .Pp
34 When
35 .Nm
36 starts up, it reads settings from its configuration file,
37 .Pa xxxterm.conf .
38 See the
39 .Sx CONFIGURATION FILES
40 section below.
41 .Pp
42 The following notation is used throughout this page:
43 .Pp
44 .Bl -tag -width Ds -offset indent -compact
45 .It Cm M
46 Meta
47 .It Cm S
48 Shift
49 .It Cm C
50 Control
51 .It Cm M1
52 Mouse button 1
53 .El
54 .Pp
55 .Nm
56 is very simple in its use.
57 Most of the actions are initiated via key or mouse bindings.
58 See the
59 .Sx BINDINGS
60 section below for defaults and customizations.
61 .Sh CONFIGURATION FILES
62 .Nm
63 tries to open the user specific file,
64 .Pa ~/.xxxterm.conf .
65 If that file is unavailable,
66 it then uses built-in defaults.
67 .Pp
68 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
69 For example:
70 .Pp
71 .Dl http_proxy = http://127.0.0.1:8080
72 .Pp
73 Enabling or disabling an option is done by using 1 or 0 respectively.
74 .Pp
75 The file supports the following keywords:
76 .Pp
77 .Bl -tag -width "title_class_enabledXXX" -offset indent -compact
78 .It Cm ctrl_click_focus
79 Give focus in newly created tab instead of opening it in the background.
80 .It Cm read_only_cookies
81 Mark cookies file read-only and discard all cookies once the sessions is
82 terminated.
83 .It Cm cookies_enabled
84 Enable cookies.
85 .It Cm enable_scripts
86 Enable scripts.
87 .It Cm enable_plugins
88 Enable plugins.
89 .It Cm default_font_size
90 Set the default browsing font size.
91 .It Cm http_proxy
92 Proxy server in URI format.
93 .It Cm download_dir
94 Locations where files are downloaded to.
95 This directory must exist and
96 .Nm
97 validates that during startup.
98 .It Cm fancy_bar
99 Enables a backward, forward and stop button to the toolbar.
100 Additionally if search_string is set it'll enable an entry box for searches.
101 .It Cm search_string
102 Default search engine string.
103 See xxxterm.conf file for details.
104 .El
105 .Pp
106 .Nm
107 overrides http_proxy if it is specified as an environment variable.
108 .Sh BINDINGS
109 .Nm
110 provides many functions (or actions) accessed via key or mouse bindings.
111 .Pp
112 The current mouse bindings are described below:
113 .Pp
114 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
115 .It Cm C-M1
116 Open new tab with the clicked link.
117 .El
118 .Pp
119 The default key bindings are described below:
120 .Pp
121 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
122 .It Cm C-Q
123 quit
124 .It Cm F6
125 Focus on URI entry
126 .It Cm F5
127 Refresh page
128 .It Cm Backspace
129 Previous page
130 .It Cm M-Left
131 Previous page
132 .It Cm S-BackSpace
133 Forward page
134 .It Cm M-Right
135 Forward page
136 .It Cm j
137 Next line on page
138 .It Cm Down
139 Next line on page
140 .It Cm k
141 Previous line on page
142 .It Cm Up
143 Previous line on page
144 .It Cm G
145 Bottom of page
146 .It Cm End
147 Bottom of page
148 .It Cm gg
149 Top of page
150 .It Cm Home
151 Top of page
152 .It Cm Space
153 Page down
154 .It Cm PageDown
155 Page down
156 .It Cm PageUp
157 Page up
158 .It Cm l
159 Page right
160 .It Cm Right
161 Page right
162 .It Cm h
163 Page left
164 .It Cm Left
165 Page left
166 .It Cm $
167 Page far right
168 .It Cm 0
169 Page far left
170 .It Cm C-T
171 Create new tab with focus in URI entry
172 .It Cm C-W
173 Destroy current tab
174 .It Cm C-[1..0]
175 Jump to page N
176 .El
177 .Pp
178 Note: WebKit & GTK+ have many default key bindings that are not overruled and
179 therefore are available as-is.
180 .Pp
181 Command mode is entered by typing a colon and exited by typing Esc.
182 The commands and descriptions are listed below:
183 .Pp
184 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
185 .It Cm qa, qa!, q!
186 Quit
187 .Nm
188 .It Cm open, op, o <URI>
189 Open URI
190 .It Cm tabnew, tabedit, tabe [URI]
191 Create new tab and optionally open provided URI
192 .It Cm tabclose, tabc
193 Close current tab
194 .It Cm quit, q
195 Close current tab and quit
196 .Nm
197 if it is the last tab
198 .It Cm tabprevious, tabp
199 Go to the previous tab
200 .It Cm tabnext, tabn
201 Go to the next tab
202 .El
203 .Pp
204 .Sh FILES
205 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
206 .It Pa ~/.xxxterm.conf
207 .Nm
208 user specific settings.
209 .It Pa ~/.xxxterm
210 .Nm
211 scratch directory.
212 .El
213 .Sh HISTORY
214 .Nm
215 was inspired by vimprobable2 and the bloat in other UNIX web browsers.
216 .Sh AUTHORS
217 .An -nosplit
218 .Pp
219 .Nm
220 was written by
221 .An Marco Peereboom Aq marco@peereboom.us