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$
  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 Search Commands
 166 These commands are used to search for text strings within a web page.
 167 .Pp
 168 .Bl -tag -width Ds -offset indent -compact
 169 .It Cm /
 170 Start a search
 171 .Pq Cm search
 172 .It Cm \&?
 173 Start a backwards search
 174 .Pq Cm searchb
 175 .It Cm n
 176 Next item matching search
 177 .Pq Cm searchnext
 178 .It Cm N
 179 Previous item matching search
 180 .Pq Cm searchprev
 181 .El
 182 .Ss Focus Commands
 183 These commands are used to shift the focus of
 184 .Nm
 185 from one area to another.
 186 .Pp
 187 .Bl -tag -width Ds -offset indent -compact
 188 .It Cm F6
 189 Focus on address bar
 190 .Pq Cm focusaddress
 191 .It Cm F7
 192 Focus on search entry
 193 .Pq Cm focussearch
 194 .El
 195 .Ss Command Aliases
 196 These commands allow the user to map specific actions to specific keys.
 197 It can be useful when the
 198 .Fl S
 199 option is used.
 200 .Pp
 201 .Bl -tag -width Ds -offset indent -compact
 202 .It Cm F1
 203 Alias for ":help"
 204 .It Cm F4
 205 Alias for ":toplevel toggle"
 206 .It Cm F9
 207 Alias for ":open"
 208 .Pq Cm promptopen
 209 .It Cm F10
 210 Alias for ":open current-uri"
 211 .Pq Cm promptopencurrent
 212 .It Cm F11
 213 Alias for ":tabnew"
 214 .Pq Cm prompttabnew
 215 .It Cm F12
 216 Alias for ":tabnew current-uri"
 217 .Pq Cm prompttabnewcurrent
 218 .El
 219 .Ss Navigation Commands
 220 These commands allow the user to navigate web pages and,
 221 to some extent,
 222 control the browser.
 223 .Pp
 224 .Bl -tag -width "Space, C-f, PageDownXXX" -offset indent -compact
 225 .It Cm F5, C-r, C-l
 226 Reload page
 227 .Pq Cm reload
 228 .It Cm Backspace, M-Left
 229 Previous page
 230 .Pq Cm goback
 231 .It Cm S-BackSpace, M-Right
 232 Forward page
 233 .Pq Cm goforward
 234 .It Cm j, Down
 235 Next line on page
 236 .Pq Cm scrolldown
 237 .It Cm k, Up
 238 Previous line on page
 239 .Pq Cm scrollup
 240 .It Cm G, End
 241 Bottom of page
 242 .Pq Cm scrollbottom
 243 .It Cm gg, Home
 244 Top of page
 245 .Pq Cm scrolltop
 246 .It Cm Space, C-f, PageDown
 247 Page down
 248 .Pq Cm scrollpagedown
 249 .It Cm C-b, PageUp
 250 Page up
 251 .Pq Cm scrollpageup
 252 .It Cm l, Right
 253 Page right
 254 .Pq Cm scrollright
 255 .It Cm h, Left
 256 Page left
 257 .Pq Cm scrollleft
 258 .It Cm $
 259 Page far right
 260 .Pq Cm scrollfarright
 261 .It Cm 0
 262 Page far left
 263 .Pq Cm scrollfarleft
 264 .It Cm M-f
 265 Favorites
 266 .Pq Cm fav
 267 .It Cm M-j
 268 Cookie jar
 269 .Pq Cm cookiejar
 270 .It Cm M-d
 271 Download manager
 272 .Pq Cm dl
 273 .It Cm C-p
 274 Print page
 275 .Pq Cm print
 276 .It Cm M-h
 277 Global history
 278 .Pq Cm history
 279 .It Cm C-j
 280 Toggle Java Script enabled for FQDN
 281 .Pq Cm js
 282 .It Cm C-s
 283 Toggle source view
 284 .Pq Cm togglesrc
 285 .It Cm M-c
 286 Toggle cookie enabled for FQDN
 287 .Pq Cm cookie
 288 .El
 289 .Ss Tab Manipulation
 290 .Nm
 291 supports tabbed browsing.
 292 That is, web pages may be opened in separate tabs,
 293 allowing the user to quickly move from one page to another,
 294 and back.
 295 These commands then are used to create, destroy, and move between tabs.
 296 .Pp
 297 .Bl -tag -width "C-plus, C-equalXXX" -offset indent -compact
 298 .It Cm C-MB1
 299 Open new tab with the clicked link
 300 .It Cm C-t
 301 Create new tab with focus in URL entry
 302 .Pq Cm tabnew
 303 .It Cm C-w
 304 Destroy current tab
 305 .Pq Cm tabclose
 306 .It Cm U
 307 Undo close tab
 308 .Pq Cm tabundoclose
 309 .It Cm C-Left
 310 Go to the previous tab
 311 .Pq Cm tabprevious
 312 .It Cm C-Right
 313 Go to the next tab
 314 .Pq Cm tabnext
 315 .It Cm C-[1..9]
 316 Jump to page
 317 .Ar N
 318 .Pq Cm tabnext [1..9]
 319 .It Cm C-minus
 320 Zoom out by 4%
 321 .Pq Cm focusout
 322 .It Cm C-plus, C-equal
 323 Zoom in by 4%
 324 .Pq Cm focusin
 325 .It Cm C-0
 326 Set zoom level to 100%
 327 .Pq Cm focusreset
 328 .El
 329 .Ss Yanking and pasting
 330 These commands copy and paste text to and from the clipboard.
 331 .Pp
 332 .Bl -tag -width Ds -offset indent -compact
 333 .It Cm p
 334 Paste the contents of the clipboard into the address bar
 335 .Pq Cm pasteuricur
 336 .It Cm P
 337 Paste the contents of the clipboard into a new tab
 338 .Pq Cm pasteurinew
 339 .It Cm y
 340 Yank the current URL into the clipboard
 341 .Pq Cm yankuri
 342 .El
 343 .Ss Hyperlink Following
 344 This allows the user to follow hyperlinks
 345 without using a mouse.
 346 Enter the corresponding number to follow the link.
 347 Alternatively one can type the name of the link and when there are no more
 348 possibilities
 349 .Nm
 350 will follow the link.
 351 .Pp
 352 .Bl -tag -width Ds -offset indent -compact
 353 .It Cm f
 354 Highlight all links and prefix them with a number.
 355 .Pq Cm hinting
 356 .El
 357 .Ss Exiting
 358 Commands to exit the browser.
 359 .Pp
 360 .Bl -tag -width Ds -offset indent -compact
 361 .It Cm C-q
 362 Quit
 363 .Pq Cm quitall
 364 .El
 365 .Ss Low-Contrast Color Scheme
 366 This command toggles the page's style between the default CSS and a
 367 low-contrast color scheme with light grey text on a dark grey background.
 368 .Pp
 369 .Bl -tag -width Ds -offset indent -compact
 370 .It Cm i
 371 Toggle the current tab's style.
 372 .Pq Cm userstyle
 373 .El
 374 .Sh COMMAND MODE
 375 Command mode works in a similar fashion to the
 376 .Xr vi 1
 377 editor;
 378 it is entered by typing a colon and exited by typing Esc.
 379 The commands and their descriptions are listed below.
 380 .Bl -tag -width Ds -offset indent
 381 .It Cm about , version
 382 Show the "About" page.
 383 .It Cm buffers , ls , tabs
 384 Displays the currently open tabs and lets the user switch tab by typing
 385 the tab number or using the mouse.
 386 .It Cm ca
 387 Display CA certificates.
 388 .It Cm cert , cert show
 389 Download and display certificates of domain on tab.
 390 .It Cm cert save
 391 Save certificate into a local store.
 392 The next time the site is visited it is compared against the store.
 393 If the certificate matches,
 394 the address bar will be blue;
 395 if it doesn't the bar will be red.
 396 .It Cm cookie
 397 The
 398 .Cm cookie
 399 command is used to manipulate the cookie whitelist.
 400 Used by itself it expands to
 401 .Cm cookie show all .
 402 .It Cm cookiejar
 403 Show cookie jar contents.
 404 .It Cm cookie save, cookie save fqdn
 405 Save the current fully qualified domain name (FQDN)
 406 to the persistent whitelist.
 407 For example,
 408 the www.peereboom.us domain would result in saving .www.peereboom.us.
 409 .It Cm cookie save domain
 410 Save the top level domain name to the persistent whitelist.
 411 For example,
 412 the www.peereboom.us domain would result in saving .peereboom.us.
 413 .Pp
 414 This action enables cookies if it is currently disabled for this entry.
 415 .It Cm cookie show all
 416 Show all persistent and session entries in the cookie whitelist.
 417 .It Cm cookie show persistent
 418 Show all persistent entries in the cookie whitelist.
 419 .It Cm cookie show session
 420 Show all session entries in the cookie whitelist.
 421 .It Cm cookie toggle domain
 422 Toggle cookie support for the current top level domain.
 423 .It Cm cookie toggle, cookie toggle fqdn
 424 Toggle cookie support for the current FQDN.
 425 .It Cm dl
 426 Show download manager.
 427 .It Cm fav
 428 Show favorites.
 429 .It Cm favadd
 430 Add the current page to favorites.
 431 .It Cm fullscreen , f
 432 Toggle hiding tabs and url entry toolbar.
 433 .It Cm h , hist , history
 434 Show global history.
 435 .It Cm help
 436 Show help page.
 437 .It Cm home
 438 Go to home URL.
 439 .It Cm js
 440 The
 441 .Cm js
 442 command is used to manipulate the Java Script whitelist.
 443 Used by itself it expands to
 444 .Cm js show all .
 445 .It Cm js save, save fqdn
 446 Saves the FQDN to the persistent whitelist.
 447 For example,
 448 the www.peereboom.us domain would result in saving .www.peereboom.us.
 449 .It Cm js save domain
 450 Saves the top level domain name to the persistent whitelist.
 451 For example,
 452 the www.peereboom.us domain would result in saving .peereboom.us.
 453 .Pp
 454 This action enables Java Script if it is currently disabled for this entry.
 455 .It Cm js show all
 456 Shows all persistent and session entries in the JS whitelist.
 457 .It Cm js show persistent
 458 Shows all persistent entries in the JS whitelist.
 459 .It Cm js show session
 460 Shows all session entries in the JS whitelist.
 461 .It Cm js toggle, js toggle fqdn
 462 Toggle Java Script execution for the current FQDN.
 463 .It Cm js toggle domain
 464 Toggle Java Script execution for the current top level domain.
 465 .It Cm open , op , o URL
 466 Open URL.
 467 .It Cm print
 468 Print page.
 469 .It Cm qa , qall , quitall
 470 Quit
 471 .Nm .
 472 .It Cm quit , q
 473 Close current tab and quit
 474 .Nm
 475 if it is the last tab.
 476 .It Cm restart
 477 Restart
 478 .Nm
 479 and reload all current tabs.
 480 .It Cm run_script [path_to_script]
 481 Runs the script path_to_script with the current uri as the argument.
 482 If path_to_script is not provided, the value of default_script is used
 483 instead.
 484 .It Cm session , Cm session show
 485 Display the current session name.
 486 By default the session name is main_session.
 487 To create a new session use the
 488 .Cm session save
 489 command.
 490 A session is defined as the lifetime of the browser application.
 491 .It Cm session delete <session_name>
 492 Delete session session_name from persistent storage.
 493 If session_name is the current session then the session will revert to
 494 main_session.
 495 .It Cm session open <session_name>
 496 Open session_name and close all currently open tabs.
 497 Going forward this session is named session_name.
 498 .It Cm session save <session_name>
 499 Save current tabs to session_name session.
 500 This will close the current session and going forward this session is named
 501 session_name.
 502 .It Cm stats
 503 Show blocked cookie statistics.
 504 These statistics vary based on settings and are not persistent.
 505 .It Cm statustoggle , statust
 506 Toggle status bar.
 507 .It Cm tabclose , tabc
 508 Close current tab.
 509 .It Cm tabhide
 510 Hide tabs.
 511 .It Cm tabnew , tabedit , tabe URL
 512 Create new tab and optionally open provided URL.
 513 .It Cm tabnext , tabn
 514 Go to the next tab.
 515 .It Cm tabprevious , tabp
 516 Go to the previous tab.
 517 .It Cm tabshow
 518 Show tabs.
 519 .It Cm toplevel , toplevel toggle
 520 Toggle the top level domain name cookie and JS session whitelist.
 521 This is to enable/disable short lived full site functionality without
 522 permanently adding the top level domain to the persistent whitelist.
 523 .It Cm urlhide , urlh
 524 Hide url entry and tool bar.
 525 .It Cm urlshow , urls
 526 Show url entry and tool bar.
 527 .It Cm w
 528 Save open tabs to current session.
 529 The tabs will be restored next time the session is opened.
 530 See the session command for additional details.
 531 .It Cm wq
 532 Save open tabs and quit.
 533 The tabs will be restored next time
 534 .Nm
 535 the session is opened.
 536 See the session command for additional details.
 537 .El
 538 .Sh BUFFER COMMANDS
 539 In addition to shortcuts and commands
 540 .Nm
 541 provides buffer commands. Buffer commands are short, multi character
 542 vi-like commands, often requiring an argument. Partial buffer commands
 543 are
 544 displayed in the buffer command statusbar element (see
 545 .Cm statusbar_elems ) .
 546 Pressing Esc or switching to another tab cancels a partially entered
 547 buffer command. In the following list
 548 .Cm arg
 549 denotes the argument a buffer command accepts. Buffer commands are
 550 defined as extended regular experssions.
 551 Note that if a character is used as a shortcut it will not be interpreted
 552 as the beginning of a buffer command. This is the case with
 553 .Cm 0 .
 554 .Pp
 555 .Bl -tag -width "[`'][a-zA-Z0-9]XXX" -offset indent -compact
 556 .It Cm gg
 557 go to the top of the page
 558 .It Cm gG
 559 go to the bottom of the page
 560 .It Cm [0-9]+%
 561 go to the
 562 .Cm arg
 563 percent of the page
 564 .It Cm [0-9]*gU
 565 go
 566 .Cm arg
 567 levels up. If
 568 .Cm arg
 569 is missing, 1 is assumed. Going a
 570 level up means going to a uri obtained from the current one by removing
 571 the last slash ('/') character and everything that follows it
 572 .It Cm gh
 573 open the home page in the current tab
 574 .It Cm m[a-zA-Z0-9]
 575 set a mark denoted by
 576 .Cm arg
 577 at the current page position. These marks behave like those in vi or
 578 less.
 579 .It Cm [`'][a-zA-Z0-9]
 580 go to the position where mark
 581 .Cm arg
 582 was set
 583 .It Cm M[a-zA-Z0-9]
 584 set the current uri as quickmark
 585 .Cm arg
 586 .It Cm go[a-zA-Z0-9]
 587 open the uri marked as quickmark
 588 .Cm arg
 589 in the current tab
 590 .It Cm gn[a-zA-Z0-9]
 591 open the uri marked as quickmark
 592 .Cm arg
 593 in a new tab
 594 .It Cm [0-9]+t
 595 activate tab number
 596 .Cm arg
 597 .It Cm ZZ
 598 quit
 599 .Nm
 600 .It Cm ZR
 601 restart
 602 .Nm
 603 .It Cm zi
 604 zoom in by 4%
 605 .It Cm zo
 606 zoom out by 4%
 607 .It Cm z0
 608 set zoom level to 100%
 609 .It Cm [0-9]+Z
 610 set zoom level to
 611 .Cm arg
 612 %
 613 .El
 614 .Sh QUICKMARKS
 615 Quickmarks are like bookmarks, except they are refered to by a single
 616 character (a letter or a digit), instead of a longer name. See the
 617 .Cm M[a-zA-Z0-9] ,
 618 .Cm go[a-zA-Z0-9]
 619 and
 620 .Cm gn[a-zA-Z0-9]
 621 buffer commands for usage. Quickmarks are stored in
 622 .Pa ~/.xxxterm/quickmarks
 623 and are saved automatically after each
 624 .Cm M[a-zA-Z0-9]
 625 buffer command.
 626 .Sh ABOUT SCREENS
 627 The about screens are internally generated web pages by
 628 .Nm
 629 for user interaction.
 630 These are entered in the address bar and the format is
 631 .Cm about:screen
 632 where screen is the desired screen to display.
 633 For example about:favorites.
 634 Any about screen can be used as the home page as specified by
 635 .Cm home
 636 in the configuration file.
 637 .Pp
 638 .Bl -tag -width "downloadsXXX" -offset indent -compact
 639 .It Cm about
 640 show the about screen
 641 .It Cm blank
 642 show a blank screen
 643 .It Cm cookiewl
 644 show the cookie whitelist screen
 645 .It Cm cookiejar
 646 show the cookiejar screen
 647 .It Cm downloads
 648 show the downloads screen
 649 .It Cm favorites
 650 show the favorites screen
 651 .It Cm help
 652 show the help web page
 653 .It Cm history
 654 show the history screen
 655 .It Cm jswl
 656 show the Java Script whitelist screen
 657 .It Cm set
 658 show the settings screen
 659 .It Cm stats
 660 show the statistics screen
 661 .El
 662 .Sh WHITELISTS
 663 This section describes advanced usage settings.
 664 Most users should use
 665 .Cm browser_mode
 666 instead to setup
 667 .Nm
 668 and skip over this section.
 669 .Pp
 670 .Nm
 671 has a number of whitelists to control blocking cookies and Java Script
 672 execution for FQDNs or domains.
 673 When properly enabled these whitelists require either the FQDN or top level
 674 domain to exist in the whitelists in order to allow cookies to be stored or
 675 Java Script to execute.
 676 Both Java Script and cookies have two whitelists associated with them.
 677 The whitelists are called session and persistent.
 678 Items in the session whitelists are only allowed for the lifetime of the
 679 .Nm
 680 instance.
 681 Items in the persistent whitelists are stored on disk and are restored
 682 upon restarting.
 683 .Pp
 684 Setting up the whitelists is a little tricky due to intricacies of WebKit.
 685 In fact the semantics are different for cookies and Java Script.
 686 .Pp
 687 Cookie whitelist requires the following configuration to be set:
 688 .Pp
 689 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 690 .It Cm cookies_enabled
 691 This is a WebKit setting and must be set to
 692 .Pa 1
 693 (ENABLED)
 694 in order to be able to use a
 695 cookie whitelist.
 696 .It Cm enable_cookie_whitelist
 697 This needs to be set to
 698 .Pa 1
 699 to enable the cookie whitelist functionality.
 700 .It Cm cookie_wl
 701 These entries in the configuration file are the actual domains names in the
 702 cookie whitelist.
 703 .El
 704 .Pp
 705 Java Script whitelist requires the following configuration to be set:
 706 .Pp
 707 .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
 708 .It Cm enable_scripts
 709 This is a WebKit setting and must be set to
 710 .Pa 0
 711 (DISABLED)
 712 in order to be able to use a
 713 Java Script whitelist.
 714 .It Cm enable_js_whitelist
 715 This needs to be set to
 716 .Pa 1
 717 to enable the Java Script whitelist functionality.
 718 .It Cm js_wl
 719 These entries in the configuration file are the actual domains names in the
 720 Java Script whitelist.
 721 .El
 722 .Pp
 723 See the
 724 .Pa FILES
 725 section for additional configuration file entries and details
 726 that alter runtime behavior.
 727 .Sh FILES
 728 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 729 .It Pa ~/.xxxterm.conf
 730 .Nm
 731 user specific settings.
 732 .It Pa ~/.xxxterm
 733 .Nm
 734 scratch directory.
 735 .El
 736 .Pp
 737 .Nm
 738 tries to open the user specific file,
 739 .Pa ~/.xxxterm.conf .
 740 If that file is unavailable,
 741 it then uses built-in defaults.
 742 .Pp
 743 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 744 For example:
 745 .Pp
 746 .Dl http_proxy = http://127.0.0.1:8080
 747 .Pp
 748 Enabling or disabling an option is done by using 1 or 0 respectively.
 749 .Pp
 750 The file supports the following keywords:
 751 .Pp
 752 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 753 .It Cm alias
 754 Defines an alias for a given URL, so that the URL is loaded when the alias is
 755 entered in the address bar.
 756 If the aliased URL includes a %s format specifier, then any argument given after
 757 the alias on the address bar is substituted.
 758 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
 759 then the URL http://www.google.com/search?q=foo is loaded when navigating to
 760 "g foo".
 761 .It Cm allow_volatile_cookies
 762 If set cookies are stored in the session cache but will be discarded once
 763 .Nm
 764 exits.
 765 Unfortunately enabling this does allow for some limited tracking on the web.
 766 .It Cm append_next
 767 When set a new tab is appended after the current tab instead of being appended
 768 as the last tab.
 769 .It Cm browser_mode
 770 The
 771 .Nm
 772 browser has 3 default operating modes:
 773 .Pa normal
 774 (the default),
 775 .Pa whitelist
 776 and
 777 .Pa kiosk .
 778 In the
 779 .Pa normal
 780 mode the browser allows all cookies and Java Script as any other browser
 781 would.
 782 This means that all cookies are saved to persistent storage and that all
 783 Java Script runs.
 784 .Pp
 785 On the other hand, using the
 786 .Pa whitelist
 787 mode enables whitelists.
 788 This requires the user to add all the required
 789 .Pa cookie_wl
 790 and
 791 .Pa js_wl
 792 items.
 793 If a domain does not appear in the whitelists
 794 .Nm
 795 disallows cookies and Java Script execution.
 796 .Pp
 797 In
 798 .Pa kiosk
 799 mode the browse works just like
 800 .Pa normal
 801 mode however the toolbar only has the backward, forward and home button.
 802 .Pp
 803 This setting must be the first entry in
 804 .Pa ~/.xxxterm.conf
 805 because it sets advanced settings that can be overridden later in the file.
 806 See the default config file for more details.
 807 .It Cm cmd_font
 808 Set the command prompt font.
 809 E.g.
 810 .Pa cmd_font = monospace normal 9 .
 811 .It Cm cookie_policy
 812 This field delineates the cookie policy.
 813 Possible values are: no3rdparty, reject 3rd party cookies.
 814 accept, accept all cookies.
 815 reject, reject all cookies.
 816 .It Cm cookie_wl
 817 This is a cookie whitelist item.
 818 Use multiple times to add multiple entries.
 819 Valid entries are for example *.moo.com and the equivalent .moo.com.
 820 A fully qualified host is also valid and is for example www.moo.com.
 821 .It Cm cookies_enabled
 822 Enable cookies.
 823 .It Cm ctrl_click_focus
 824 Give focus in newly created tab instead of opening it in the background.
 825 .It Cm default_script
 826 Path to the script used as the default value for the run_script
 827 command.
 828 .It Cm default_zoom_level
 829 Set the default browsing zoom level.
 830 .It Cm download_dir
 831 Locations where files are downloaded to.
 832 This directory must exist and
 833 .Nm
 834 validates that during startup.
 835 .It Cm enable_cookie_whitelist
 836 When enabled all cookies must be in the whitelist or they are rejected.
 837 .It Cm enable_js_whitelist
 838 When enabled all domains must be in the js whitelist in order to run Java Script.
 839 NOTE: Make sure
 840 .Cm enable_scripts
 841 is set to 0.
 842 .It Cm enable_plugins
 843 Enable plugins.
 844 .It Cm enable_scripts
 845 Enable scripts.
 846 .It Cm enable_socket
 847 When enabled the first instance of
 848 .Nm
 849 will create a socket in the
 850 .Pa ~/.xxxterm
 851 directory.
 852 Using the -n url option on subsequent
 853 .Nm
 854 invocations will cause the specified URL to be loaded in a new tab.
 855 Only a user with identical UID and GID can use this option.
 856 .It Cm enable_localstorage
 857 Enable html5 Local Storage.
 858 .It Cm enable_spell_checking
 859 Enables spell checking. Preferred languages can be set using
 860 .Cm spell_check_languages
 861 option.
 862 .It Cm fancy_bar
 863 Enables a backward, forward, and stop button to the toolbar.
 864 Additionally if
 865 .Cm search_string
 866 is set it'll enable an entry box for searches.
 867 .It Cm guess_search
 868 When enabled
 869 .Nm
 870 will try to guess if the string you entered, in the URI entry widget or
 871 the command widget, is term you want to search for using search_string
 872 (see above).
 873 If the string does not contain a dot nor a slash, is not a
 874 path to a local file and does not resolves to an IP then it is assumed
 875 to be a search term.
 876 .It Cm home
 877 Homepage in URL format.
 878 .It Cm http_proxy
 879 Proxy server in URL format.
 880 .Nm
 881 overrides
 882 .Cm http_proxy
 883 if it is specified as an environment variable.
 884 It must be noted that one MUST use an IP address and not a FQDN.
 885 .Pp
 886 If one desires to use a socks proxy then an intermediary tool must be used.
 887 It has been reported that tsocks works with
 888 .Nm .
 889 .It Cm icon_size
 890 Permits icon sizes to be changed if
 891 .Cm fancy_bar
 892 is enabled.
 893 Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
 894 .It Cm js_wl
 895 This is a Java Script whitelist item.
 896 See
 897 .Cm cookie_wl
 898 for semantics and more details.
 899 .It Cm max_connections
 900 The maximum number of connections that
 901 .Nm
 902 can open at once.
 903 .It Cm max_host_connections
 904 The maximum number of connections that
 905 .Nm
 906 can open at once to a given host.
 907 .It Cm mime_type
 908 Sets an action for a specific or default MIME type.
 909 For example, to download and view a pdf using kpdf set
 910 .Pa mime_type = application/pdf,kpdf .
 911 To set a default value use *, for example,
 912 .Pa mime_type = video/*,mplayer .
 913 Note that the action is only passed the URL and not all applications are
 914 capable of dealing with a URL and therefore one might have to create a wrapper
 915 script to download the content first.  Alternatively one can add the
 916 .Pa @
 917 in front of the MIME type to indicate "download first".
 918 For example,
 919 .Pa mime_type = @application/pdf,xpdf .
 920 When
 921 .Pa @
 922 is use the file will be downloaded to the
 923 .Pa download_dir
 924 before the MIME handler is called.
 925 .It Cm oops_font
 926 Set the font used to display error messages.
 927 E.g.
 928 .Pa oops_font = monospace normal 9 .
 929 .It Cm read_only_cookies
 930 Mark cookies file read-only and discard all cookies once the session is
 931 terminated.
 932 .It Cm refresh_interval
 933 Refresh interval while in the download manager.
 934 The default is 10.
 935 .It Cm resource_dir
 936 Directory that contains various
 937 .Nm
 938 resources such as icons.
 939 This is OS-specific and should be handled by the porter.
 940 .It Cm save_global_history
 941 If set the global history will be saved to
 942 .Pa ~/.xxxterm/history
 943 when quitting
 944 and restored at startup.
 945 See the
 946 .Sx KEY BINDINGS
 947 section above for how the global history is accessed.
 948 Global history is not saved to disk by default.
 949 .It Cm save_rejected_cookies
 950 Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
 951 All cookies are saved and unlike a cookie jar they are never replaced.
 952 Make sure there is enough disk space to enable this feature.
 953 .It Cm search_string
 954 Default search engine string.
 955 See the
 956 .Pa xxxterm.conf
 957 file for details.
 958 .It Cm session_autosave
 959 Enable session auto-saving when changing state (e.g. adding or removing a tab).
 960 The session name is what is currently in use and is described in the
 961 .Cm session save
 962 and
 963 .Cm session open
 964 commands.
 965 .It Cm session_timeout
 966 This value is the time that is added in seconds to a session cookie.
 967 .It Cm show_tabs
 968 Enable or disable showing tabs.
 969 .It Cm show_url
 970 Enable or disable showing the url and toolbar.
 971 .It Cm show_statusbar
 972 Enable or disable showing the status bar.
 973 .It Cm single_instance
 974 If set only one
 975 .Nm
 976 will be permitted to run.
 977 If there is a URL specified it will be opened in a new tab in the already
 978 running
 979 .Nm
 980 session.
 981 .It Cm spell_check_languages
 982 The languages to be used for spell checking, separated by commas. For example,
 983 en_US.
 984 .It Cm ssl_ca_file
 985 If set to a valid PEM file
 986 all server certificates will be validated against it.
 987 The URL bar will be colored green (or blue when saved ) when the certificate is
 988 trusted and yellow when untrusted.
 989 .Pp
 990 If
 991 .Cm ssl_ca_file
 992 is not set then the URL bar will color all HTTPS connections red.
 993 .Pp
 994 WebKit only supports a single PEM file.
 995 Many OS' or distributions have many PEM files.
 996 One can simply concatenate all separate files into one large one.
 997 E.g.
 998 .Cm for i in `ls`; do cat $i >> cert.pem; done
 999 and use the resulting cert.pem file as the input to
1000 .Cm ssl_ca_file .
1001 It is advisable to periodically recreate the cert.pem file.
1002 .It Cm ssl_strict_certs
1003 If this value is set connections to untrusted sites will be aborted.
1004 This value is only used if
1005 .Cm ssl_ca_file
1006 is set.
1007 .It Cm statusbar_elems
1008 Define the components of the status bar. The possible components are:
1009 .Bd -literal -offset indent
1010 | - separator
1011 P - page progress percent
1012 B - buffer command
1013 Z - page zoom level
1014 .Ed
1015 The default is "BP".
1016 These components show nothing if there is nothing worth showing, like
1017 zoom amount 100%.
1018 .It Cm statusbar_font
1019 Set the status bar font.
1020 E.g.
1021 .Pa statusbar_font = monospace normal 9 .
1022 .It Cm tab_style
1023 Set the tab style to either
1024 .Cm normal
1025 - the default gtk notebook tabs, or
1026 .Cm compact
1027 for an alternative.
1028 You can switch the tab style with the
1029 .Pa tabnextstyle
1030 command.
1031 .It Cm tabbar_font
1032 Set the compact tab bar font.
1033 E.g.
1034 .Pa tabbar_font = monospace normal 9 .
1035 .It Cm user_agent
1036 Set to override the default
1037 .Nm
1038 user-agent string.
1039 .It Cm window_height
1040 Set the default height of the browser window.
1041 .It Cm window_width
1042 Set the default width of the browser window.
1043 .It Cm work_dir
1044 Set the work directory where all
1045 .Nm
1046 scratch files are stored.
1047 Default is
1048 .Cm ~/.xxxterm .
1049 .El
1050 .Sh HISTORY
1051 .Nm
1052 was inspired by vimprobable2 and the bloat in other
1053 .Ux
1054 web browsers.
1055 .Sh AUTHORS
1056 .An -nosplit
1057 .Nm
1058 was written by
1059 .An Marco Peereboom Aq marco@peereboom.us ,
1060 .An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
1061 .An Edd Barrett Aq vext01@gmail.com ,
1062 .An Todd T. Fries Aq todd@fries.net ,
1063 .An Raphael Graf Aq r@undefined.ch ,
1064 and
1065 .An Michal Mazurek Aq akfaew@jasminek.net .
1066 .Sh BUGS
1067 When
1068 .Cm save_global_history
1069 is enabled
1070 .Nm
1071 is supposed to, in addition to restoring the global history, color the
1072 visited links accordingly; however due to bug #51747 in WebKit this does
1073 not happen.