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