xxxterm.1

   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
  25 .Bk -words
  26 .Op Fl STtV
  27 .Op Fl f Ar file
  28 .Op Ar uri ...
  29 .Ek
  30 .Sh DESCRIPTION
  31 .Nm
  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
  35 configuration.
  36 It was written by hackers for hackers and it strives to be small, compact and
  37 fast.
  38 .Pp
  39 When
  40 .Nm
  41 starts up, it reads settings from its configuration file,
  42 .Pa xxxterm.conf .
  43 See the
  44 .Sx CONFIGURATION FILES
  45 section below.
  46 .Pp
  47 The following notation is used throughout this page:
  48 .Pp
  49 .Bl -tag -width Ds -offset indent -compact
  50 .It Cm M
  51 Meta
  52 .It Cm S
  53 Shift
  54 .It Cm C
  55 Control
  56 .It Cm M1
  57 Mouse button 1
  58 .El
  59 .Pp
  60 .Nm
  61 is very simple in its use.
  62 Most of the actions are initiated via key or mouse bindings.
  63 See the
  64 .Sx BINDINGS
  65 section below for defaults and customizations.
  66 .Pp
  67 The options are as follows:
  68 .Bl -tag -width Ds
  69 .It Fl f Ar file
  70 Use alternate config file.
  71 .It Fl S
  72 Disable the toolbar.
  73 .It Fl T
  74 Disable visualization of tabs.
  75 .It Fl t
  76 Disable tabs.
  77 .It Fl V
  78 Display version and exit.
  79 .El
  80 .Sh CONFIGURATION FILES
  81 .Nm
  82 tries to open the user specific file,
  83 .Pa ~/.xxxterm.conf .
  84 If that file is unavailable,
  85 it then uses built-in defaults.
  86 .Pp
  87 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
  88 For example:
  89 .Pp
  90 .Dl http_proxy = http://127.0.0.1:8080
  91 .Pp
  92 Enabling or disabling an option is done by using 1 or 0 respectively.
  93 .Pp
  94 The file supports the following keywords:
  95 .Pp
  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
 101 terminated.
 102 .It Cm cookies_enabled
 103 Enable cookies.
 104 .It Cm enable_scripts
 105 Enable scripts.
 106 .It Cm enable_plugins
 107 Enable plugins.
 108 .It Cm default_font_size
 109 Set the default browsing font size.
 110 .It Cm http_proxy
 111 Proxy server in URI format.
 112 .It Cm download_dir
 113 Locations where files are downloaded to.
 114 This directory must exist and
 115 .Nm
 116 validates that during startup.
 117 .It Cm fancy_bar
 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.
 120 .It Cm search_string
 121 Default search engine string.
 122 See xxxterm.conf file for details.
 123 .El
 124 .Pp
 125 .Nm
 126 overrides http_proxy if it is specified as an environment variable.
 127 .Sh BINDINGS
 128 .Nm
 129 provides many functions (or actions) accessed via key or mouse bindings.
 130 .Pp
 131 The current mouse bindings are described below:
 132 .Pp
 133 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
 134 .It Cm C-M1
 135 Open new tab with the clicked link.
 136 .El
 137 .Pp
 138 The default key bindings are described below.
 139 .Pp
 140 Search:
 141 .Pp
 142 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
 143 .It Cm /
 144 Start a search
 145 .It Cm n
 146 Next item matching search
 147 .It Cm N
 148 Previous item matching search
 149 .It Cm ?
 150 Previous item matching search
 151 .El
 152 .Pp
 153 Focus:
 154 .Pp
 155 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
 156 .It Cm F6
 157 Focus on URI entry
 158 .El
 159 .Pp
 160 Navigation:
 161 .Pp
 162 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
 163 .It Cm F5
 164 Refresh page
 165 .It Cm C-r
 166 Refresh page
 167 .It Cm C-l
 168 Refresh page
 169 .It Cm Backspace
 170 Previous page
 171 .It Cm M-Left
 172 Previous page
 173 .It Cm S-BackSpace
 174 Forward page
 175 .It Cm M-Right
 176 Forward page
 177 .It Cm j
 178 Next line on page
 179 .It Cm Down
 180 Next line on page
 181 .It Cm k
 182 Previous line on page
 183 .It Cm Up
 184 Previous line on page
 185 .It Cm G
 186 Bottom of page
 187 .It Cm End
 188 Bottom of page
 189 .It Cm gg
 190 Top of page
 191 .It Cm Home
 192 Top of page
 193 .It Cm Space
 194 Page down
 195 .It Cm PageDown
 196 Page down
 197 .It Cm C-f
 198 Page down
 199 .It Cm C-b
 200 Page up
 201 .It Cm PageUp
 202 Page up
 203 .It Cm l
 204 Page right
 205 .It Cm Right
 206 Page right
 207 .It Cm h
 208 Page left
 209 .It Cm Left
 210 Page left
 211 .It Cm $
 212 Page far right
 213 .It Cm 0
 214 Page far left
 215 .El
 216 .Pp
 217 Tab Manipulation:
 218 .Pp
 219 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
 220 .It Cm C-T
 221 Create new tab with focus in URI entry
 222 .It Cm C-W
 223 Destroy current tab
 224 .It Cm C-[1..0]
 225 Jump to page N
 226 .It Cm C-minus
 227 Shrink font size by one point.
 228 .It Cm C-plus
 229 Grow font size by one point.
 230 .El
 231 .Pp
 232 Exiting:
 233 .Pp
 234 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
 235 .It Cm C-Q
 236 Quit
 237 .El
 238 .Pp
 239 Note: WebKit & GTK+ have many default key bindings that are not overruled and
 240 therefore are available as-is.
 241 .Pp
 242 Command mode is entered by typing a colon and exited by typing Esc.
 243 The commands and descriptions are listed below:
 244 .Pp
 245 .Bl -tag -width "tabnew, tabedit, tabe [URI]" -offset indent -compact
 246 .It Cm qa, qa!, q!
 247 Quit
 248 .Nm
 249 .It Cm fav
 250 Show favorites
 251 .It Cm help
 252 Show help file.
 253 .It Cm open, op, o <URI>
 254 Open URI.
 255 .It Cm tabnew, tabedit, tabe [URI]
 256 Create new tab and optionally open provided URI
 257 .It Cm tabclose, tabc
 258 Close current tab.
 259 .It Cm quit, q
 260 Close current tab and quit
 261 .Nm
 262 if it is the last tab.
 263 .It Cm tabprevious, tabp
 264 Go to the previous tab.
 265 .It Cm tabnext, tabn
 266 Go to the next tab.
 267 .El
 268 .Sh FILES
 269 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 270 .It Pa ~/.xxxterm.conf
 271 .Nm
 272 user specific settings.
 273 .It Pa ~/.xxxterm
 274 .Nm
 275 scratch directory.
 276 .El
 277 .Sh HISTORY
 278 .Nm
 279 was inspired by vimprobable2 and the bloat in other UNIX web browsers.
 280 .Sh AUTHORS
 281 .An -nosplit
 282 .Pp
 283 .Nm
 284 was written by
 285 .An Marco Peereboom Aq marco@peereboom.us