xxxterm.1

   1 .\"     $xxxterm$
   2 .\"
   3 .\" Copyright (c) 2010, 2011 Marco Peereboom <marco@peereboom.us>
   4 .\" Copyright (c) 2011 Jason McIntyre <jmc@openbsd.org>
   5 .\"
   6 .\" Permission to use, copy, modify, and distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .Dd $Mdocdate: October 14 2011 $
  19 .Dt XXXTERM 1
  20 .Os
  21 .Sh NAME
  22 .Nm xxxterm
  23 .Nd lightweight web browser
  24 .Sh SYNOPSIS
  25 .Nm xxxterm
  26 .Bk -words
  27 .Op Fl nSTtV
  28 .Op Fl f Ar file
  29 .Op Fl s Ar session_name
  30 .Op Ar url ...
  31 .Ek
  32 .Sh DESCRIPTION
  33 .Nm
  34 is a minimalistic web browser that tries to stay out of the way so that
  35 valuable screen real estate can be used for much more important stuff.
  36 It has sane defaults and does not require one to learn a language to do any
  37 configuration.
  38 It was written by hackers for hackers
  39 and it strives to be small, compact, and fast.
  40 .Pp
  41 .Nm
  42 is very simple in its use.
  43 Most actions are initiated via key or mouse bindings.
  44 Key bindings are based on those of the
  45 .Xr vi 1
  46 text editor,
  47 giving web browsing a similar feel to navigating a text document.
  48 The
  49 .Sx KEY BINDINGS
  50 section below documents the various defaults and possible customizations.
  51 .Pp
  52 The options are as follows:
  53 .Bl -tag -width Ds
  54 .It Fl f Ar file
  55 Specify an alternative configuration file.
  56 .It Fl n
  57 Open a new tab in a running
  58 .Nm
  59 for each specified URL.
  60 This option requires
  61 .Cm enable_socket
  62 to be enabled.
  63 .It Fl e Ar command
  64 Execute arbitrary command (see the
  65 .Sx COMMAND MODE
  66 section below) in a running
  67 .Nm
  68 instance. This option requires
  69 .Cm enable_socket
  70 to be enabled. Example run: xxxterm -e "tabnew openbsd.org"; xxxterm -e
  71 tabclose; xxxterm -e wq.
  72 .It Fl S
  73 Disable the toolbar.
  74 .It Fl s Ar session_name
  75 Open session that was saved with ":session save" command.
  76 .It Fl T
  77 Disable visualization of tabs.
  78 .It Fl t
  79 Disable tabs.
  80 .It Fl V
  81 Display version and exit.
  82 .El
  83 .Sh FAST STARTUP
  84 The following notation is used throughout this page:
  85 .Pp
  86 .Bl -tag -width Ds -offset indent -compact
  87 .It Cm C-
  88 Control
  89 .It Cm S-
  90 Shift
  91 .It Cm M1-
  92 Meta 1 (sometimes marked Alt)
  93 .It Cm M2-
  94 Meta 2
  95 .It Cm M3-
  96 Meta 3
  97 .It Cm M4-
  98 Meta 4 (sometimes marked Windows)
  99 .It Cm M5-
 100 Meta 2
 101 .It Cm MB1
 102 Mouse button 1
 103 .El
 104 .Pp
 105 To browse to a specific address,
 106 either use the mouse to click on the address bar
 107 or press
 108 .Cm F6
 109 to shift the keyboard focus to the address bar.
 110 The address is then entered manually.
 111 .Pp
 112 The mouse can be used to navigate the page in the traditional manner,
 113 or the keyboard can be used instead.
 114 For example,
 115 .Cm PageUp
 116 and
 117 .Cm PageDown
 118 will scroll up and down the page.
 119 .Pp
 120 To follow a link,
 121 either click on it or use the
 122 .Cm f
 123 key and have
 124 .Nm
 125 assign numbers to each link on the page;
 126 entering that number on the keyboard will prompt
 127 .Nm
 128 to follow the link.
 129 .Sh KEY BINDINGS
 130 .Nm
 131 provides many actions accessed via key or mouse bindings.
 132 Most can be reprogrammed using a
 133 .Cm keybinding
 134 entry in the configuration file.
 135 Each keyboard shortcut requires exactly one entry in the configuration file.
 136 A shortcut can have multiple entries in the configuration file.
 137 The format of the keybinding entry is as follows:
 138 .Pp
 139 .D1 keybinding = action,(!)keystroke(s)
 140 .Pp
 141 For example, "keybinding = tabnew,C-t" where
 142 .Cm tabnew
 143 is the action and
 144 .Cm C-t
 145 are
 146 the keystrokes.
 147 GTK has some default keybindings for manipulating text inside input
 148 fields, such as the URI or search entry widget, for example
 149 .Cm C-w
 150 deletes a word. To override these defaults prefix your key with an
 151 exclamation mark, like this: "keybinding = tabclose,!C-w".
 152 The
 153 .Cm clearall
 154 key word is special and is meant to reset the key binding list to the GTK+
 155 and WebKit defaults.
 156 This keyword should be the first
 157 .Cm keybinding
 158 entry in the configuration file.
 159 .Pp
 160 Shift should be used sparingly since it gets in the way of non-USA keyboards.
 161 See the accompanying configuration file for examples.
 162 .Pp
 163 The various bindings are documented below.
 164 The relevant keybinding action is given afterwards, in parentheses.
 165 .Ss Command mode
 166 These commands are used to focus or unfocus input on the default input of a web
 167 page.
 168 .Pp
 169 .Bl -tag -width Ds -offset indent -compact
 170 .It Cm ESC
 171 Go to command mode; unfocus current entry on web page.
 172 .Pq Cm command_mode
 173 .It Cm i
 174 Go to insert mode; focus on default entry on web page.
 175 .Pq Cm insert_mode
 176 .El
 177 .Ss Search Commands
 178 These commands are used to search for text strings within a web page.
 179 .Pp
 180 .Bl -tag -width Ds -offset indent -compact
 181 .It Cm /
 182 Start a search
 183 .Pq Cm search
 184 .It Cm \&?
 185 Start a backwards search
 186 .Pq Cm searchb
 187 .It Cm n
 188 Next item matching search
 189 .Pq Cm searchnext
 190 .It Cm N
 191 Previous item matching search
 192 .Pq Cm searchprev
 193 .El
 194 .Ss Focus Commands
 195 These commands are used to shift the focus of
 196 .Nm
 197 from one area to another.
 198 .Pp
 199 .Bl -tag -width Ds -offset indent -compact
 200 .It Cm F6
 201 Focus on address bar
 202 .Pq Cm focusaddress
 203 .It Cm F7
 204 Focus on search entry
 205 .Pq Cm focussearch
 206 .El
 207 .Ss Command Aliases
 208 These commands allow the user to map specific actions to specific keys.
 209 It can be useful when the
 210 .Fl S
 211 option is used.
 212 .Pp
 213 .Bl -tag -width Ds -offset indent -compact
 214 .It Cm F1
 215 Alias for ":help"
 216 .It Cm F4
 217 Alias for ":toplevel toggle"
 218 .It Cm F9
 219 Alias for ":open"
 220 .Pq Cm promptopen
 221 .It Cm F10
 222 Alias for ":open current-uri"
 223 .Pq Cm promptopencurrent
 224 .It Cm F11
 225 Alias for ":tabnew"
 226 .Pq Cm prompttabnew
 227 .It Cm F12
 228 Alias for ":tabnew current-uri"
 229 .Pq Cm prompttabnewcurrent
 230 .El
 231 .Ss Navigation Commands
 232 These commands allow the user to navigate web pages and,
 233 to some extent,
 234 control the browser.
 235 .Pp
 236 .Bl -tag -width "Space, C-f, PageDownXXX" -offset indent -compact
 237 .It Cm F5, C-r, C-l
 238 Reload page
 239 .Pq Cm reload
 240 .It Cm Backspace, M-Left
 241 Previous page
 242 .Pq Cm goback
 243 .It Cm S-BackSpace, M-Right
 244 Forward page
 245 .Pq Cm goforward
 246 .It Cm j, Down
 247 Next line on page
 248 .Pq Cm scrolldown
 249 .It Cm k, Up
 250 Previous line on page
 251 .Pq Cm scrollup
 252 .It Cm G, End
 253 Bottom of page
 254 .Pq Cm scrollbottom
 255 .It Cm gg, Home
 256 Top of page
 257 .Pq Cm scrolltop
 258 .It Cm Space, C-f, PageDown
 259 Page down
 260 .Pq Cm scrollpagedown
 261 .It Cm C-b, PageUp
 262 Page up
 263 .Pq Cm scrollpageup
 264 .It Cm l, Right
 265 Page right
 266 .Pq Cm scrollright
 267 .It Cm h, Left
 268 Page left
 269 .Pq Cm scrollleft
 270 .It Cm $
 271 Page far right
 272 .Pq Cm scrollfarright
 273 .It Cm 0
 274 Page far left
 275 .Pq Cm scrollfarleft
 276 .It Cm M-f
 277 Favorites
 278 .Pq Cm fav
 279 .It Cm M-j
 280 Cookie jar
 281 .Pq Cm cookiejar
 282 .It Cm M-d
 283 Download manager
 284 .Pq Cm dl
 285 .It Cm C-p
 286 Print page
 287 .Pq Cm print
 288 .It Cm M-h
 289 Global history
 290 .Pq Cm history
 291 .It Cm C-j
 292 Toggle Java Script enabled for FQDN
 293 .Pq Cm js
 294 .It Cm C-s
 295 Toggle source view
 296 .Pq Cm togglesrc
 297 .It Cm M-c
 298 Toggle cookie enabled for FQDN
 299 .Pq Cm cookie
 300 .El
 301 .Ss Tab Manipulation
 302 .Nm
 303 supports tabbed browsing.
 304 That is, web pages may be opened in separate tabs,
 305 allowing the user to quickly move from one page to another,
 306 and back.
 307 These commands then are used to create, destroy, and move between tabs.
 308 .Pp
 309 .Bl -tag -width "C-plus, C-equalXXX" -offset indent -compact
 310 .It Cm C-MB1
 311 Open new tab with the clicked link
 312 .It Cm C-t
 313 Create new tab with focus in URL entry
 314 .Pq Cm tabnew
 315 .It Cm C-T
 316 Create new tab with focus in URL entry as the last tab in the browser
 317 .Pq Cm 999tabnew
 318 .It Cm C-w
 319 Destroy current tab
 320 .Pq Cm tabclose
 321 .It Cm U
 322 Undo close tab
 323 .Pq Cm tabundoclose
 324 .It Cm C-Left, C-PageUp
 325 Go to the previous tab
 326 .Pq Cm tabprevious
 327 .It Cm C-Right, C-PageDown
 328 Go to the next tab
 329 .Pq Cm tabnext
 330 .It Cm C-[1..9]
 331 Jump to page
 332 .Ar N
 333 .Pq Cm tabnext [1..9]
 334 .It Cm C-<
 335 Jump to first page
 336 .Pq Cm tabfirst
 337 .It Cm C->
 338 Jump to last page
 339 .Pq Cm tablast
 340 .It Cm C-minus
 341 Zoom out by 4%
 342 .Pq Cm focusout
 343 .It Cm C-plus, C-equal
 344 Zoom in by 4%
 345 .Pq Cm focusin
 346 .It Cm C-0
 347 Set zoom level to 100%
 348 .Pq Cm focusreset
 349 .El
 350 .Ss Yanking and pasting
 351 These commands copy and paste text to and from the clipboard.
 352 .Pp
 353 .Bl -tag -width Ds -offset indent -compact
 354 .It Cm p
 355 Paste the contents of the clipboard into the address bar
 356 .Pq Cm pasteuricur
 357 .It Cm P
 358 Paste the contents of the clipboard into a new tab
 359 .Pq Cm pasteurinew
 360 .It Cm y
 361 Yank the current URL into the clipboard
 362 .Pq Cm yankuri
 363 .El
 364 .Ss Hyperlink Following
 365 This allows the user to follow hyperlinks
 366 without using a mouse.
 367 Enter the corresponding number to follow the link.
 368 Alternatively one can type the name of the link and when there are no more
 369 possibilities
 370 .Nm
 371 will follow the link.
 372 .Pp
 373 .Bl -tag -width Ds -offset indent -compact
 374 .It Cm f, '.'
 375 Highlight all links and prefix them with a number.
 376 .Pq Cm hinting
 377 .It Cm F, ','
 378 Highlight all links and prefix them with a number but open in a new tab.
 379 .Pq Cm hinting_newtab
 380 .El
 381 .Ss Exiting
 382 Commands to exit the browser.
 383 .Pp
 384 .Bl -tag -width Ds -offset indent -compact
 385 .It Cm C-q
 386 Quit
 387 .Pq Cm quitall
 388 .El
 389 .Ss Low-Contrast Color Scheme
 390 This command toggles the page's style between the default CSS and a
 391 low-contrast color scheme with light grey text on a dark grey background.
 392 .Pp
 393 .Bl -tag -width Ds -offset indent -compact
 394 .It Cm s
 395 Toggle the current tab's style.
 396 .Pq Cm userstyle
 397 .El
 398 .Sh COMMAND MODE
 399 Command mode works in a similar fashion to the
 400 .Xr vi 1
 401 editor;
 402 it is entered by typing a colon and exited by typing Esc.
 403 The commands and their descriptions are listed below.
 404 .Bl -tag -width Ds -offset indent
 405 .It Cm about , version
 406 Show the "About" page.
 407 .It Cm buffers , ls , tabs
 408 Displays the currently open tabs and lets the user switch tab by typing
 409 the tab number or using the mouse.
 410 .It Cm ca
 411 Display CA certificates.
 412 .It Cm cert , cert show
 413 Download and display certificates of domain on tab.
 414 .It Cm cert save
 415 Save certificate into a local store.
 416 The next time the site is visited it is compared against the store.
 417 If the certificate matches,
 418 the address bar will be blue;
 419 if it doesn't the bar will be red.
 420 .It Cm cookie
 421 The
 422 .Cm cookie
 423 command is used to manipulate the cookie whitelist.
 424 Used by itself it expands to
 425 .Cm cookie show all .
 426 .It Cm cookiejar
 427 Show cookie jar contents.
 428 .It Cm cookie save, cookie save fqdn
 429 Save the current fully qualified domain name (FQDN)
 430 to the persistent whitelist.
 431 For example,
 432 the www.peereboom.us domain would result in saving .www.peereboom.us.
 433 .It Cm cookie save domain
 434 Save the top level domain name to the persistent whitelist.
 435 For example,
 436 the www.peereboom.us domain would result in saving .peereboom.us.
 437 .Pp
 438 This action enables cookies if it is currently disabled for this entry.
 439 .It Cm cookie show all
 440 Show all persistent and session entries in the cookie whitelist.
 441 .It Cm cookie show persistent
 442 Show all persistent entries in the cookie whitelist.
 443 .It Cm cookie show session
 444 Show all session entries in the cookie whitelist.
 445 .It Cm cookie toggle domain
 446 Toggle cookie support for the current top level domain.
 447 .It Cm cookie toggle, cookie toggle fqdn
 448 Toggle cookie support for the current FQDN.
 449 .It Cm dl
 450 Show download manager.
 451 .It Cm encoding <encoding>
 452 If
 453 .Cm <encoding>
 454 is set the tab's encoding will be set to
 455 .Cm <encoding>
 456 and
 457 .Nm
 458 reloads the tab.
 459 If
 460 .Cm <encoding>
 461 is not set
 462 .Nm
 463 will display the current tab encoding.
 464 .It Cm fav
 465 Show favorites.
 466 .It Cm favadd
 467 Add the current page to favorites.
 468 .It Cm fullscreen , f
 469 Toggle hiding tabs and url entry toolbar.
 470 .It Cm h , hist , history
 471 Show global history.
 472 .It Cm help
 473 Show help page.
 474 .It Cm home
 475 Go to home URL.
 476 .It Cm js
 477 The
 478 .Cm js
 479 command is used to manipulate the Java Script whitelist.
 480 Used by itself it expands to
 481 .Cm js show all .
 482 .It Cm js save, save fqdn
 483 Saves the FQDN to the persistent whitelist.
 484 For example,
 485 the www.peereboom.us domain would result in saving .www.peereboom.us.
 486 .It Cm js save domain
 487 Saves the top level domain name to the persistent whitelist.
 488 For example,
 489 the www.peereboom.us domain would result in saving .peereboom.us.
 490 .Pp
 491 This action enables Java Script if it is currently disabled for this entry.
 492 .It Cm js show all
 493 Shows all persistent and session entries in the JS whitelist.
 494 .It Cm js show persistent
 495 Shows all persistent entries in the JS whitelist.
 496 .It Cm js show session
 497 Shows all session entries in the JS whitelist.
 498 .It Cm js toggle, js toggle fqdn
 499 Toggle Java Script execution for the current FQDN.
 500 .It Cm js toggle domain
 501 Toggle Java Script execution for the current top level domain.
 502 .It Cm open , op , o URL
 503 Open URL.
 504 .It Cm plugin
 505 The
 506 .Cm plugin
 507 command is used to manipulate the plugin whitelist.
 508 Used by itself it expands to
 509 .Cm plugin show all .
 510 .It Cm plugin save, save fqdn
 511 Saves the FQDN to the persistent whitelist.
 512 For example,
 513 the www.peereboom.us domain would result in saving .www.peereboom.us.
 514 .It Cm plugin save domain
 515 Saves the top level domain name to the persistent whitelist.
 516 For example,
 517 the www.peereboom.us domain would result in saving .peereboom.us.
 518 .Pp
 519 This action enables plugins if they are currently disabled for this entry.
 520 .It Cm plugin show all
 521 Shows all persistent and session entries in the plugin whitelist.
 522 .It Cm plugin show persistent
 523 Shows all persistent entries in the plugin whitelist.
 524 .It Cm plugin show session
 525 Shows all session entries in the plugin whitelist.
 526 .It Cm plugin toggle, plugin toggle fqdn
 527 Toggle plugin execution for the current FQDN.
 528 .It Cm plugin toggle domain
 529 Toggle plugin execution for the current top level domain.
 530 .It Cm print
 531 Print page.
 532 .It Cm qa , qall , quitall
 533 Quit
 534 .Nm .
 535 .It Cm quit , q
 536 Close current tab and quit
 537 .Nm
 538 if it is the last tab.
 539 .It Cm restart
 540 Restart
 541 .Nm
 542 and reload all current tabs.
 543 .It Cm run_script [path_to_script]
 544 Runs the script path_to_script with the current uri as the argument.
 545 If path_to_script is not provided, the value of default_script is used
 546 instead.
 547 .It Cm script [filename]
 548 Run an external JavaScript script file in the current tab context.
 549 .It Cm session , Cm session show
 550 Display the current session name.
 551 By default the session name is main_session.
 552 To create a new session use the
 553 .Cm session save
 554 command.
 555 A session is defined as the lifetime of the browser application.
 556 .It Cm session delete <session_name>
 557 Delete session session_name from persistent storage.
 558 If session_name is the current session then the session will revert to
 559 main_session.
 560 .It Cm session open <session_name>
 561 Open session_name and close all currently open tabs.
 562 Going forward this session is named session_name.
 563 .It Cm session save <session_name>
 564 Save current tabs to session_name session.
 565 This will close the current session and going forward this session is named
 566 session_name.
 567 .It Cm set
 568 The set command is used to inspect, clear or change runtime options.
 569 There are 3 methods to use
 570 .Cm :set .
 571 When used by itself as
 572 .Cm :set
 573 the command displays all options as currently set.
 574 .Pp
 575 To set a value use
 576 .Cm :set option=value .
 577 For example,
 578 .Cm :set http_proxy=http://127.0.0.1:8080 .
 579 .Pp
 580 To clear a value use
 581 .Cm :set option= .
 582 For example,
 583 .Cm :set http_proxy= .
 584 .Pp
 585 Note, not all options can be set at runtime.
 586 .It Cm stats
 587 Show blocked cookie statistics.
 588 These statistics vary based on settings and are not persistent.
 589 .It Cm statustoggle , statust
 590 Toggle status bar.
 591 .It Cm tabclose
 592 Close current tab.
 593 .It Cm tabhide
 594 Hide tabs.
 595 .It Cm tabnew , tabedit [URL]
 596 Create new tab and optionally open provided URL.
 597 .It Cm tabnext
 598 Go to the next tab.
 599 .It Cm tabprevious
 600 Go to the previous tab.
 601 .It Cm tabshow
 602 Show tabs in GUI.
 603 .It Cm toplevel , toplevel toggle
 604 Toggle the top level domain name cookie and JS session whitelist.
 605 This is to enable/disable short lived full site functionality without
 606 permanently adding the top level domain to the persistent whitelist.
 607 .It Cm urlhide , urlh
 608 Hide url entry and tool bar.
 609 .It Cm urlshow , urls
 610 Show url entry and tool bar.
 611 .It Cm w
 612 Save open tabs to current session.
 613 The tabs will be restored next time the session is opened.
 614 See the session command for additional details.
 615 .It Cm wq
 616 Save open tabs and quit.
 617 The tabs will be restored next time
 618 .Nm
 619 the session is opened.
 620 See the session command for additional details.
 621 .El
 622 .Sh BUFFER COMMANDS
 623 In addition to shortcuts and commands
 624 .Nm
 625 provides buffer commands. Buffer commands are short, multi character
 626 vi-like commands, often requiring an argument. Partial buffer commands
 627 are
 628 displayed in the buffer command statusbar element (see
 629 .Cm statusbar_elems ) .
 630 Pressing Esc or switching to another tab cancels a partially entered
 631 buffer command. In the following list
 632 .Cm arg
 633 denotes the argument a buffer command accepts. Buffer commands are
 634 defined as extended regular experssions.
 635 Note that if a character is used as a shortcut it will not be interpreted
 636 as the beginning of a buffer command. This is the case with
 637 .Cm 0 .
 638 .Pp
 639 .Bl -tag -width "['][a-zA-Z0-9]XXX" -offset indent -compact
 640 .It Cm gg
 641 go to the top of the page
 642 .It Cm gG
 643 go to the bottom of the page
 644 .It Cm [0-9]+%
 645 go to the
 646 .Cm arg
 647 percent of the page
 648 .It Cm [0-9]*gU
 649 go
 650 .Cm arg
 651 levels up. If
 652 .Cm arg
 653 is missing, 1 is assumed. Going a
 654 level up means going to a uri obtained from the current one by removing
 655 the last slash ('/') character and everything that follows it
 656 .It Cm gh
 657 open the home page in the current tab
 658 .It Cm m[a-zA-Z0-9]
 659 set a mark denoted by
 660 .Cm arg
 661 at the current page position. These marks behave like those in vi or
 662 less.
 663 .It Cm ['][a-zA-Z0-9]
 664 go to the position where mark
 665 .Cm arg
 666 was set
 667 .It Cm M[a-zA-Z0-9]
 668 set the current uri as quickmark
 669 .Cm arg
 670 .It Cm go[a-zA-Z0-9]
 671 open the uri marked as quickmark
 672 .Cm arg
 673 in the current tab
 674 .It Cm gn[a-zA-Z0-9]
 675 open the uri marked as quickmark
 676 .Cm arg
 677 in a new tab
 678 .It Cm [0-9]+t
 679 activate tab number
 680 .Cm arg
 681 .It Cm ZZ
 682 quit
 683 .Nm
 684 .It Cm ZR
 685 restart
 686 .Nm
 687 .It Cm zi
 688 zoom in by 4%
 689 .It Cm zo
 690 zoom out by 4%
 691 .It Cm z0
 692 set zoom level to 100%
 693 .It Cm [0-9]+Z
 694 set zoom level to
 695 .Cm arg
 696 %
 697 .El
 698 .Sh QUICKMARKS
 699 Quickmarks are like bookmarks, except they are refered to by a single
 700 character (a letter or a digit), instead of a longer name. See the
 701 .Cm M[a-zA-Z0-9] ,
 702 .Cm go[a-zA-Z0-9]
 703 and
 704 .Cm gn[a-zA-Z0-9]
 705 buffer commands for usage. Quickmarks are stored in
 706 .Pa ~/.xxxterm/quickmarks
 707 and are saved automatically after each
 708 .Cm M[a-zA-Z0-9]
 709 buffer command.
 710 .Sh ABOUT SCREENS
 711 The about screens are internally generated web pages by
 712 .Nm
 713 for user interaction.
 714 These are entered in the address bar and the format is
 715 .Cm about:screen
 716 where screen is the desired screen to display.
 717 For example about:favorites.
 718 Any about screen can be used as the home page as specified by
 719 .Cm home
 720 in the configuration file.
 721 .Pp
 722 .Bl -tag -width "downloadsXXX" -offset indent -compact
 723 .It Cm about
 724 show the about screen
 725 .It Cm blank
 726 show a blank screen
 727 .It Cm cookiewl
 728 show the cookie whitelist screen
 729 .It Cm cookiejar
 730 show the cookiejar screen
 731 .It Cm downloads
 732 show the downloads screen
 733 .It Cm favorites
 734 show the favorites screen
 735 .It Cm help
 736 show the help web page
 737 .It Cm history
 738 show the history screen
 739 .It Cm jswl
 740 show the Java Script whitelist screen
 741 .It Cm set
 742 show the settings screen
 743 .It Cm stats
 744 show the statistics screen
 745 .El
 746 .Sh WHITELISTS
 747 This section describes advanced usage settings.
 748 Most users should use
 749 .Cm browser_mode
 750 instead to setup
 751 .Nm
 752 and skip over this section.
 753 .Pp
 754 .Nm
 755 has a number of whitelists to control blocking cookies and Java Script
 756 execution for FQDNs or domains.
 757 When properly enabled these whitelists require either the FQDN or top level
 758 domain to exist in the whitelists in order to allow cookies to be stored or
 759 Java Script to execute.
 760 Both Java Script and cookies have two whitelists associated with them.
 761 The whitelists are called session and persistent.
 762 Items in the session whitelists are only allowed for the lifetime of the
 763 .Nm
 764 instance.
 765 Items in the persistent whitelists are stored on disk and are restored
 766 upon restarting.
 767 .Pp
 768 Setting up the whitelists is a little tricky due to intricacies of WebKit.
 769 In fact the semantics are different for cookies and Java Script.
 770 .Pp
 771 Cookie whitelist requires the following configuration to be set:
 772 .Pp
 773 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 774 .It Cm cookies_enabled
 775 This is a WebKit setting and must be set to
 776 .Pa 1
 777 (ENABLED)
 778 in order to be able to use a
 779 cookie whitelist.
 780 .It Cm enable_cookie_whitelist
 781 This needs to be set to
 782 .Pa 1
 783 to enable the cookie whitelist functionality.
 784 .It Cm cookie_wl
 785 These entries in the configuration file are the actual domains names in the
 786 cookie whitelist.
 787 .El
 788 .Pp
 789 Java Script whitelist requires the following configuration to be set:
 790 .Pp
 791 .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
 792 .It Cm enable_scripts
 793 This is a WebKit setting and must be set to
 794 .Pa 0
 795 (DISABLED)
 796 in order to be able to use a
 797 Java Script whitelist.
 798 .It Cm enable_js_whitelist
 799 This needs to be set to
 800 .Pa 1
 801 to enable the Java Script whitelist functionality.
 802 .It Cm js_wl
 803 These entries in the configuration file are the actual domains names in the
 804 Java Script whitelist.
 805 .El
 806 .Pp
 807 Plugin whitelist requires the following configuration to be set:
 808 .Pp
 809 .Bl -tag -width "enable_plugin_whitelistXXX" -offset indent -compact
 810 .It Cm enable_plugins
 811 This is a WebKit setting and must be set to
 812 .Pa 1
 813 (ENABLED)
 814 in order to be able to use a
 815 plugin whitelist.
 816 .It Cm enable_plugin_whitelist
 817 This needs to be set to
 818 .Pa 1
 819 to enable the plugin whitelist functionality.
 820 .It Cm pl_wl
 821 These entries in the configuration file are the actual domains names in the
 822 plugin whitelist.
 823 .El
 824 .Pp
 825 See the
 826 .Pa FILES
 827 section for additional configuration file entries and details
 828 that alter runtime behavior.
 829 .Sh FILES
 830 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 831 .It Pa ~/.xxxterm.conf
 832 .Nm
 833 user specific settings.
 834 .It Pa ~/.xxxterm
 835 .Nm
 836 scratch directory.
 837 .El
 838 .Pp
 839 .Nm
 840 tries to open the user specific file,
 841 .Pa ~/.xxxterm.conf .
 842 If that file is unavailable,
 843 it then uses built-in defaults.
 844 .Pp
 845 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 846 For example:
 847 .Pp
 848 .Dl http_proxy = http://127.0.0.1:8080
 849 .Pp
 850 Enabling or disabling an option is done by using 1 or 0 respectively.
 851 .Pp
 852 The file supports the following keywords:
 853 .Pp
 854 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 855 .It Cm alias
 856 Defines an alias for a given URL, so that the URL is loaded when the alias is
 857 entered in the address bar.
 858 If the aliased URL includes a %s format specifier, then any argument given after
 859 the alias on the address bar is substituted.
 860 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
 861 then the URL http://www.google.com/search?q=foo is loaded when navigating to
 862 "g foo".
 863 .It Cm allow_volatile_cookies
 864 If set cookies are stored in the session cache but will be discarded once
 865 .Nm
 866 exits.
 867 Unfortunately enabling this does allow for some limited tracking on the web.
 868 .It Cm append_next
 869 When set a new tab is appended after the current tab instead of being appended
 870 as the last tab.
 871 .It Cm autofocus_onload
 872 When set a tab that is loaded will attempt to autofocus the default input
 873 entry.
 874 This is only done for tabs that are currently visible.
 875 .It Cm browser_mode
 876 The
 877 .Nm
 878 browser has 3 default operating modes:
 879 .Pa normal
 880 (the default),
 881 .Pa whitelist
 882 and
 883 .Pa kiosk .
 884 In the
 885 .Pa normal
 886 mode the browser allows all cookies, plugins and Java Script as any other
 887 browser would.
 888 This means that all cookies are saved to persistent storage and that all
 889 Java Script and plugins run.
 890 .Pp
 891 On the other hand, using the
 892 .Pa whitelist
 893 mode enables whitelists.
 894 This requires the user to add all the required
 895 .Pa cookie_wl ,
 896 .Pa js_wl
 897 and
 898 .Pa pl_wl
 899 items.
 900 If a domain does not appear in the whitelists
 901 .Nm
 902 disallows cookies, Java Script and plugin execution.
 903 .Pp
 904 In
 905 .Pa kiosk
 906 mode the browse works just like
 907 .Pa normal
 908 mode however the toolbar only has the backward, forward and home button.
 909 .Pp
 910 This setting must be the first entry in
 911 .Pa ~/.xxxterm.conf
 912 because it sets advanced settings that can be overridden later in the file.
 913 See the default config file for more details.
 914 .It Cm cmd_font
 915 Set the command prompt font.
 916 E.g.
 917 .Pa cmd_font = monospace normal 9 .
 918 .It Cm cookie_policy
 919 This field delineates the cookie policy.
 920 Possible values are: no3rdparty, reject 3rd party cookies.
 921 accept, accept all cookies.
 922 reject, reject all cookies.
 923 .It Cm cookie_wl
 924 This is a cookie whitelist item.
 925 Use multiple times to add multiple entries.
 926 Valid entries are for example *.moo.com and the equivalent .moo.com.
 927 A fully qualified host is also valid and is for example www.moo.com.
 928 .It Cm cookies_enabled
 929 Enable cookies.
 930 .It Cm ctrl_click_focus
 931 Give focus in newly created tab instead of opening it in the background.
 932 .It Cm default_script
 933 Path to the script used as the default value for the run_script
 934 command.
 935 .It Cm default_zoom_level
 936 Set the default browsing zoom level.
 937 .It Cm download_dir
 938 Locations where files are downloaded to.
 939 This directory must exist and
 940 .Nm
 941 validates that during startup.
 942 .It Cm enable_cookie_whitelist
 943 When enabled all cookies must be in the whitelist or they are rejected.
 944 Additionally whitelisted cookies also enable HTML5 local storage for the
 945 domain.
 946 .It Cm enable_js_whitelist
 947 When enabled all domains must be in the js whitelist in order to run Java
 948 Script.
 949 NOTE: Make sure
 950 .Cm enable_scripts
 951 is set to 0.
 952 .It Cm enable_plugin_whitelist
 953 When enabled all domains must be in the plugin whitelist in order to run
 954 plugins.
 955 NOTE: Make sure
 956 .Cm enable_plugins
 957 is set to 0.
 958 .It Cm enable_plugins
 959 Enable external plugins such as Flash and Java.
 960 .It Cm enable_scripts
 961 Enable Java Script.
 962 .It Cm enable_socket
 963 When enabled the first instance of
 964 .Nm
 965 will create a socket in the
 966 .Pa ~/.xxxterm
 967 directory.
 968 Using the -n url option on subsequent
 969 .Nm
 970 invocations will cause the specified URL to be loaded in a new tab.
 971 Only a user with identical UID and GID can use this option.
 972 .It Cm enable_localstorage
 973 Enable html5 Local Storage.
 974 .It Cm enable_spell_checking
 975 Enables spell checking. Preferred languages can be set using
 976 .Cm spell_check_languages
 977 option.
 978 .It Cm encoding
 979 Set the default encoding.
 980 E.g.
 981 .Pa encoding = ISO-8859-1 .
 982 .It Cm fancy_bar
 983 Enables a backward, forward, and stop button to the toolbar.
 984 Additionally if
 985 .Cm search_string
 986 is set it'll enable an entry box for searches.
 987 .It Cm guess_search
 988 When enabled
 989 .Nm
 990 will try to guess if the string you entered, in the URI entry widget or
 991 the command widget, is term you want to search for using search_string
 992 (see above).
 993 If the string does not contain a dot nor a slash, is not a
 994 path to a local file and does not resolves to an IP then it is assumed
 995 to be a search term.
 996 .It Cm history_autosave
 997 When enabled
 998 .Nm
 999 will save all command and search history.
1000 Upon restarting
1001 .Nm
1002 the saved command and search history will be restored.
1003 .It Cm home
1004 Homepage in URL format.
1005 .It Cm http_proxy
1006 Proxy server in URL format.
1007 .Nm
1008 overrides
1009 .Cm http_proxy
1010 if it is specified as an environment variable.
1011 It must be noted that on older webkit versions one MUST use an IP address and
1012 not a FQDN.
1013 This works as expected with webkit 1.4.2.
1014 .Pp
1015 If one desires to use a socks proxy then an intermediary tool must be used.
1016 It has been reported that tsocks works with
1017 .Nm .
1018 .It Cm icon_size
1019 Permits icon sizes to be changed if
1020 .Cm fancy_bar
1021 is enabled.
1022 Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
1023 .It Cm js_wl
1024 This is a Java Script whitelist item.
1025 See
1026 .Cm cookie_wl
1027 for semantics and more details.
1028 .It Cm max_connections
1029 The maximum number of connections that
1030 .Nm
1031 can open at once.
1032 .It Cm max_host_connections
1033 The maximum number of connections that
1034 .Nm
1035 can open at once to a given host.
1036 .It Cm mime_type
1037 Sets an action for a specific or default MIME type.
1038 For example, to download and view a pdf using kpdf set
1039 .Pa mime_type = application/pdf,kpdf .
1040 To set a default value use *, for example,
1041 .Pa mime_type = video/*,mplayer .
1042 Note that the action is only passed the URL and not all applications are
1043 capable of dealing with a URL and therefore one might have to create a wrapper
1044 script to download the content first.  Alternatively one can add the
1045 .Pa @
1046 in front of the MIME type to indicate "download first".
1047 For example,
1048 .Pa mime_type = @application/pdf,xpdf .
1049 When
1050 .Pa @
1051 is use the file will be downloaded to the
1052 .Pa download_dir
1053 before the MIME handler is called.
1054 .It Cm oops_font
1055 Set the font used to display error messages.
1056 E.g.
1057 .Pa oops_font = monospace normal 9 .
1058 .It Cm pl_wl
1059 This is a plugin whitelist item.
1060 See
1061 .Cm cookie_wl
1062 for semantics and more details.
1063 .It Cm read_only_cookies
1064 Mark cookies file read-only and discard all cookies once the session is
1065 terminated.
1066 .It Cm refresh_interval
1067 Refresh interval while in the download manager.
1068 The default is 10.
1069 .It Cm resource_dir
1070 Directory that contains various
1071 .Nm
1072 resources such as icons.
1073 This is OS-specific and should be handled by the porter.
1074 .It Cm save_global_history
1075 If set the global history will be saved to
1076 .Pa ~/.xxxterm/history
1077 when quitting
1078 and restored at startup.
1079 See the
1080 .Sx KEY BINDINGS
1081 section above for how the global history is accessed.
1082 Global history is not saved to disk by default.
1083 .It Cm save_rejected_cookies
1084 Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
1085 All cookies are saved and unlike a cookie jar they are never replaced.
1086 Make sure there is enough disk space to enable this feature.
1087 .It Cm search_string
1088 Default search engine string.
1089 See the
1090 .Pa xxxterm.conf
1091 file for details.
1092 .It Cm session_autosave
1093 Enable session auto-saving when changing state (e.g. adding or removing a tab).
1094 The session name is what is currently in use and is described in the
1095 .Cm session save
1096 and
1097 .Cm session open
1098 commands.
1099 .It Cm session_timeout
1100 This value is the time that is added in seconds to a session cookie.
1101 .It Cm show_tabs
1102 Enable or disable showing tabs.
1103 .It Cm show_url
1104 Enable or disable showing the url and toolbar.
1105 .It Cm show_statusbar
1106 Enable or disable showing the status bar.
1107 .It Cm single_instance
1108 If set and
1109 .Cm enable_socket
1110 is enabled only one
1111 .Nm
1112 will be permitted to run.
1113 If there is a URL specified it will be opened in a new tab in the already
1114 running
1115 .Nm
1116 session.
1117 .It Cm spell_check_languages
1118 The languages to be used for spell checking, separated by commas. For example,
1119 en_US.
1120 .It Cm ssl_ca_file
1121 If set to a valid PEM file
1122 all server certificates will be validated against it.
1123 The URL bar will be colored green (or blue when saved ) when the certificate is
1124 trusted and yellow when untrusted.
1125 .Pp
1126 If
1127 .Cm ssl_ca_file
1128 is not set then the URL bar will color all HTTPS connections red.
1129 .Pp
1130 WebKit only supports a single PEM file.
1131 Many OS' or distributions have many PEM files.
1132 One can simply concatenate all separate files into one large one.
1133 E.g.
1134 .Cm for i in `ls`; do cat $i >> cert.pem; done
1135 and use the resulting cert.pem file as the input to
1136 .Cm ssl_ca_file .
1137 It is advisable to periodically recreate the cert.pem file.
1138 .It Cm ssl_strict_certs
1139 If this value is set connections to untrusted sites will be aborted.
1140 This value is only used if
1141 .Cm ssl_ca_file
1142 is set.
1143 .It Cm statusbar_elems
1144 Define the components of the status bar. The possible components are:
1145 .Bd -literal -offset indent
1146 | - separator
1147 P - page progress percent
1148 B - buffer command
1149 Z - page zoom level
1150 .Ed
1151 The default is "BP".
1152 These components show nothing if there is nothing worth showing, like
1153 zoom amount 100%.
1154 .It Cm statusbar_font
1155 Set the status bar font.
1156 E.g.
1157 .Pa statusbar_font = monospace normal 9 .
1158 .It Cm tab_style
1159 Set the tab style to either
1160 .Cm normal
1161 - the default gtk notebook tabs, or
1162 .Cm compact
1163 for an alternative.
1164 You can switch the tab style with the
1165 .Pa tabnextstyle
1166 command.
1167 .It Cm tabbar_font
1168 Set the compact tab bar font.
1169 E.g.
1170 .Pa tabbar_font = monospace normal 9 .
1171 .It Cm url_regex
1172 This is the regular expression that is used to match what constitutes a valid
1173 URL when using
1174 .Pa guess_search .
1175 .It Cm user_agent
1176 Set to override the default
1177 .Nm
1178 user-agent string.
1179 .It Cm window_height
1180 Set the default height of the browser window.
1181 .It Cm window_width
1182 Set the default width of the browser window.
1183 .It Cm work_dir
1184 Set the work directory where all
1185 .Nm
1186 scratch files are stored.
1187 Default is
1188 .Cm ~/.xxxterm .
1189 .It Cm xterm_workaround
1190 When enabled
1191 .Nm
1192 will look additionally at CUT_BUFFER0 if PRIMARY clipboard is empty.
1193 Additionally when the PRIMARY clipboard is cleared it will copy CUT_BUFFER0
1194 into the PRIMARY clipboard.
1195 Default is 0.
1196 .El
1197 .Sh HISTORY
1198 .Nm
1199 was inspired by vimprobable2 and the bloat in other
1200 .Ux
1201 web browsers.
1202 .Sh AUTHORS
1203 .An -nosplit
1204 .Nm
1205 was written by
1206 .An Marco Peereboom Aq marco@peereboom.us ,
1207 .An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
1208 .An Edd Barrett Aq vext01@gmail.com ,
1209 .An Todd T. Fries Aq todd@fries.net ,
1210 .An Raphael Graf Aq r@undefined.ch ,
1211 and
1212 .An Michal Mazurek Aq akfaew@jasminek.net .
1213 .Sh BUGS
1214 When
1215 .Cm save_global_history
1216 is enabled
1217 .Nm
1218 is supposed to, in addition to restoring the global history, color the
1219 visited links accordingly; however due to bug #51747 in WebKit this does
1220 not happen.