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