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 C-R
 229 Reload page without using any cached data
 230 .Pq Cm reloadforce
 231 .It Cm Backspace, M-Left
 232 Previous page
 233 .Pq Cm goback
 234 .It Cm S-BackSpace, M-Right
 235 Forward page
 236 .Pq Cm goforward
 237 .It Cm j, Down
 238 Next line on page
 239 .Pq Cm scrolldown
 240 .It Cm k, Up
 241 Previous line on page
 242 .Pq Cm scrollup
 243 .It Cm G, End
 244 Bottom of page
 245 .Pq Cm scrollbottom
 246 .It Cm gg, Home
 247 Top of page
 248 .Pq Cm scrolltop
 249 .It Cm Space, C-f, PageDown
 250 Page down
 251 .Pq Cm scrollpagedown
 252 .It Cm C-b, PageUp
 253 Page up
 254 .Pq Cm scrollpageup
 255 .It Cm l, Right
 256 Page right
 257 .Pq Cm scrollright
 258 .It Cm h, Left
 259 Page left
 260 .Pq Cm scrollleft
 261 .It Cm $
 262 Page far right
 263 .Pq Cm scrollfarright
 264 .It Cm 0
 265 Page far left
 266 .Pq Cm scrollfarleft
 267 .It Cm M-f
 268 Favorites
 269 .Pq Cm fav
 270 .It Cm M-j
 271 Cookie jar
 272 .Pq Cm cookiejar
 273 .It Cm M-d
 274 Download manager
 275 .Pq Cm dl
 276 .It Cm C-p
 277 Print page
 278 .Pq Cm print
 279 .It Cm M-h
 280 Global history
 281 .Pq Cm history
 282 .It Cm C-j
 283 Toggle Java Script enabled for FQDN
 284 .Pq Cm js
 285 .It Cm C-s
 286 Toggle source view
 287 .Pq Cm togglesrc
 288 .It Cm M-c
 289 Toggle cookie enabled for FQDN
 290 .Pq Cm cookie
 291 .El
 292 .Ss Tab Manipulation
 293 .Nm
 294 supports tabbed browsing.
 295 That is, web pages may be opened in separate tabs,
 296 allowing the user to quickly move from one page to another,
 297 and back.
 298 These commands then are used to create, destroy, and move between tabs.
 299 .Pp
 300 .Bl -tag -width "C-plus, C-equalXXX" -offset indent -compact
 301 .It Cm C-MB1
 302 Open new tab with the clicked link
 303 .It Cm C-t
 304 Create new tab with focus in URL entry
 305 .Pq Cm tabnew
 306 .It Cm C-w
 307 Destroy current tab
 308 .Pq Cm tabclose
 309 .It Cm U
 310 Undo close tab
 311 .Pq Cm tabundoclose
 312 .It Cm C-Left
 313 Go to the previous tab
 314 .Pq Cm tabprevious
 315 .It Cm C-Right
 316 Go to the next tab
 317 .Pq Cm tabnext
 318 .It Cm C-[1..0]
 319 Jump to page
 320 .Ar N
 321 .Pq Cm tabnext [1..0]
 322 .It Cm C-minus
 323 Shrink font size by one point
 324 .Pq Cm focusout
 325 .It Cm C-plus, C-equal
 326 Grow font size by one point
 327 .Pq Cm focusin
 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 session , Cm session show
 481 Display the current session name.
 482 By default the session name is main_session.
 483 To create a new session use the
 484 .Cm session save
 485 command.
 486 A session is defined as the lifetime of the browser application.
 487 .It Cm session delete <session_name>
 488 Delete session session_name from persistent storage.
 489 If session_name is the current session then the session will revert to
 490 main_session.
 491 .It Cm session open <session_name>
 492 Open session_name and close all currently open tabs.
 493 Going forward this session is named session_name.
 494 .It Cm session save <session_name>
 495 Save current tabs to session_name session.
 496 This will close the current session and going forward this session is named
 497 session_name.
 498 .It Cm stats
 499 Show blocked cookie statistics.
 500 These statistics vary based on settings and are not persistent.
 501 .It Cm statushide , statush
 502 Hide status bar.
 503 .It Cm statusshow , statuss
 504 Show status bar.
 505 .It Cm tabclose , tabc
 506 Close current tab.
 507 .It Cm tabhide
 508 Hide tabs.
 509 .It Cm tabnew , tabedit , tabe URL
 510 Create new tab and optionally open provided URL.
 511 .It Cm tabnext , tabn
 512 Go to the next tab.
 513 .It Cm tabprevious , tabp
 514 Go to the previous tab.
 515 .It Cm tabshow
 516 Show tabs.
 517 .It Cm toplevel , toplevel toggle
 518 Toggle the top level domain name cookie and JS session whitelist.
 519 This is to enable/disable short lived full site functionality without
 520 permanently adding the top level domain to the persistent whitelist.
 521 .It Cm urlhide , urlh
 522 Hide url entry and tool bar.
 523 .It Cm urlshow , urls
 524 Show url entry and tool bar.
 525 .It Cm w
 526 Save open tabs to current session.
 527 The tabs will be restored next time
 528 .Nm
 529 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 ABOUT SCREENS
 539 The about screens are internally generated web pages by
 540 .Nm
 541 for user interaction.
 542 These are entered in the address bar and the format is
 543 .Cm about:screen
 544 where screen is the desired screen to display.
 545 For example about:favorites.
 546 Any about screen can be used as the home page as specified by
 547 .Cm home
 548 in the configuration file.
 549 .Pp
 550 .Bl -tag -width "downloadsXXX" -offset indent -compact
 551 .It Cm about
 552 show the about screen
 553 .It Cm blank
 554 show a blank screen
 555 .It Cm cookiewl
 556 show the cookie whitelist screen
 557 .It Cm cookiejar
 558 show the cookiejar screen
 559 .It Cm downloads
 560 show the downloads screen
 561 .It Cm favorites
 562 show the favorites screen
 563 .It Cm help
 564 show the help web page
 565 .It Cm history
 566 show the history screen
 567 .It Cm jswl
 568 show the Java Script whitelist screen
 569 .It Cm set
 570 show the settings screen
 571 .It Cm stats
 572 show the statistics screen
 573 .El
 574 .Sh WHITELISTS
 575 This section descibes advanced usage settings.
 576 Most users should use
 577 .Cm browser_mode
 578 instead to setup
 579 .Nm
 580 and skip over this section.
 581 .Pp
 582 .Nm
 583 has a number of whitelists to control blocking cookies and Java Script
 584 execution for FQDNs or domains.
 585 When properly enabled these whitelists require either the FQDN or top level
 586 domain to exist in the whitelists in order to allow cookies to be stored or
 587 Java Script to execute.
 588 Both Java Script and cookies have two whitelists associated with them.
 589 The whitelists are called session and persistent.
 590 Items in the session whitelists are only allowed for the lifetime of the
 591 .Nm
 592 instance.
 593 Items in the persistent whitelists are stored on disk and are restored
 594 upon restarting.
 595 .Pp
 596 Setting up the whitelists is a little tricky due to intricacies of WebKit.
 597 In fact the semantics are different for cookies and Java Script.
 598 .Pp
 599 Cookie whitelist requires the following configuration to be set:
 600 .Pp
 601 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 602 .It Cm cookies_enabled
 603 This is a WebKit setting and must be set to
 604 .Pa 1
 605 (ENABLED)
 606 in order to be able to use a
 607 cookie whitelist.
 608 .It Cm enable_cookie_whitelist
 609 This needs to be set to
 610 .Pa 1
 611 to enable the cookie whitelist functionality.
 612 .It Cm cookie_wl
 613 These entries in the configuration file are the actual domains names in the
 614 cookie whitelist.
 615 .El
 616 .Pp
 617 Java Script whitelist requires the following configuration to be set:
 618 .Pp
 619 .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
 620 .It Cm enable_scripts
 621 This is a WebKit setting and must be set to
 622 .Pa 0
 623 (DISABLED)
 624 in order to be able to use a
 625 Java Script whitelist.
 626 .It Cm enable_js_whitelist
 627 This needs to be set to
 628 .Pa 1
 629 to enable the Java Script whitelist functionality.
 630 .It Cm js_wl
 631 These entries in the configuration file are the actual domains names in the
 632 Java Script whitelist.
 633 .El
 634 .Pp
 635 See the
 636 .Pa FILES
 637 section for additional configuration file entries and details
 638 that alter runtime behavior.
 639 .Sh FILES
 640 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 641 .It Pa ~/.xxxterm.conf
 642 .Nm
 643 user specific settings.
 644 .It Pa ~/.xxxterm
 645 .Nm
 646 scratch directory.
 647 .El
 648 .Pp
 649 .Nm
 650 tries to open the user specific file,
 651 .Pa ~/.xxxterm.conf .
 652 If that file is unavailable,
 653 it then uses built-in defaults.
 654 .Pp
 655 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 656 For example:
 657 .Pp
 658 .Dl http_proxy = http://127.0.0.1:8080
 659 .Pp
 660 Enabling or disabling an option is done by using 1 or 0 respectively.
 661 .Pp
 662 The file supports the following keywords:
 663 .Pp
 664 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 665 .It Cm alias
 666 Defines an alias for a given URL, so that the URL is loaded when the alias is
 667 entered in the address bar.
 668 If the aliased URL includes a %s format specifier, then any argument given after
 669 the alias on the address bar is substituted.
 670 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
 671 then the URL http://www.google.com/search?q=foo is loaded when navigating to
 672 "g foo".
 673 .It Cm allow_volatile_cookies
 674 If set cookies are stored in the session cache but will be discarded once
 675 .Nm
 676 exits.
 677 Unfortunately enabling this does allow for some limited tracking on the web.
 678 .It Cm append_next
 679 When set a new tab is appended after the current tab instead of being appended
 680 as the last tab.
 681 .It Cm browser_mode
 682 The
 683 .Nm
 684 browser has 3 default operating modes:
 685 .Pa normal
 686 (the default),
 687 .Pa whitelist
 688 and
 689 .Pa kiosk .
 690 In the
 691 .Pa normal
 692 mode the browser allows all cookies and Java Script as any other browser
 693 would.
 694 This means that all cookies are saved to persistent storage and that all
 695 Java Script runs.
 696 .Pp
 697 On the other hand, using the
 698 .Pa whitelist
 699 mode enables whitelists.
 700 This requires the user to add all the required
 701 .Pa cookie_wl
 702 and
 703 .Pa js_wl
 704 items.
 705 If a domain does not appear in the whitelists
 706 .Nm
 707 disallows cookies and Java Script execution.
 708 .Pp
 709 In
 710 .Pa kiosk
 711 mode the browse works just like
 712 .Pa normal
 713 mode however the toolbar only has the backward, forward and home button.
 714 .Pp
 715 This setting must be the first entry in
 716 .Pa ~/.xxxterm.conf
 717 because it sets advanced settings that can be overridden later in the file.
 718 See the default config file for more details.
 719 .It Cm cmd_font
 720 Set the command prompt font.
 721 E.g.
 722 .Pa cmd_font = monospace normal 9 .
 723 .It Cm cookie_policy
 724 This field delineates the cookie policy.
 725 Possible values are: no3rdparty, reject 3rd party cookies.
 726 accept, accept all cookies.
 727 reject, reject all cookies.
 728 .It Cm cookie_wl
 729 This is a cookie whitelist item.
 730 Use multiple times to add multiple entries.
 731 Valid entries are for example *.moo.com and the equivalent .moo.com.
 732 A fully qualified host is also valid and is for example www.moo.com.
 733 .It Cm cookies_enabled
 734 Enable cookies.
 735 .It Cm ctrl_click_focus
 736 Give focus in newly created tab instead of opening it in the background.
 737 .It Cm default_font_size
 738 Set the default browsing font size.
 739 .It Cm default_zoom_level
 740 Set the default browsing zoom level.
 741 .It Cm download_dir
 742 Locations where files are downloaded to.
 743 This directory must exist and
 744 .Nm
 745 validates that during startup.
 746 .It Cm enable_cookie_whitelist
 747 When enabled all cookies must be in the whitelist or they are rejected.
 748 .It Cm enable_js_whitelist
 749 When enabled all domains must be in the js whitelist in order to run Java Script.
 750 NOTE: Make sure
 751 .Cm enable_scripts
 752 is set to 0.
 753 .It Cm enable_plugins
 754 Enable plugins.
 755 .It Cm enable_scripts
 756 Enable scripts.
 757 .It Cm enable_socket
 758 When enabled the first instance of
 759 .Nm
 760 will create a socket in the
 761 .Pa ~/.xxxterm
 762 directory.
 763 Using the -n url option on subsequent
 764 .Nm
 765 invocations will cause the specified URL to be loaded in a new tab.
 766 Only a user with identical UID and GID can use this option.
 767 .It Cm enable_localstorage
 768 Enable html5 Local Storage.
 769 .It Cm enable_spell_checking
 770 Enables spell checking. Preferred languages can be set using
 771 .Cm spell_check_languages
 772 option.
 773 .It Cm fancy_bar
 774 Enables a backward, forward, and stop button to the toolbar.
 775 Additionally if
 776 .Cm search_string
 777 is set it'll enable an entry box for searches.
 778 .It Cm guess_search
 779 When enabled
 780 .Nm
 781 will try to guess if the string you entered, in the URI entry widget or
 782 the command widget, is term you want to search for using search_string
 783 (see above).
 784 If the string does not contain a dot nor a slash, is not a
 785 path to a local file and does not resolves to an IP then it is assumed
 786 to be a search term.
 787 .It Cm home
 788 Homepage in URL format.
 789 .It Cm http_proxy
 790 Proxy server in URL format.
 791 .Nm
 792 overrides
 793 .Cm http_proxy
 794 if it is specified as an environment variable.
 795 It must be noted that one MUST use an IP address and not a FQDN.
 796 .Pp
 797 If one desires to use a socks proxy then an intermediary tool must be used.
 798 It has been reported that tsocks works with
 799 .Nm .
 800 .It Cm icon_size
 801 Permits icon sizes to be changed if
 802 .Cm fancy_bar
 803 is enabled.
 804 Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
 805 .It Cm js_wl
 806 This is a Java Script whitelist item.
 807 See
 808 .Cm cookie_wl
 809 for semantics and more details.
 810 .It Cm max_connections
 811 The maximum number of connections that
 812 .Nm
 813 can open at once.
 814 .It Cm max_host_connections
 815 The maximum number of connections that
 816 .Nm
 817 can open at once to a given host.
 818 .It Cm mime_type
 819 Sets an action for a specific or default MIME type.
 820 For example, to download and view a pdf using kpdf set
 821 .Pa mime_type = application/pdf,kpdf .
 822 To set a default value use *, for example,
 823 .Pa mime_type = video/*,mplayer .
 824 Note that the action is only passed the URL and not all applications are
 825 capable of dealing with a URL and therefore one might have to create a wrapper
 826 script to download the content first.  Alternatively one can add the
 827 .Pa @
 828 in front of the MIME type to indicate "download first".
 829 For example,
 830 .Pa mime_type = @application/pdf,xpdf .
 831 When
 832 .Pa @
 833 is use the file will be downloaded to the
 834 .Pa download_dir
 835 before the MIME handler is called.
 836 .It Cm read_only_cookies
 837 Mark cookies file read-only and discard all cookies once the session is
 838 terminated.
 839 .It Cm refresh_interval
 840 Refresh interval while in the download manager.
 841 The default is 10.
 842 .It Cm resource_dir
 843 Directory that contains various
 844 .Nm
 845 resources such as icons.
 846 This is OS-specific and should be handled by the porter.
 847 .It Cm save_global_history
 848 If set the global history will be saved to
 849 .Pa ~/.xxxterm/history
 850 when quitting
 851 and restored at startup.
 852 See the
 853 .Sx KEY BINDINGS
 854 section above for how the global history is accessed.
 855 Global history is not saved to disk by default.
 856 .It Cm save_rejected_cookies
 857 Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
 858 All cookies are saved and unlike a cookie jar they are never replaced.
 859 Make sure there is enough disk space to enable this feature.
 860 .It Cm search_string
 861 Default search engine string.
 862 See the
 863 .Pa xxxterm.conf
 864 file for details.
 865 .It Cm session_autosave
 866 Enable session auto-saving when changing state (e.g. adding or removing a tab).
 867 The session name is what is currently in use and is described in the
 868 .Cm session save
 869 and
 870 .Cm session open
 871 commands.
 872 .It Cm session_timeout
 873 This value is the time that is added in seconds to a session cookie.
 874 .It Cm show_tabs
 875 Enable or disable showing tabs.
 876 .It Cm show_url
 877 Enable or disable showing the url and toolbar.
 878 .It Cm show_statusbar
 879 Enable or disable showing the status bar.
 880 .It Cm single_instance
 881 If set only one
 882 .Nm
 883 will be permitted to run.
 884 If there is a URL specified it will be opened in a new tab in the already
 885 running
 886 .Nm
 887 session.
 888 .It Cm spell_check_languages
 889 The languages to be used for spell checking, separated by commas. For example, en_US.
 890 .It Cm ssl_ca_file
 891 If set to a valid PEM file
 892 all server certificates will be validated against it.
 893 The URL bar will be colored green when the certificate is trusted
 894 and yellow when untrusted.
 895 .Pp
 896 If
 897 .Cm ssl_ca_file
 898 is not set then the URL bar will color all HTTPS connections red.
 899 .It Cm ssl_strict_certs
 900 If this value is set connections to untrusted sites will be aborted.
 901 This value is only used if
 902 .Cm ssl_ca_file
 903 is set.
 904 .It Cm statusbar_font
 905 Set the status bar font.
 906 E.g.
 907 .Pa statusbar_font = monospace normal 9 .
 908 .It Cm user_agent
 909 Set to override the default
 910 .Nm
 911 user-agent string.
 912 .It Cm window_height
 913 Set the default height of the browser window.
 914 .It Cm window_width
 915 Set the default width of the browser window.
 916 .It Cm work_dir
 917 Set the work directory where all
 918 .Nm
 919 scratch files are stored.
 920 Default is
 921 .Cm ~/.xxxterm .
 922 .El
 923 .Sh HISTORY
 924 .Nm
 925 was inspired by vimprobable2 and the bloat in other
 926 .Ux
 927 web browsers.
 928 .Sh AUTHORS
 929 .An -nosplit
 930 .Nm
 931 was written by
 932 .An Marco Peereboom Aq marco@peereboom.us ,
 933 .An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
 934 .An Edd Barrett Aq vext01@gmail.com ,
 935 .An Todd T. Fries Aq todd@fries.net ,
 936 .An Raphael Graf Aq r@undefined.ch ,
 937 and
 938 .An Michal Mazurek Aq akfaew@jasminek.net .
 939 .Sh BUGS
 940 When
 941 .Cm save_global_history
 942 is enabled
 943 .Nm
 944 is supposed to, in addition to restoring the global history, color the
 945 visited links accordingly; however due to bug #51747 in WebKit this does
 946 not happen.