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 zz
 649 go to 50% of the page
 650 .It Cm [0-9]*gU
 651 go
 652 .Cm arg
 653 levels up. If
 654 .Cm arg
 655 is missing, 1 is assumed. Going a
 656 level up means going to a uri obtained from the current one by removing
 657 the last slash ('/') character and everything that follows it
 658 .It Cm gh
 659 open the home page in the current tab
 660 .It Cm m[a-zA-Z0-9]
 661 set a mark denoted by
 662 .Cm arg
 663 at the current page position. These marks behave like those in vi or
 664 less.
 665 .It Cm ['][a-zA-Z0-9]
 666 go to the position where mark
 667 .Cm arg
 668 was set
 669 .It Cm M[a-zA-Z0-9]
 670 set the current uri as quickmark
 671 .Cm arg
 672 .It Cm go[a-zA-Z0-9]
 673 open the uri marked as quickmark
 674 .Cm arg
 675 in the current tab
 676 .It Cm gn[a-zA-Z0-9]
 677 open the uri marked as quickmark
 678 .Cm arg
 679 in a new tab
 680 .It Cm [0-9]+t
 681 activate tab number
 682 .Cm arg
 683 .It Cm ZZ
 684 quit
 685 .Nm
 686 .It Cm ZR
 687 restart
 688 .Nm
 689 .It Cm zi
 690 zoom in by 4%
 691 .It Cm zo
 692 zoom out by 4%
 693 .It Cm z0
 694 set zoom level to 100%
 695 .It Cm [0-9]+Z
 696 set zoom level to
 697 .Cm arg
 698 %
 699 .El
 700 .Sh QUICKMARKS
 701 Quickmarks are like bookmarks, except they are refered to by a single
 702 character (a letter or a digit), instead of a longer name. See the
 703 .Cm M[a-zA-Z0-9] ,
 704 .Cm go[a-zA-Z0-9]
 705 and
 706 .Cm gn[a-zA-Z0-9]
 707 buffer commands for usage. Quickmarks are stored in
 708 .Pa ~/.xxxterm/quickmarks
 709 and are saved automatically after each
 710 .Cm M[a-zA-Z0-9]
 711 buffer command.
 712 .Sh ABOUT SCREENS
 713 The about screens are internally generated web pages by
 714 .Nm
 715 for user interaction.
 716 These are entered in the address bar and the format is
 717 .Cm about:screen
 718 where screen is the desired screen to display.
 719 For example about:favorites.
 720 Any about screen can be used as the home page as specified by
 721 .Cm home
 722 in the configuration file.
 723 .Pp
 724 .Bl -tag -width "downloadsXXX" -offset indent -compact
 725 .It Cm about
 726 show the about screen
 727 .It Cm blank
 728 show a blank screen
 729 .It Cm cookiewl
 730 show the cookie whitelist screen
 731 .It Cm cookiejar
 732 show the cookiejar screen
 733 .It Cm downloads
 734 show the downloads screen
 735 .It Cm favorites
 736 show the favorites screen
 737 .It Cm help
 738 show the help web page
 739 .It Cm history
 740 show the history screen
 741 .It Cm jswl
 742 show the Java Script whitelist screen
 743 .It Cm set
 744 show the settings screen
 745 .It Cm stats
 746 show the statistics screen
 747 .El
 748 .Sh WHITELISTS
 749 This section describes advanced usage settings.
 750 Most users should use
 751 .Cm browser_mode
 752 instead to setup
 753 .Nm
 754 and skip over this section.
 755 .Pp
 756 .Nm
 757 has a number of whitelists to control blocking cookies and Java Script
 758 execution for FQDNs or domains.
 759 When properly enabled these whitelists require either the FQDN or top level
 760 domain to exist in the whitelists in order to allow cookies to be stored or
 761 Java Script to execute.
 762 Both Java Script and cookies have two whitelists associated with them.
 763 The whitelists are called session and persistent.
 764 Items in the session whitelists are only allowed for the lifetime of the
 765 .Nm
 766 instance.
 767 Items in the persistent whitelists are stored on disk and are restored
 768 upon restarting.
 769 .Pp
 770 Setting up the whitelists is a little tricky due to intricacies of WebKit.
 771 In fact the semantics are different for cookies and Java Script.
 772 .Pp
 773 Cookie whitelist requires the following configuration to be set:
 774 .Pp
 775 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 776 .It Cm cookies_enabled
 777 This is a WebKit setting and must be set to
 778 .Pa 1
 779 (ENABLED)
 780 in order to be able to use a
 781 cookie whitelist.
 782 .It Cm enable_cookie_whitelist
 783 This needs to be set to
 784 .Pa 1
 785 to enable the cookie whitelist functionality.
 786 .It Cm cookie_wl
 787 These entries in the configuration file are the actual domains names in the
 788 cookie whitelist.
 789 .El
 790 .Pp
 791 Java Script whitelist requires the following configuration to be set:
 792 .Pp
 793 .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
 794 .It Cm enable_scripts
 795 This is a WebKit setting and must be set to
 796 .Pa 0
 797 (DISABLED)
 798 in order to be able to use a
 799 Java Script whitelist.
 800 .It Cm enable_js_whitelist
 801 This needs to be set to
 802 .Pa 1
 803 to enable the Java Script whitelist functionality.
 804 .It Cm js_wl
 805 These entries in the configuration file are the actual domains names in the
 806 Java Script whitelist.
 807 .El
 808 .Pp
 809 Plugin whitelist requires the following configuration to be set:
 810 .Pp
 811 .Bl -tag -width "enable_plugin_whitelistXXX" -offset indent -compact
 812 .It Cm enable_plugins
 813 This is a WebKit setting and must be set to
 814 .Pa 1
 815 (ENABLED)
 816 in order to be able to use a
 817 plugin whitelist.
 818 .It Cm enable_plugin_whitelist
 819 This needs to be set to
 820 .Pa 1
 821 to enable the plugin whitelist functionality.
 822 .It Cm pl_wl
 823 These entries in the configuration file are the actual domains names in the
 824 plugin whitelist.
 825 .El
 826 .Pp
 827 See the
 828 .Pa FILES
 829 section for additional configuration file entries and details
 830 that alter runtime behavior.
 831 .Sh FILES
 832 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 833 .It Pa ~/.xxxterm.conf
 834 .Nm
 835 user specific settings.
 836 .It Pa ~/.xxxterm
 837 .Nm
 838 scratch directory.
 839 .El
 840 .Pp
 841 .Nm
 842 tries to open the user specific file,
 843 .Pa ~/.xxxterm.conf .
 844 If that file is unavailable,
 845 it then uses built-in defaults.
 846 .Pp
 847 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 848 For example:
 849 .Pp
 850 .Dl http_proxy = http://127.0.0.1:8080
 851 .Pp
 852 Enabling or disabling an option is done by using 1 or 0 respectively.
 853 .Pp
 854 The file supports the following keywords:
 855 .Pp
 856 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 857 .It Cm alias
 858 Defines an alias for a given URL, so that the URL is loaded when the alias is
 859 entered in the address bar.
 860 If the aliased URL includes a %s format specifier, then any argument given after
 861 the alias on the address bar is substituted.
 862 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
 863 then the URL http://www.google.com/search?q=foo is loaded when navigating to
 864 "g foo".
 865 .It Cm allow_volatile_cookies
 866 If set cookies are stored in the session cache but will be discarded once
 867 .Nm
 868 exits.
 869 Unfortunately enabling this does allow for some limited tracking on the web.
 870 .It Cm append_next
 871 When set a new tab is appended after the current tab instead of being appended
 872 as the last tab.
 873 .It Cm autofocus_onload
 874 When set a tab that is loaded will attempt to autofocus the default input
 875 entry.
 876 This is only done for tabs that are currently visible.
 877 .It Cm browser_mode
 878 The
 879 .Nm
 880 browser has 3 default operating modes:
 881 .Pa normal
 882 (the default),
 883 .Pa whitelist
 884 and
 885 .Pa kiosk .
 886 In the
 887 .Pa normal
 888 mode the browser allows all cookies, plugins and Java Script as any other
 889 browser would.
 890 This means that all cookies are saved to persistent storage and that all
 891 Java Script and plugins run.
 892 .Pp
 893 On the other hand, using the
 894 .Pa whitelist
 895 mode enables whitelists.
 896 This requires the user to add all the required
 897 .Pa cookie_wl ,
 898 .Pa js_wl
 899 and
 900 .Pa pl_wl
 901 items.
 902 If a domain does not appear in the whitelists
 903 .Nm
 904 disallows cookies, Java Script and plugin execution.
 905 .Pp
 906 In
 907 .Pa kiosk
 908 mode the browse works just like
 909 .Pa normal
 910 mode however the toolbar only has the backward, forward and home button.
 911 .Pp
 912 This setting must be the first entry in
 913 .Pa ~/.xxxterm.conf
 914 because it sets advanced settings that can be overridden later in the file.
 915 See the default config file for more details.
 916 .It Cm cmd_font
 917 Set the command prompt font.
 918 E.g.
 919 .Pa cmd_font = monospace normal 9 .
 920 .It Cm cookie_policy
 921 This field delineates the cookie policy.
 922 Possible values are: no3rdparty, reject 3rd party cookies.
 923 accept, accept all cookies.
 924 reject, reject all cookies.
 925 .It Cm cookie_wl
 926 This is a cookie whitelist item.
 927 Use multiple times to add multiple entries.
 928 Valid entries are for example *.moo.com and the equivalent .moo.com.
 929 A fully qualified host is also valid and is for example www.moo.com.
 930 .It Cm cookies_enabled
 931 Enable cookies.
 932 .It Cm ctrl_click_focus
 933 Give focus in newly created tab instead of opening it in the background.
 934 .It Cm default_script
 935 Path to the script used as the default value for the run_script
 936 command.
 937 .It Cm default_zoom_level
 938 Set the default browsing zoom level.
 939 .It Cm download_dir
 940 Locations where files are downloaded to.
 941 This directory must exist and
 942 .Nm
 943 validates that during startup.
 944 .It Cm enable_cookie_whitelist
 945 When enabled all cookies must be in the whitelist or they are rejected.
 946 Additionally whitelisted cookies also enable HTML5 local storage for the
 947 domain.
 948 .It Cm enable_js_whitelist
 949 When enabled all domains must be in the js whitelist in order to run Java
 950 Script.
 951 NOTE: Make sure
 952 .Cm enable_scripts
 953 is set to 0.
 954 .It Cm enable_plugin_whitelist
 955 When enabled all domains must be in the plugin whitelist in order to run
 956 plugins.
 957 NOTE: Make sure
 958 .Cm enable_plugins
 959 is set to 0.
 960 .It Cm enable_plugins
 961 Enable external plugins such as Flash and Java.
 962 .It Cm enable_scripts
 963 Enable Java Script.
 964 .It Cm enable_socket
 965 When enabled the first instance of
 966 .Nm
 967 will create a socket in the
 968 .Pa ~/.xxxterm
 969 directory.
 970 Using the -n url option on subsequent
 971 .Nm
 972 invocations will cause the specified URL to be loaded in a new tab.
 973 Only a user with identical UID and GID can use this option.
 974 .It Cm enable_localstorage
 975 Enable html5 Local Storage.
 976 .It Cm enable_spell_checking
 977 Enables spell checking. Preferred languages can be set using
 978 .Cm spell_check_languages
 979 option.
 980 .It Cm encoding
 981 Set the default encoding.
 982 E.g.
 983 .Pa encoding = ISO-8859-1 .
 984 .It Cm fancy_bar
 985 Enables a backward, forward, and stop button to the toolbar.
 986 Additionally if
 987 .Cm search_string
 988 is set it'll enable an entry box for searches.
 989 .It Cm guess_search
 990 When enabled
 991 .Nm
 992 will try to guess if the string you entered, in the URI entry widget or
 993 the command widget, is term you want to search for using search_string
 994 (see above).
 995 If the string does not contain a dot nor a slash, is not a
 996 path to a local file and does not resolves to an IP then it is assumed
 997 to be a search term.
 998 .It Cm history_autosave
 999 When enabled
1000 .Nm
1001 will save all command and search history.
1002 Upon restarting
1003 .Nm
1004 the saved command and search history will be restored.
1005 .It Cm home
1006 Homepage in URL format.
1007 .It Cm http_proxy
1008 Proxy server in URL format.
1009 .Nm
1010 overrides
1011 .Cm http_proxy
1012 if it is specified as an environment variable.
1013 It must be noted that on older webkit versions one MUST use an IP address and
1014 not a FQDN.
1015 This works as expected with webkit 1.4.2.
1016 .Pp
1017 If one desires to use a socks proxy then an intermediary tool must be used.
1018 It has been reported that tsocks works with
1019 .Nm .
1020 .It Cm icon_size
1021 Permits icon sizes to be changed if
1022 .Cm fancy_bar
1023 is enabled.
1024 Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
1025 .It Cm js_wl
1026 This is a Java Script whitelist item.
1027 See
1028 .Cm cookie_wl
1029 for semantics and more details.
1030 .It Cm max_connections
1031 The maximum number of connections that
1032 .Nm
1033 can open at once.
1034 .It Cm max_host_connections
1035 The maximum number of connections that
1036 .Nm
1037 can open at once to a given host.
1038 .It Cm mime_type
1039 Sets an action for a specific or default MIME type.
1040 For example, to download and view a pdf using kpdf set
1041 .Pa mime_type = application/pdf,kpdf .
1042 To set a default value use *, for example,
1043 .Pa mime_type = video/*,mplayer .
1044 Note that the action is only passed the URL and not all applications are
1045 capable of dealing with a URL and therefore one might have to create a wrapper
1046 script to download the content first.  Alternatively one can add the
1047 .Pa @
1048 in front of the MIME type to indicate "download first".
1049 For example,
1050 .Pa mime_type = @application/pdf,xpdf .
1051 When
1052 .Pa @
1053 is use the file will be downloaded to the
1054 .Pa download_dir
1055 before the MIME handler is called.
1056 .It Cm oops_font
1057 Set the font used to display error messages.
1058 E.g.
1059 .Pa oops_font = monospace normal 9 .
1060 .It Cm pl_wl
1061 This is a plugin whitelist item.
1062 See
1063 .Cm cookie_wl
1064 for semantics and more details.
1065 .It Cm read_only_cookies
1066 Mark cookies file read-only and discard all cookies once the session is
1067 terminated.
1068 .It Cm refresh_interval
1069 Refresh interval while in the download manager.
1070 The default is 10.
1071 .It Cm resource_dir
1072 Directory that contains various
1073 .Nm
1074 resources such as icons.
1075 This is OS-specific and should be handled by the porter.
1076 .It Cm save_global_history
1077 If set the global history will be saved to
1078 .Pa ~/.xxxterm/history
1079 when quitting
1080 and restored at startup.
1081 See the
1082 .Sx KEY BINDINGS
1083 section above for how the global history is accessed.
1084 Global history is not saved to disk by default.
1085 .It Cm save_rejected_cookies
1086 Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
1087 All cookies are saved and unlike a cookie jar they are never replaced.
1088 Make sure there is enough disk space to enable this feature.
1089 .It Cm search_string
1090 Default search engine string.
1091 See the
1092 .Pa xxxterm.conf
1093 file for details.
1094 .It Cm session_autosave
1095 Enable session auto-saving when changing state (e.g. adding or removing a tab).
1096 The session name is what is currently in use and is described in the
1097 .Cm session save
1098 and
1099 .Cm session open
1100 commands.
1101 .It Cm session_timeout
1102 This value is the time that is added in seconds to a session cookie.
1103 .It Cm show_tabs
1104 Enable or disable showing tabs.
1105 .It Cm show_url
1106 Enable or disable showing the url and toolbar.
1107 .It Cm show_statusbar
1108 Enable or disable showing the status bar.
1109 .It Cm single_instance
1110 If set and
1111 .Cm enable_socket
1112 is enabled only one
1113 .Nm
1114 will be permitted to run.
1115 If there is a URL specified it will be opened in a new tab in the already
1116 running
1117 .Nm
1118 session.
1119 .It Cm spell_check_languages
1120 The languages to be used for spell checking, separated by commas. For example,
1121 en_US.
1122 .It Cm ssl_ca_file
1123 If set to a valid PEM file
1124 all server certificates will be validated against it.
1125 The URL bar will be colored green (or blue when saved ) when the certificate is
1126 trusted and yellow when untrusted.
1127 .Pp
1128 If
1129 .Cm ssl_ca_file
1130 is not set then the URL bar will color all HTTPS connections red.
1131 .Pp
1132 WebKit only supports a single PEM file.
1133 Many OS' or distributions have many PEM files.
1134 One can simply concatenate all separate files into one large one.
1135 E.g.
1136 .Cm for i in `ls`; do cat $i >> cert.pem; done
1137 and use the resulting cert.pem file as the input to
1138 .Cm ssl_ca_file .
1139 It is advisable to periodically recreate the cert.pem file.
1140 .It Cm ssl_strict_certs
1141 If this value is set connections to untrusted sites will be aborted.
1142 This value is only used if
1143 .Cm ssl_ca_file
1144 is set.
1145 .It Cm statusbar_elems
1146 Define the components of the status bar. The possible components are:
1147 .Bd -literal -offset indent
1148 | - separator
1149 P - page progress percent
1150 B - buffer command
1151 Z - page zoom level
1152 .Ed
1153 The default is "BP".
1154 These components show nothing if there is nothing worth showing, like
1155 zoom amount 100%.
1156 .It Cm statusbar_font
1157 Set the status bar font.
1158 E.g.
1159 .Pa statusbar_font = monospace normal 9 .
1160 .It Cm tab_style
1161 Set the tab style to either
1162 .Cm normal
1163 - the default gtk notebook tabs, or
1164 .Cm compact
1165 for an alternative.
1166 You can switch the tab style with the
1167 .Pa tabnextstyle
1168 command.
1169 .It Cm tabbar_font
1170 Set the compact tab bar font.
1171 E.g.
1172 .Pa tabbar_font = monospace normal 9 .
1173 .It Cm url_regex
1174 This is the regular expression that is used to match what constitutes a valid
1175 URL when using
1176 .Pa guess_search .
1177 .It Cm user_agent
1178 Set to override the default
1179 .Nm
1180 user-agent string.
1181 .It Cm window_height
1182 Set the default height of the browser window.
1183 .It Cm window_width
1184 Set the default width of the browser window.
1185 .It Cm work_dir
1186 Set the work directory where all
1187 .Nm
1188 scratch files are stored.
1189 Default is
1190 .Cm ~/.xxxterm .
1191 .It Cm xterm_workaround
1192 When enabled
1193 .Nm
1194 will look additionally at CUT_BUFFER0 if PRIMARY clipboard is empty.
1195 Additionally when the PRIMARY clipboard is cleared it will copy CUT_BUFFER0
1196 into the PRIMARY clipboard.
1197 Default is 0.
1198 .El
1199 .Sh HISTORY
1200 .Nm
1201 was inspired by vimprobable2 and the bloat in other
1202 .Ux
1203 web browsers.
1204 .Sh AUTHORS
1205 .An -nosplit
1206 .Nm
1207 was written by
1208 .An Marco Peereboom Aq marco@peereboom.us ,
1209 .An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
1210 .An Edd Barrett Aq vext01@gmail.com ,
1211 .An Todd T. Fries Aq todd@fries.net ,
1212 .An Raphael Graf Aq r@undefined.ch ,
1213 and
1214 .An Michal Mazurek Aq akfaew@jasminek.net .
1215 .Sh BUGS
1216 When
1217 .Cm save_global_history
1218 is enabled
1219 .Nm
1220 is supposed to, in addition to restoring the global history, color the
1221 visited links accordingly; however due to bug #51747 in WebKit this does
1222 not happen.