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 STVt
  27 .Op Fl f Ar file
  28 .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 S
  70 Disable the toolbar.
  71 .It Fl T
  72 Disable visualization of tabs.
  73 .It Fl V
  74 Display version and exit.
  75 .It Fl f Ar file
  76 Use alternate config file.
  77 .It Fl t
  78 Disable tabs.
  79 .El
  80 .Pp
  81
  82 .Sh CONFIGURATION FILES
  83 .Nm
  84 tries to open the user specific file,
  85 .Pa ~/.xxxterm.conf .
  86 If that file is unavailable,
  87 it then uses built-in defaults.
  88 .Pp
  89 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
  90 For example:
  91 .Pp
  92 .Dl http_proxy = http://127.0.0.1:8080
  93 .Pp
  94 Enabling or disabling an option is done by using 1 or 0 respectively.
  95 .Pp
  96 The file supports the following keywords:
  97 .Pp
  98 .Bl -tag -width "title_class_enabledXXX" -offset indent -compact
  99 .It Cm ctrl_click_focus
 100 Give focus in newly created tab instead of opening it in the background.
 101 .It Cm read_only_cookies
 102 Mark cookies file read-only and discard all cookies once the sessions is
 103 terminated.
 104 .It Cm cookies_enabled
 105 Enable cookies.
 106 .It Cm enable_scripts
 107 Enable scripts.
 108 .It Cm enable_plugins
 109 Enable plugins.
 110 .It Cm default_font_size
 111 Set the default browsing font size.
 112 .It Cm http_proxy
 113 Proxy server in URI format.
 114 .It Cm download_dir
 115 Locations where files are downloaded to.
 116 This directory must exist and
 117 .Nm
 118 validates that during startup.
 119 .It Cm fancy_bar
 120 Enables a backward, forward and stop button to the toolbar.
 121 Additionally if search_string is set it'll enable an entry box for searches.
 122 .It Cm search_string
 123 Default search engine string.
 124 See xxxterm.conf file for details.
 125 .El
 126 .Pp
 127 .Nm
 128 overrides http_proxy if it is specified as an environment variable.
 129 .Sh BINDINGS
 130 .Nm
 131 provides many functions (or actions) accessed via key or mouse bindings.
 132 .Pp
 133 The current mouse bindings are described below:
 134 .Pp
 135 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 136 .It Cm C-M1
 137 Open new tab with the clicked link.
 138 .El
 139 .Pp
 140 The default key bindings are described below:
 141 .Pp
 142 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 143 .It Cm C-Q
 144 quit
 145 .It Cm F6
 146 Focus on URI entry
 147 .It Cm F5
 148 Refresh page
 149 .It Cm Backspace
 150 Previous page
 151 .It Cm M-Left
 152 Previous page
 153 .It Cm S-BackSpace
 154 Forward page
 155 .It Cm M-Right
 156 Forward page
 157 .It Cm j
 158 Next line on page
 159 .It Cm Down
 160 Next line on page
 161 .It Cm k
 162 Previous line on page
 163 .It Cm Up
 164 Previous line on page
 165 .It Cm G
 166 Bottom of page
 167 .It Cm End
 168 Bottom of page
 169 .It Cm gg
 170 Top of page
 171 .It Cm Home
 172 Top of page
 173 .It Cm Space
 174 Page down
 175 .It Cm PageDown
 176 Page down
 177 .It Cm PageUp
 178 Page up
 179 .It Cm l
 180 Page right
 181 .It Cm Right
 182 Page right
 183 .It Cm h
 184 Page left
 185 .It Cm Left
 186 Page left
 187 .It Cm $
 188 Page far right
 189 .It Cm 0
 190 Page far left
 191 .It Cm C-T
 192 Create new tab with focus in URI entry
 193 .It Cm C-W
 194 Destroy current tab
 195 .It Cm C-[1..0]
 196 Jump to page N
 197 .El
 198 .Pp
 199 Note: WebKit & GTK+ have many default key bindings that are not overruled and
 200 therefore are available as-is.
 201 .Pp
 202 Command mode is entered by typing a colon and exited by typing Esc.
 203 The commands and descriptions are listed below:
 204 .Pp
 205 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 206 .It Cm qa, qa!, q!
 207 Quit
 208 .Nm
 209 .It Cm open, op, o <URI>
 210 Open URI
 211 .It Cm tabnew, tabedit, tabe [URI]
 212 Create new tab and optionally open provided URI
 213 .It Cm tabclose, tabc
 214 Close current tab
 215 .It Cm quit, q
 216 Close current tab and quit
 217 .Nm
 218 if it is the last tab
 219 .It Cm tabprevious, tabp
 220 Go to the previous tab
 221 .It Cm tabnext, tabn
 222 Go to the next tab
 223 .El
 224 .Pp
 225 .Sh FILES
 226 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 227 .It Pa ~/.xxxterm.conf
 228 .Nm
 229 user specific settings.
 230 .It Pa ~/.xxxterm
 231 .Nm
 232 scratch directory.
 233 .El
 234 .Sh HISTORY
 235 .Nm
 236 was inspired by vimprobable2 and the bloat in other UNIX web browsers.
 237 .Sh AUTHORS
 238 .An -nosplit
 239 .Pp
 240 .Nm
 241 was written by
 242 .An Marco Peereboom Aq marco@peereboom.us