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 F2
 217 Alias for ":proxy toggle"
 218 .It Cm F4
 219 Alias for ":toplevel toggle"
 220 .It Cm F9
 221 Alias for ":open"
 222 .Pq Cm promptopen
 223 .It Cm F10
 224 Alias for ":open current-uri"
 225 .Pq Cm promptopencurrent
 226 .It Cm F11
 227 Alias for ":tabnew"
 228 .Pq Cm prompttabnew
 229 .It Cm F12
 230 Alias for ":tabnew current-uri"
 231 .Pq Cm prompttabnewcurrent
 232 .El
 233 .Ss Navigation Commands
 234 These commands allow the user to navigate web pages and,
 235 to some extent,
 236 control the browser.
 237 .Pp
 238 .Bl -tag -width "Space, C-f, PageDownXXX" -offset indent -compact
 239 .It Cm F5, C-r, C-l
 240 Reload page
 241 .Pq Cm reload
 242 .It Cm Backspace, M-Left
 243 Previous page
 244 .Pq Cm goback
 245 .It Cm S-BackSpace, M-Right
 246 Forward page
 247 .Pq Cm goforward
 248 .It Cm j, Down
 249 Next line on page
 250 .Pq Cm scrolldown
 251 .It Cm k, Up
 252 Previous line on page
 253 .Pq Cm scrollup
 254 .It Cm G, End
 255 Bottom of page
 256 .Pq Cm scrollbottom
 257 .It Cm gg, Home
 258 Top of page
 259 .Pq Cm scrolltop
 260 .It Cm Space, C-f, PageDown
 261 Page down
 262 .Pq Cm scrollpagedown
 263 .It Cm C-b, PageUp
 264 Page up
 265 .Pq Cm scrollpageup
 266 .It Cm l, Right
 267 Page right
 268 .Pq Cm scrollright
 269 .It Cm h, Left
 270 Page left
 271 .Pq Cm scrollleft
 272 .It Cm $
 273 Page far right
 274 .Pq Cm scrollfarright
 275 .It Cm 0
 276 Page far left
 277 .Pq Cm scrollfarleft
 278 .It Cm M-f
 279 Favorites
 280 .Pq Cm fav
 281 .It Cm M-j
 282 Cookie jar
 283 .Pq Cm cookiejar
 284 .It Cm M-d
 285 Download manager
 286 .Pq Cm dl
 287 .It Cm C-p
 288 Print page
 289 .Pq Cm print
 290 .It Cm M-h
 291 Global history
 292 .Pq Cm history
 293 .It Cm C-j
 294 Toggle Java Script enabled for FQDN
 295 .Pq Cm js
 296 .It Cm C-s
 297 Toggle source view
 298 .Pq Cm togglesrc
 299 .It Cm M-c
 300 Toggle cookie enabled for FQDN
 301 .Pq Cm cookie
 302 .It Cm M-p
 303 Toggle plugins enabled for FQDN
 304 .Pq Cm plugin
 305 .El
 306 .Ss Tab Manipulation
 307 .Nm
 308 supports tabbed browsing.
 309 That is, web pages may be opened in separate tabs,
 310 allowing the user to quickly move from one page to another,
 311 and back.
 312 These commands then are used to create, destroy, and move between tabs.
 313 .Pp
 314 .Bl -tag -width "C-plus, C-equalXXX" -offset indent -compact
 315 .It Cm C-MB1
 316 Open new tab with the clicked link
 317 .It Cm C-t
 318 Create new tab with focus in URL entry
 319 .Pq Cm tabnew
 320 .It Cm C-T
 321 Create new tab with focus in URL entry as the last tab in the browser
 322 .Pq Cm 999tabnew
 323 .It Cm C-w
 324 Destroy current tab
 325 .Pq Cm tabclose
 326 .It Cm U
 327 Undo close tab
 328 .Pq Cm tabundoclose
 329 .It Cm C-Left, C-PageUp
 330 Go to the previous tab
 331 .Pq Cm tabprevious
 332 .It Cm C-Right, C-PageDown
 333 Go to the next tab
 334 .Pq Cm tabnext
 335 .It Cm C-[1..9]
 336 Jump to page
 337 .Ar N
 338 .Pq Cm tabnext [1..9]
 339 .It Cm C-<
 340 Jump to first page
 341 .Pq Cm tabfirst
 342 .It Cm C->
 343 Jump to last page
 344 .Pq Cm tablast
 345 .It Cm C-minus
 346 Zoom out by 4%
 347 .Pq Cm focusout
 348 .It Cm C-plus, C-equal
 349 Zoom in by 4%
 350 .Pq Cm focusin
 351 .It Cm C-0
 352 Set zoom level to 100%
 353 .Pq Cm focusreset
 354 .El
 355 .Ss Yanking and pasting
 356 These commands copy and paste text to and from the clipboard.
 357 .Pp
 358 .Bl -tag -width Ds -offset indent -compact
 359 .It Cm p
 360 Paste the contents of the clipboard into the address bar
 361 .Pq Cm pasteuricur
 362 .It Cm P
 363 Paste the contents of the clipboard into a new tab
 364 .Pq Cm pasteurinew
 365 .It Cm y
 366 Yank the current URL into the clipboard
 367 .Pq Cm yankuri
 368 .El
 369 .Ss Hyperlink Following
 370 This allows the user to follow hyperlinks
 371 without using a mouse.
 372 Enter the corresponding number to follow the link.
 373 Alternatively one can type the name of the link and when there are no more
 374 possibilities
 375 .Nm
 376 will follow the link.
 377 .Pp
 378 .Bl -tag -width Ds -offset indent -compact
 379 .It Cm f, '.'
 380 Highlight all links and prefix them with a number.
 381 .Pq Cm hinting
 382 .It Cm F, ','
 383 Highlight all links and prefix them with a number but open in a new tab.
 384 .Pq Cm hinting_newtab
 385 .El
 386 .Ss Exiting
 387 Commands to exit the browser.
 388 .Pp
 389 .Bl -tag -width Ds -offset indent -compact
 390 .It Cm C-q
 391 Quit
 392 .Pq Cm quitall
 393 .El
 394 .Ss Low-Contrast Color Scheme
 395 These commands toggle the page style between the default CSS and a
 396 low-contrast color scheme with light grey text on a dark grey background.
 397 .Pp
 398 .Bl -tag -width Ds -offset indent -compact
 399 .It Cm s
 400 Toggle the current tab's style.
 401 .Pq Cm userstyle
 402 .It Cm S
 403 Toggle the global page style mode.
 404 Will also affect new tabs.
 405 .Pq Cm userstyle_global
 406 .El
 407 .Ss Insert-mode commands
 408 The following commands are only available when editing an input-field
 409 .Pp
 410 .Bl -tag -width Ds -offset indent -compact
 411 .It Cm C-i
 412 Edit the contents of the currently active input-element in an external editor.
 413 .Pq Cm editelement
 414 .El
 415 .Sh COMMAND MODE
 416 Command mode works in a similar fashion to the
 417 .Xr vi 1
 418 editor;
 419 it is entered by typing a colon and exited by typing Esc.
 420 The commands and their descriptions are listed below.
 421 .Bl -tag -width Ds -offset indent
 422 .It Cm about , version
 423 Show the "About" page.
 424 .It Cm buffers , ls , tabs
 425 Displays the currently open tabs and lets the user switch tab by typing
 426 the tab number or using the mouse.
 427 .It Cm ca
 428 Display CA certificates.
 429 .It Cm cert , cert show
 430 Download and display certificates of domain on tab.
 431 .It Cm cert save
 432 Save certificate into a local store.
 433 The next time the site is visited it is compared against the store.
 434 If the certificate matches,
 435 the address bar will be blue;
 436 if it doesn't the bar will be red.
 437 .It Cm cookie
 438 The
 439 .Cm cookie
 440 command is used to manipulate the cookie whitelist.
 441 Used by itself it expands to
 442 .Cm cookie show all .
 443 .It Cm cookiejar
 444 Show cookie jar contents.
 445 .It Cm cookie save, cookie save fqdn
 446 Save the current fully qualified domain name (FQDN)
 447 to the persistent whitelist.
 448 For example,
 449 the www.peereboom.us domain would result in saving .www.peereboom.us.
 450 .It Cm cookie save domain
 451 Save the top level domain name to the persistent whitelist.
 452 For example,
 453 the www.peereboom.us domain would result in saving .peereboom.us.
 454 .Pp
 455 This action enables cookies if it is currently disabled for this entry.
 456 .It Cm cookie show all
 457 Show all persistent and session entries in the cookie whitelist.
 458 .It Cm cookie show persistent
 459 Show all persistent entries in the cookie whitelist.
 460 .It Cm cookie show session
 461 Show all session entries in the cookie whitelist.
 462 .It Cm cookie toggle domain
 463 Toggle cookie support for the current top level domain.
 464 .It Cm cookie toggle, cookie toggle fqdn
 465 Toggle cookie support for the current FQDN.
 466 .It Cm dl
 467 Show download manager.
 468 .It Cm encoding <encoding>
 469 If
 470 .Cm <encoding>
 471 is set the tab's encoding will be set to
 472 .Cm <encoding>
 473 and
 474 .Nm
 475 reloads the tab.
 476 If
 477 .Cm <encoding>
 478 is not set
 479 .Nm
 480 will display the current tab encoding.
 481 .It Cm editsrc
 482 Opens the source for the current tab in the editor specified by the
 483 setting
 484 .Cm external_editor
 485 and then checks for changes to the file opened. If it is changed, the
 486 page will be updated.
 487 .It Cm editelement
 488 If a text-element is currently active (<input> or <textarea>), it's
 489 contents will be opened in the same fashion as for the command
 490 .Cm editsrc
 491 above
 492 .It Cm fav
 493 Show favorites.
 494 .It Cm favadd
 495 Add the current page to favorites.
 496 .It Cm fullscreen , f
 497 Toggle hiding tabs and url entry toolbar.
 498 .It Cm h , hist , history
 499 Show global history.
 500 .It Cm help
 501 Show help page.
 502 .It Cm home
 503 Go to home URL.
 504 .It Cm js
 505 The
 506 .Cm js
 507 command is used to manipulate the Java Script whitelist.
 508 Used by itself it expands to
 509 .Cm js show all .
 510 .It Cm js 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 js 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 Java Script if it is currently disabled for this entry.
 520 .It Cm js show all
 521 Shows all persistent and session entries in the JS whitelist.
 522 .It Cm js show persistent
 523 Shows all persistent entries in the JS whitelist.
 524 .It Cm js show session
 525 Shows all session entries in the JS whitelist.
 526 .It Cm js toggle, js toggle fqdn
 527 Toggle Java Script execution for the current FQDN.
 528 .It Cm js toggle domain
 529 Toggle Java Script execution for the current top level domain.
 530 .It Cm loadimages
 531 If auto_load_images is disabled, load all images for current site.
 532 .It Cm open , op , o URL
 533 Open URL.
 534 .It Cm plugin
 535 The
 536 .Cm plugin
 537 command is used to manipulate the plugin whitelist.
 538 Used by itself it expands to
 539 .Cm plugin show all .
 540 .It Cm plugin save, save fqdn
 541 Saves the FQDN to the persistent whitelist.
 542 For example,
 543 the www.peereboom.us domain would result in saving .www.peereboom.us.
 544 .It Cm plugin save domain
 545 Saves the top level domain name to the persistent whitelist.
 546 For example,
 547 the www.peereboom.us domain would result in saving .peereboom.us.
 548 .Pp
 549 This action enables plugins if they are currently disabled for this entry.
 550 .It Cm plugin show all
 551 Shows all persistent and session entries in the plugin whitelist.
 552 .It Cm plugin show persistent
 553 Shows all persistent entries in the plugin whitelist.
 554 .It Cm plugin show session
 555 Shows all session entries in the plugin whitelist.
 556 .It Cm plugin toggle, plugin toggle fqdn
 557 Toggle plugin execution for the current FQDN.
 558 .It Cm plugin toggle domain
 559 Toggle plugin execution for the current top level domain.
 560 .It Cm print
 561 Print page.
 562 .It Cm proxy
 563 The
 564 .Cm proxy
 565 command is used to manipulate the currently set proxy.
 566 Used by itself it expands to
 567 .Cm proxy show .
 568 .It Cm proxy show
 569 Displays the current
 570 .Cm http_proxy
 571 setting.
 572 .It Cm proxy toggle
 573 Enables or disables the proxy for
 574 .Nm .
 575 Note that
 576 .Cm http_proxy
 577 must be set before it can be toggled.
 578 .It Cm qa , qall , quitall
 579 Quit
 580 .Nm .
 581 .It Cm quit , q
 582 Close current tab and quit
 583 .Nm
 584 if it is the last tab.
 585 .It Cm restart
 586 Restart
 587 .Nm
 588 and reload all current tabs.
 589 .It Cm run_script [path_to_script]
 590 Runs the script path_to_script with the current uri as the argument.
 591 If path_to_script is not provided, the value of default_script is used
 592 instead.
 593 .It Cm script [filename]
 594 Run an external JavaScript script file in the current tab context.
 595 .It Cm session , Cm session show
 596 Display the current session name.
 597 By default the session name is main_session.
 598 To create a new session use the
 599 .Cm session save
 600 command.
 601 A session is defined as the lifetime of the browser application.
 602 .It Cm session delete <session_name>
 603 Delete session session_name from persistent storage.
 604 If session_name is the current session then the session will revert to
 605 main_session.
 606 .It Cm session open <session_name>
 607 Open session_name and close all currently open tabs.
 608 Going forward this session is named session_name.
 609 .It Cm session save <session_name>
 610 Save current tabs to session_name session.
 611 This will close the current session and going forward this session is named
 612 session_name.
 613 .It Cm set
 614 The set command is used to inspect, clear or change runtime options.
 615 There are 3 methods to use
 616 .Cm :set .
 617 When used by itself as
 618 .Cm :set
 619 the command displays all options as currently set.
 620 .Pp
 621 To set a value use
 622 .Cm :set option=value .
 623 For example,
 624 .Cm :set http_proxy=http://127.0.0.1:8080 .
 625 .Pp
 626 To clear a value use
 627 .Cm :set option= .
 628 For example,
 629 .Cm :set http_proxy= .
 630 .Pp
 631 Note, not all options can be set at runtime.
 632 .It Cm stats
 633 Show blocked cookie statistics.
 634 These statistics vary based on settings and are not persistent.
 635 .It Cm statustoggle , statust
 636 Toggle status bar.
 637 .It Cm stop
 638 Stop loading the current web page.
 639 .It Cm tabclose
 640 Close current tab.
 641 .It Cm tabhide
 642 Hide tabs.
 643 .It Cm tabnew , tabedit [URL]
 644 Create new tab and optionally open provided URL.
 645 .It Cm tabnext
 646 Go to the next tab.
 647 .It Cm tabprevious
 648 Go to the previous tab.
 649 .It Cm tabshow
 650 Show tabs in GUI.
 651 .It Cm toplevel , toplevel toggle
 652 Toggle the top level domain name cookie and JS session whitelist.
 653 This is to enable/disable short lived full site functionality without
 654 permanently adding the top level domain to the persistent whitelist.
 655 .It Cm urlhide , urlh
 656 Hide url entry and tool bar.
 657 .It Cm urlshow , urls
 658 Show url entry and tool bar.
 659 .It Cm w
 660 Save open tabs to current session.
 661 The tabs will be restored next time the session is opened.
 662 See the session command for additional details.
 663 .It Cm wq
 664 Save open tabs and quit.
 665 The tabs will be restored next time
 666 .Nm
 667 the session is opened.
 668 See the session command for additional details.
 669 .El
 670 .Sh BUFFER COMMANDS
 671 In addition to shortcuts and commands
 672 .Nm
 673 provides buffer commands. Buffer commands are short, multi character
 674 vi-like commands, often requiring an argument. Partial buffer commands
 675 are
 676 displayed in the buffer command statusbar element (see
 677 .Cm statusbar_elems ) .
 678 Pressing Esc or switching to another tab cancels a partially entered
 679 buffer command. In the following list
 680 .Cm arg
 681 denotes the argument a buffer command accepts. Buffer commands are
 682 defined as extended regular experssions.
 683 Note that if a character is used as a shortcut it will not be interpreted
 684 as the beginning of a buffer command. This is the case with
 685 .Cm 0 .
 686 .Pp
 687 .Bl -tag -width "['][a-zA-Z0-9]XXX" -offset indent -compact
 688 .It Cm gg
 689 go to the top of the page
 690 .It Cm gG
 691 go to the bottom of the page
 692 .It Cm [0-9]+%
 693 go to the
 694 .Cm arg
 695 percent of the page
 696 .It Cm zz
 697 go to 50% of the page
 698 .It Cm [0-9]*gu
 699 go
 700 .Cm arg
 701 levels up. If
 702 .Cm arg
 703 is missing, 1 is assumed. Going a
 704 level up means going to a URI obtained from the current one by removing
 705 the last slash ('/') character and everything that follows it
 706 .It Cm gU
 707 go to the root level, i.e. going up as many levels as possible.
 708 .It Cm gh
 709 open the home page in the current tab
 710 .It Cm m[a-zA-Z0-9]
 711 set a mark denoted by
 712 .Cm arg
 713 at the current page position. These marks behave like those in vi or
 714 less.
 715 .It Cm ['][a-zA-Z0-9]
 716 go to the position where mark
 717 .Cm arg
 718 was set
 719 .It Cm M[a-zA-Z0-9]
 720 set the current uri as quickmark
 721 .Cm arg
 722 .It Cm go[a-zA-Z0-9]
 723 open the uri marked as quickmark
 724 .Cm arg
 725 in the current tab
 726 .It Cm gn[a-zA-Z0-9]
 727 open the uri marked as quickmark
 728 .Cm arg
 729 in a new tab
 730 .It Cm [0-9]+t
 731 activate tab number
 732 .It Cm g0
 733 go to first tab
 734 .It Cm g$
 735 go to last tab
 736 .It Cm [0-9]*gt
 737 go to the
 738 .Cm arg
 739 next tab
 740 .It Cm [0-9]*gT
 741 go to the
 742 .Cm arg
 743 previous tab
 744 .Cm arg
 745 .It Cm ZZ
 746 quit
 747 .Nm
 748 .It Cm ZR
 749 restart
 750 .Nm
 751 .It Cm zi
 752 zoom in by 4%
 753 .It Cm zo
 754 zoom out by 4%
 755 .It Cm z0
 756 set zoom level to 100%
 757 .It Cm [0-9]+Z
 758 set zoom level to
 759 .Cm arg
 760 %
 761 .El
 762 .Sh QUICKMARKS
 763 Quickmarks are like bookmarks, except they are refered to by a single
 764 character (a letter or a digit), instead of a longer name. See the
 765 .Cm M[a-zA-Z0-9] ,
 766 .Cm go[a-zA-Z0-9]
 767 and
 768 .Cm gn[a-zA-Z0-9]
 769 buffer commands for usage. Quickmarks are stored in
 770 .Pa ~/.xxxterm/quickmarks
 771 and are saved automatically after each
 772 .Cm M[a-zA-Z0-9]
 773 buffer command.
 774 .Sh ABOUT SCREENS
 775 The about screens are internally generated web pages by
 776 .Nm
 777 for user interaction.
 778 These are entered in the address bar and the format is
 779 .Cm about:screen
 780 where screen is the desired screen to display.
 781 For example about:favorites.
 782 Any about screen can be used as the home page as specified by
 783 .Cm home
 784 in the configuration file.
 785 .Pp
 786 .Bl -tag -width "downloadsXXX" -offset indent -compact
 787 .It Cm about
 788 show the about screen
 789 .It Cm blank
 790 show a blank screen
 791 .It Cm cookiewl
 792 show the cookie whitelist screen
 793 .It Cm cookiejar
 794 show the cookiejar screen
 795 .It Cm downloads
 796 show the downloads screen
 797 .It Cm favorites
 798 show the favorites screen
 799 .It Cm help
 800 show the help web page
 801 .It Cm history
 802 show the history screen
 803 .It Cm jswl
 804 show the Java Script whitelist screen
 805 .It Cm set
 806 show the settings screen
 807 .It Cm stats
 808 show the statistics screen
 809 .El
 810 .Sh WHITELISTS
 811 This section describes advanced usage settings.
 812 Most users should use
 813 .Cm browser_mode
 814 instead to setup
 815 .Nm
 816 and skip over this section.
 817 .Pp
 818 .Nm
 819 has a number of whitelists to control blocking cookies and Java Script
 820 execution for FQDNs or domains.
 821 When properly enabled these whitelists require either the FQDN or top level
 822 domain to exist in the whitelists in order to allow cookies to be stored or
 823 Java Script to execute.
 824 Both Java Script and cookies have two whitelists associated with them.
 825 The whitelists are called session and persistent.
 826 Items in the session whitelists are only allowed for the lifetime of the
 827 .Nm
 828 instance.
 829 Items in the persistent whitelists are stored on disk and are restored
 830 upon restarting.
 831 .Pp
 832 Setting up the whitelists is a little tricky due to intricacies of WebKit.
 833 In fact the semantics are different for cookies and Java Script.
 834 .Pp
 835 Cookie whitelist requires the following configuration to be set:
 836 .Pp
 837 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 838 .It Cm cookies_enabled
 839 This is a WebKit setting and must be set to
 840 .Pa 1
 841 (ENABLED)
 842 in order to be able to use a
 843 cookie whitelist.
 844 .It Cm enable_cookie_whitelist
 845 This needs to be set to
 846 .Pa 1
 847 to enable the cookie whitelist functionality.
 848 .It Cm cookie_wl
 849 These entries in the configuration file are the actual domains names in the
 850 cookie whitelist.
 851 .El
 852 .Pp
 853 Java Script whitelist requires the following configuration to be set:
 854 .Pp
 855 .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
 856 .It Cm enable_scripts
 857 This is a WebKit setting and must be set to
 858 .Pa 0
 859 (DISABLED)
 860 in order to be able to use a
 861 Java Script whitelist.
 862 .It Cm enable_js_whitelist
 863 This needs to be set to
 864 .Pa 1
 865 to enable the Java Script whitelist functionality.
 866 .It Cm js_wl
 867 These entries in the configuration file are the actual domains names in the
 868 Java Script whitelist.
 869 .El
 870 .Pp
 871 Plugin whitelist requires the following configuration to be set:
 872 .Pp
 873 .Bl -tag -width "enable_plugin_whitelistXXX" -offset indent -compact
 874 .It Cm enable_plugins
 875 This is a WebKit setting and must be set to
 876 .Pa 1
 877 (ENABLED)
 878 in order to be able to use a
 879 plugin whitelist.
 880 .It Cm enable_plugin_whitelist
 881 This needs to be set to
 882 .Pa 1
 883 to enable the plugin whitelist functionality.
 884 .It Cm pl_wl
 885 These entries in the configuration file are the actual domains names in the
 886 plugin whitelist.
 887 .El
 888 .Pp
 889 See the
 890 .Pa FILES
 891 section for additional configuration file entries and details
 892 that alter runtime behavior.
 893 .Sh FILES
 894 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 895 .It Pa ~/.xxxterm.conf
 896 .Nm
 897 user specific settings.
 898 .It Pa ~/.xxxterm
 899 .Nm
 900 scratch directory.
 901 .El
 902 .Pp
 903 .Nm
 904 tries to open the user specific file,
 905 .Pa ~/.xxxterm.conf .
 906 If that file is unavailable,
 907 it then uses built-in defaults.
 908 .Pp
 909 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 910 For example:
 911 .Pp
 912 .Dl http_proxy = http://127.0.0.1:8080
 913 .Pp
 914 Enabling or disabling an option is done by using 1 or 0 respectively.
 915 .Pp
 916 The file supports the following keywords:
 917 .Pp
 918 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 919 .It Cm alias
 920 Defines an alias for a given URL, so that the URL is loaded when the alias is
 921 entered in the address bar.
 922 If the aliased URL includes a %s format specifier, then any argument given after
 923 the alias on the address bar is substituted.
 924 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
 925 then the URL http://www.google.com/search?q=foo is loaded when navigating to
 926 "g foo".
 927 .It Cm allow_volatile_cookies
 928 If set cookies are stored in the session cache but will be discarded once
 929 .Nm
 930 exits.
 931 Unfortunately enabling this does allow for some limited tracking on the web.
 932 .It Cm append_next
 933 When set a new tab is appended after the current tab instead of being appended
 934 as the last tab.
 935 .It Cm auto_load_images
 936 If disabled, images will not be loaded automatically.
 937 .It Cm autofocus_onload
 938 When set a tab that is loaded will attempt to autofocus the default input
 939 entry.
 940 This is only done for tabs that are currently visible.
 941 .It Cm browser_mode
 942 The
 943 .Nm
 944 browser has 3 default operating modes:
 945 .Pa normal
 946 (the default),
 947 .Pa whitelist
 948 and
 949 .Pa kiosk .
 950 In the
 951 .Pa normal
 952 mode the browser allows all cookies, plugins and Java Script as any other
 953 browser would.
 954 This means that all cookies are saved to persistent storage and that all
 955 Java Script and plugins run.
 956 .Pp
 957 On the other hand, using the
 958 .Pa whitelist
 959 mode enables whitelists.
 960 This requires the user to add all the required
 961 .Pa cookie_wl ,
 962 .Pa js_wl
 963 and
 964 .Pa pl_wl
 965 items.
 966 If a domain does not appear in the whitelists
 967 .Nm
 968 disallows cookies, Java Script and plugin execution.
 969 .Pp
 970 In
 971 .Pa kiosk
 972 mode the browse works just like
 973 .Pa normal
 974 mode however the toolbar only has the backward, forward and home button.
 975 .Pp
 976 This setting must be the first entry in
 977 .Pa ~/.xxxterm.conf
 978 because it sets advanced settings that can be overridden later in the file.
 979 See the default config file for more details.
 980 .It Cm cmd_font
 981 Set the command prompt font.
 982 E.g.
 983 .Pa cmd_font = monospace normal 9 .
 984 .It Cm color_visited_uris
 985 When enabled (the default)
 986 .Nm
 987 will color visited links. This is done while the web page loads using
 988 JavaScript, rather than WebKit's (broken, see bug #51747) built-in
 989 facility for coloring visited links. The JavaScript approach is
 990 (probably) slower and is not consistent across tabs (unless the tabs are
 991 reloaded), but has the advantage of not leaking history data to web
 992 pages (see http://wtikay.com/docs/details.html).
 993 .It Cm cookie_policy
 994 This field delineates the cookie policy.
 995 Possible values are: no3rdparty, reject 3rd party cookies.
 996 accept, accept all cookies.
 997 reject, reject all cookies.
 998 .It Cm cookie_wl
 999 This is a cookie whitelist item.
1000 Use multiple times to add multiple entries.
1001 Valid entries are for example *.moo.com and the equivalent .moo.com.
1002 A fully qualified host is also valid and is for example www.moo.com.
1003 .It Cm cookies_enabled
1004 Enable cookies.
1005 .It Cm ctrl_click_focus
1006 Give focus in newly created tab instead of opening it in the background.
1007 .It Cm default_script
1008 Path to the script used as the default value for the run_script
1009 command.
1010 .It Cm default_zoom_level
1011 Set the default browsing zoom level.
1012 .It Cm download_dir
1013 Locations where files are downloaded to.
1014 This directory must exist and
1015 .Nm
1016 validates that during startup.
1017 .It Cm download_mode
1018 Controls how downloads are handled.
1019 Possible values are:
1020 .Bd -literal -offset indent
1021 start - automatically start download.
1022 ask   - ask user for confirmation.
1023 add   - add to downloadmanager, but
1024         do not start.
1025 .Ed
1026 The default is "start".
1027 .It Cm enable_autoscroll
1028 When enabled clicking MB3 will spawn the autoscroll ball, scrolling can
1029 then proceed by dragging the mouse away from the ball.
1030 .It Cm enable_cookie_whitelist
1031 When enabled all cookies must be in the whitelist or they are rejected.
1032 Additionally whitelisted cookies also enable HTML5 local storage for the
1033 domain.
1034 .It Cm enable_favicon_entry
1035 When enabled (the default)
1036 .Nm
1037 displays the favicon of the web page at the URI entry. This setting
1038 affects both
1039 .Cm normal
1040 and
1041 .Cm compact
1042 tabs.
1043 .It Cm enable_favicon_tabs
1044 When enabled (disabled by default)
1045 .Nm
1046 displays favicons at each tab. This setting only affects
1047 .Cm compact
1048 tabs.
1049 .It Cm enable_js_whitelist
1050 When enabled all domains must be in the js whitelist in order to run Java
1051 Script.
1052 NOTE: Make sure
1053 .Cm enable_scripts
1054 is set to 0.
1055 .It Cm enable_plugin_whitelist
1056 When enabled all domains must be in the plugin whitelist in order to run
1057 plugins.
1058 NOTE: Make sure
1059 .Cm enable_plugins
1060 is set to 0.
1061 .It Cm enable_plugins
1062 Enable external plugins such as Flash and Java.
1063 .It Cm enable_scripts
1064 Enable Java Script.
1065 .It Cm enable_socket
1066 When enabled the first instance of
1067 .Nm
1068 will create a socket in the
1069 .Pa ~/.xxxterm
1070 directory.
1071 Using the -n url option on subsequent
1072 .Nm
1073 invocations will cause the specified URL to be loaded in a new tab.
1074 Only a user with identical UID and GID can use this option.
1075 .It Cm enable_localstorage
1076 Enable html5 Local Storage.
1077 .It Cm enable_spell_checking
1078 Enables spell checking. Preferred languages can be set using
1079 .Cm spell_check_languages
1080 option.
1081 .It Cm encoding
1082 Set the default encoding.
1083 E.g.
1084 .Pa encoding = ISO-8859-1 .
1085 .It Cm external_editor
1086 Set which editor to use for external editing.
1087 the string <file> will be replaced by the current filename.
1088 E.g.
1089 .Pa external_editor = gvim -f <file>
1090 Note!
1091 .Cm xxxterm
1092 relies on the editor
1093 .Pa not forking
1094 into the background.
1095 .It Cm fancy_bar
1096 Enables a backward, forward, and stop button to the toolbar.
1097 Additionally if
1098 .Cm search_string
1099 is set it'll enable an entry box for searches.
1100 .It Cm guess_search
1101 When enabled
1102 .Nm
1103 will try to guess if the string you entered, in the URI entry widget or
1104 the command widget, is term you want to search for using search_string
1105 (see above).
1106 If the string does not contain a dot nor a slash, is not a
1107 path to a local file and does not resolves to an IP then it is assumed
1108 to be a search term.
1109 .It Cm gui_mode
1110 To simplify configuring
1111 .Nm
1112 allows you pick between two GUI modes:
1113 .Pa classic
1114 (the default) and
1115 .Pa minimal .
1116 In the
1117 .Pa classic
1118 mode the GUI looks similar to that of most mainstream browsers. While in
1119 .Pa minimal
1120 mode the GUI looks more vi-like. One can get a GUI between the two by
1121 tweaking the low-level GUI settings found under the advanced GUI setting
1122 section in the configuration file.
1123 .It Cm history_autosave
1124 When enabled
1125 .Nm
1126 will save all command and search history.
1127 Upon restarting
1128 .Nm
1129 the saved command and search history will be restored.
1130 .It Cm home
1131 Homepage in URL format.
1132 .It Cm http_proxy
1133 Proxy server in URL format.
1134 .Nm
1135 overrides
1136 .Cm http_proxy
1137 if it is specified as an environment variable.
1138 It must be noted that on older webkit versions one MUST use an IP address and
1139 not a FQDN.
1140 This works as expected with webkit 1.4.2.
1141 .Pp
1142 If one desires to use a socks proxy then an intermediary tool must be used.
1143 It has been reported that tsocks works with
1144 .Nm .
1145 .It Cm icon_size
1146 Permits icon sizes to be changed if
1147 .Cm fancy_bar
1148 is enabled.
1149 Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
1150 .It Cm js_wl
1151 This is a Java Script whitelist item.
1152 See
1153 .Cm cookie_wl
1154 for semantics and more details.
1155 .It Cm max_connections
1156 The maximum number of connections that
1157 .Nm
1158 can open at once.
1159 .It Cm max_host_connections
1160 The maximum number of connections that
1161 .Nm
1162 can open at once to a given host.
1163 .It Cm mime_type
1164 Sets an action for a specific or default MIME type.
1165 For example, to download and view a pdf using kpdf set
1166 .Pa mime_type = application/pdf,kpdf .
1167 To set a default value use *, for example,
1168 .Pa mime_type = video/*,mplayer .
1169 Note that the action is only passed the URL and not all applications are
1170 capable of dealing with a URL and therefore one might have to create a wrapper
1171 script to download the content first.  Alternatively one can add the
1172 .Pa @
1173 in front of the MIME type to indicate "download first".
1174 For example,
1175 .Pa mime_type = @application/pdf,xpdf .
1176 When
1177 .Pa @
1178 is use the file will be downloaded to the
1179 .Pa download_dir
1180 before the MIME handler is called.
1181 .It Cm oops_font
1182 Set the font used to display error messages.
1183 E.g.
1184 .Pa oops_font = monospace normal 9 .
1185 .It Cm pl_wl
1186 This is a plugin whitelist item.
1187 See
1188 .Cm cookie_wl
1189 for semantics and more details.
1190 .It Cm read_only_cookies
1191 Mark cookies file read-only and discard all cookies once the session is
1192 terminated.
1193 .It Cm refresh_interval
1194 Refresh interval while in the download manager.
1195 The default is 10.
1196 .It Cm referer
1197 Control how 'Referer' is handled in http-requests.
1198 .Bd -literal -offset indent
1199 always      - always send referer
1200 never       - never send referer
1201 same-domain - only send referer if it's
1202               for the same domain
1203 .Ed
1204 Any other value that is also a valid URL will use this
1205 custom value as referer. (E.g. you could set it to http://no-referer.com)
1206 The default value is "always"
1207 .It Cm resource_dir
1208 Directory that contains various
1209 .Nm
1210 resources such as icons.
1211 This is OS-specific and should be handled by the porter.
1212 .It Cm save_global_history
1213 If set the global history will be saved to
1214 .Pa ~/.xxxterm/history
1215 when quitting
1216 and restored at startup.
1217 See the
1218 .Sx KEY BINDINGS
1219 section above for how the global history is accessed.
1220 Global history is not saved to disk by default.
1221 .It Cm save_rejected_cookies
1222 Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
1223 All cookies are saved and unlike a cookie jar they are never replaced.
1224 Make sure there is enough disk space to enable this feature.
1225 .It Cm search_string
1226 Default search engine string.
1227 See the
1228 .Pa xxxterm.conf
1229 file for details.
1230 .It Cm session_autosave
1231 Enable session auto-saving when changing state (e.g. adding or removing a tab).
1232 The session name is what is currently in use and is described in the
1233 .Cm session save
1234 and
1235 .Cm session open
1236 commands.
1237 .It Cm session_timeout
1238 This value is the time that is added in seconds to a session cookie.
1239 .It Cm show_tabs
1240 Enable or disable showing tabs.
1241 .It Cm show_url
1242 Enable or disable showing the url and toolbar.
1243 .It Cm show_statusbar
1244 Enable or disable showing the status bar.
1245 .It Cm single_instance
1246 If set and
1247 .Cm enable_socket
1248 is enabled only one
1249 .Nm
1250 will be permitted to run.
1251 If there is a URL specified it will be opened in a new tab in the already
1252 running
1253 .Nm
1254 session.
1255 .It Cm spell_check_languages
1256 The languages to be used for spell checking, separated by commas. For example,
1257 en_US.
1258 .It Cm ssl_ca_file
1259 If set to a valid PEM file
1260 all server certificates will be validated against it.
1261 The URL bar will be colored green (or blue when saved ) when the certificate is
1262 trusted and yellow when untrusted.
1263 .Pp
1264 If
1265 .Cm ssl_ca_file
1266 is not set then the URL bar will color all HTTPS connections red.
1267 .Pp
1268 WebKit only supports a single PEM file.
1269 Many OS' or distributions have many PEM files.
1270 One can simply concatenate all separate files into one large one.
1271 E.g.
1272 .Cm for i in `ls`; do cat $i >> cert.pem; done
1273 and use the resulting cert.pem file as the input to
1274 .Cm ssl_ca_file .
1275 It is advisable to periodically recreate the cert.pem file.
1276 .It Cm ssl_strict_certs
1277 If this value is set connections to untrusted sites will be aborted.
1278 This value is only used if
1279 .Cm ssl_ca_file
1280 is set.
1281 .It Cm statusbar_elems
1282 Define the components of the status bar. The possible components are:
1283 .Bd -literal -offset indent
1284 | - separator
1285 P - page progress percent
1286 B - buffer command
1287 Z - page zoom level
1288 .Ed
1289 The default is "BP".
1290 These components show nothing if there is nothing worth showing, like
1291 zoom amount 100%.
1292 .It Cm statusbar_font
1293 Set the status bar font.
1294 E.g.
1295 .Pa statusbar_font = monospace normal 9 .
1296 .It Cm tab_style
1297 Set the tab style to either
1298 .Cm normal
1299 - the default gtk notebook tabs, or
1300 .Cm compact
1301 for an alternative.
1302 You can switch the tab style with the
1303 .Pa tabnextstyle
1304 command.
1305 .It Cm tabbar_font
1306 Set the compact tab bar font.
1307 E.g.
1308 .Pa tabbar_font = monospace normal 9 .
1309 .It Cm url_regex
1310 This is the regular expression that is used to match what constitutes a valid
1311 URL when using
1312 .Pa guess_search .
1313 .It Cm user_agent
1314 Set to override the default
1315 .Nm
1316 user-agent string. May be specified several times for switching between
1317 user-agents.
1318 .It Cm window_height
1319 Set the default height of the browser window.
1320 .It Cm window_width
1321 Set the default width of the browser window.
1322 .It Cm window_maximize
1323 Maximize the browser window at startup.
1324 .It Cm work_dir
1325 Set the work directory where all
1326 .Nm
1327 scratch files are stored.
1328 Default is
1329 .Cm ~/.xxxterm .
1330 .It Cm xterm_workaround
1331 When enabled
1332 .Nm
1333 will look additionally at CUT_BUFFER0 if PRIMARY clipboard is empty.
1334 Additionally when the PRIMARY clipboard is cleared it will copy CUT_BUFFER0
1335 into the PRIMARY clipboard.
1336 Default is 0.
1337 .El
1338 .Sh HISTORY
1339 .Nm
1340 was inspired by vimprobable2 and the bloat in other
1341 .Ux
1342 web browsers.
1343 .Sh AUTHORS
1344 .An -nosplit
1345 .Nm
1346 was written by
1347 .An Marco Peereboom Aq marco@peereboom.us ,
1348 .An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
1349 .An Edd Barrett Aq vext01@gmail.com ,
1350 .An Todd T. Fries Aq todd@fries.net ,
1351 .An Raphael Graf Aq r@undefined.ch ,
1352 and
1353 .An Michal Mazurek Aq akfaew@jasminek.net .