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 set
 503 The set command is used to inspect, clear or change runtime options.
 504 There are 3 methods to use
 505 .Cm :set .
 506 When used by itself as
 507 .Cm :set
 508 the command displays all options as currently set.
 509 .Pp
 510 To set a value use
 511 .Cm :set option=value .
 512 For example,
 513 .Cm :set http_proxy=http://127.0.0.1:8080 .
 514 .Pp
 515 To clear a value use
 516 .Cm :set option= .
 517 For example,
 518 .Cm :set http_proxy= .
 519 .Pp
 520 Note, not all options can be set at runtime.
 521 .It Cm stats
 522 Show blocked cookie statistics.
 523 These statistics vary based on settings and are not persistent.
 524 .It Cm statustoggle , statust
 525 Toggle status bar.
 526 .It Cm tabclose , tabc
 527 Close current tab.
 528 .It Cm tabhide
 529 Hide tabs.
 530 .It Cm tabnew , tabedit , tabe URL
 531 Create new tab and optionally open provided URL.
 532 .It Cm tabnext , tabn
 533 Go to the next tab.
 534 .It Cm tabprevious , tabp
 535 Go to the previous tab.
 536 .It Cm tabshow
 537 Show tabs.
 538 .It Cm toplevel , toplevel toggle
 539 Toggle the top level domain name cookie and JS session whitelist.
 540 This is to enable/disable short lived full site functionality without
 541 permanently adding the top level domain to the persistent whitelist.
 542 .It Cm urlhide , urlh
 543 Hide url entry and tool bar.
 544 .It Cm urlshow , urls
 545 Show url entry and tool bar.
 546 .It Cm w
 547 Save open tabs to current session.
 548 The tabs will be restored next time the session is opened.
 549 See the session command for additional details.
 550 .It Cm wq
 551 Save open tabs and quit.
 552 The tabs will be restored next time
 553 .Nm
 554 the session is opened.
 555 See the session command for additional details.
 556 .El
 557 .Sh BUFFER COMMANDS
 558 In addition to shortcuts and commands
 559 .Nm
 560 provides buffer commands. Buffer commands are short, multi character
 561 vi-like commands, often requiring an argument. Partial buffer commands
 562 are
 563 displayed in the buffer command statusbar element (see
 564 .Cm statusbar_elems ) .
 565 Pressing Esc or switching to another tab cancels a partially entered
 566 buffer command. In the following list
 567 .Cm arg
 568 denotes the argument a buffer command accepts. Buffer commands are
 569 defined as extended regular experssions.
 570 Note that if a character is used as a shortcut it will not be interpreted
 571 as the beginning of a buffer command. This is the case with
 572 .Cm 0 .
 573 .Pp
 574 .Bl -tag -width "['][a-zA-Z0-9]XXX" -offset indent -compact
 575 .It Cm gg
 576 go to the top of the page
 577 .It Cm gG
 578 go to the bottom of the page
 579 .It Cm [0-9]+%
 580 go to the
 581 .Cm arg
 582 percent of the page
 583 .It Cm [0-9]*gU
 584 go
 585 .Cm arg
 586 levels up. If
 587 .Cm arg
 588 is missing, 1 is assumed. Going a
 589 level up means going to a uri obtained from the current one by removing
 590 the last slash ('/') character and everything that follows it
 591 .It Cm gh
 592 open the home page in the current tab
 593 .It Cm m[a-zA-Z0-9]
 594 set a mark denoted by
 595 .Cm arg
 596 at the current page position. These marks behave like those in vi or
 597 less.
 598 .It Cm ['][a-zA-Z0-9]
 599 go to the position where mark
 600 .Cm arg
 601 was set
 602 .It Cm M[a-zA-Z0-9]
 603 set the current uri as quickmark
 604 .Cm arg
 605 .It Cm go[a-zA-Z0-9]
 606 open the uri marked as quickmark
 607 .Cm arg
 608 in the current tab
 609 .It Cm gn[a-zA-Z0-9]
 610 open the uri marked as quickmark
 611 .Cm arg
 612 in a new tab
 613 .It Cm [0-9]+t
 614 activate tab number
 615 .Cm arg
 616 .It Cm ZZ
 617 quit
 618 .Nm
 619 .It Cm ZR
 620 restart
 621 .Nm
 622 .It Cm zi
 623 zoom in by 4%
 624 .It Cm zo
 625 zoom out by 4%
 626 .It Cm z0
 627 set zoom level to 100%
 628 .It Cm [0-9]+Z
 629 set zoom level to
 630 .Cm arg
 631 %
 632 .El
 633 .Sh QUICKMARKS
 634 Quickmarks are like bookmarks, except they are refered to by a single
 635 character (a letter or a digit), instead of a longer name. See the
 636 .Cm M[a-zA-Z0-9] ,
 637 .Cm go[a-zA-Z0-9]
 638 and
 639 .Cm gn[a-zA-Z0-9]
 640 buffer commands for usage. Quickmarks are stored in
 641 .Pa ~/.xxxterm/quickmarks
 642 and are saved automatically after each
 643 .Cm M[a-zA-Z0-9]
 644 buffer command.
 645 .Sh ABOUT SCREENS
 646 The about screens are internally generated web pages by
 647 .Nm
 648 for user interaction.
 649 These are entered in the address bar and the format is
 650 .Cm about:screen
 651 where screen is the desired screen to display.
 652 For example about:favorites.
 653 Any about screen can be used as the home page as specified by
 654 .Cm home
 655 in the configuration file.
 656 .Pp
 657 .Bl -tag -width "downloadsXXX" -offset indent -compact
 658 .It Cm about
 659 show the about screen
 660 .It Cm blank
 661 show a blank screen
 662 .It Cm cookiewl
 663 show the cookie whitelist screen
 664 .It Cm cookiejar
 665 show the cookiejar screen
 666 .It Cm downloads
 667 show the downloads screen
 668 .It Cm favorites
 669 show the favorites screen
 670 .It Cm help
 671 show the help web page
 672 .It Cm history
 673 show the history screen
 674 .It Cm jswl
 675 show the Java Script whitelist screen
 676 .It Cm set
 677 show the settings screen
 678 .It Cm stats
 679 show the statistics screen
 680 .El
 681 .Sh WHITELISTS
 682 This section describes advanced usage settings.
 683 Most users should use
 684 .Cm browser_mode
 685 instead to setup
 686 .Nm
 687 and skip over this section.
 688 .Pp
 689 .Nm
 690 has a number of whitelists to control blocking cookies and Java Script
 691 execution for FQDNs or domains.
 692 When properly enabled these whitelists require either the FQDN or top level
 693 domain to exist in the whitelists in order to allow cookies to be stored or
 694 Java Script to execute.
 695 Both Java Script and cookies have two whitelists associated with them.
 696 The whitelists are called session and persistent.
 697 Items in the session whitelists are only allowed for the lifetime of the
 698 .Nm
 699 instance.
 700 Items in the persistent whitelists are stored on disk and are restored
 701 upon restarting.
 702 .Pp
 703 Setting up the whitelists is a little tricky due to intricacies of WebKit.
 704 In fact the semantics are different for cookies and Java Script.
 705 .Pp
 706 Cookie whitelist requires the following configuration to be set:
 707 .Pp
 708 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 709 .It Cm cookies_enabled
 710 This is a WebKit setting and must be set to
 711 .Pa 1
 712 (ENABLED)
 713 in order to be able to use a
 714 cookie whitelist.
 715 .It Cm enable_cookie_whitelist
 716 This needs to be set to
 717 .Pa 1
 718 to enable the cookie whitelist functionality.
 719 .It Cm cookie_wl
 720 These entries in the configuration file are the actual domains names in the
 721 cookie whitelist.
 722 .El
 723 .Pp
 724 Java Script whitelist requires the following configuration to be set:
 725 .Pp
 726 .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
 727 .It Cm enable_scripts
 728 This is a WebKit setting and must be set to
 729 .Pa 0
 730 (DISABLED)
 731 in order to be able to use a
 732 Java Script whitelist.
 733 .It Cm enable_js_whitelist
 734 This needs to be set to
 735 .Pa 1
 736 to enable the Java Script whitelist functionality.
 737 .It Cm js_wl
 738 These entries in the configuration file are the actual domains names in the
 739 Java Script whitelist.
 740 .El
 741 .Pp
 742 See the
 743 .Pa FILES
 744 section for additional configuration file entries and details
 745 that alter runtime behavior.
 746 .Sh FILES
 747 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
 748 .It Pa ~/.xxxterm.conf
 749 .Nm
 750 user specific settings.
 751 .It Pa ~/.xxxterm
 752 .Nm
 753 scratch directory.
 754 .El
 755 .Pp
 756 .Nm
 757 tries to open the user specific file,
 758 .Pa ~/.xxxterm.conf .
 759 If that file is unavailable,
 760 it then uses built-in defaults.
 761 .Pp
 762 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 763 For example:
 764 .Pp
 765 .Dl http_proxy = http://127.0.0.1:8080
 766 .Pp
 767 Enabling or disabling an option is done by using 1 or 0 respectively.
 768 .Pp
 769 The file supports the following keywords:
 770 .Pp
 771 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
 772 .It Cm alias
 773 Defines an alias for a given URL, so that the URL is loaded when the alias is
 774 entered in the address bar.
 775 If the aliased URL includes a %s format specifier, then any argument given after
 776 the alias on the address bar is substituted.
 777 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
 778 then the URL http://www.google.com/search?q=foo is loaded when navigating to
 779 "g foo".
 780 .It Cm allow_volatile_cookies
 781 If set cookies are stored in the session cache but will be discarded once
 782 .Nm
 783 exits.
 784 Unfortunately enabling this does allow for some limited tracking on the web.
 785 .It Cm append_next
 786 When set a new tab is appended after the current tab instead of being appended
 787 as the last tab.
 788 .It Cm browser_mode
 789 The
 790 .Nm
 791 browser has 3 default operating modes:
 792 .Pa normal
 793 (the default),
 794 .Pa whitelist
 795 and
 796 .Pa kiosk .
 797 In the
 798 .Pa normal
 799 mode the browser allows all cookies and Java Script as any other browser
 800 would.
 801 This means that all cookies are saved to persistent storage and that all
 802 Java Script runs.
 803 .Pp
 804 On the other hand, using the
 805 .Pa whitelist
 806 mode enables whitelists.
 807 This requires the user to add all the required
 808 .Pa cookie_wl
 809 and
 810 .Pa js_wl
 811 items.
 812 If a domain does not appear in the whitelists
 813 .Nm
 814 disallows cookies and Java Script execution.
 815 .Pp
 816 In
 817 .Pa kiosk
 818 mode the browse works just like
 819 .Pa normal
 820 mode however the toolbar only has the backward, forward and home button.
 821 .Pp
 822 This setting must be the first entry in
 823 .Pa ~/.xxxterm.conf
 824 because it sets advanced settings that can be overridden later in the file.
 825 See the default config file for more details.
 826 .It Cm cmd_font
 827 Set the command prompt font.
 828 E.g.
 829 .Pa cmd_font = monospace normal 9 .
 830 .It Cm cookie_policy
 831 This field delineates the cookie policy.
 832 Possible values are: no3rdparty, reject 3rd party cookies.
 833 accept, accept all cookies.
 834 reject, reject all cookies.
 835 .It Cm cookie_wl
 836 This is a cookie whitelist item.
 837 Use multiple times to add multiple entries.
 838 Valid entries are for example *.moo.com and the equivalent .moo.com.
 839 A fully qualified host is also valid and is for example www.moo.com.
 840 .It Cm cookies_enabled
 841 Enable cookies.
 842 .It Cm ctrl_click_focus
 843 Give focus in newly created tab instead of opening it in the background.
 844 .It Cm default_script
 845 Path to the script used as the default value for the run_script
 846 command.
 847 .It Cm default_zoom_level
 848 Set the default browsing zoom level.
 849 .It Cm download_dir
 850 Locations where files are downloaded to.
 851 This directory must exist and
 852 .Nm
 853 validates that during startup.
 854 .It Cm enable_cookie_whitelist
 855 When enabled all cookies must be in the whitelist or they are rejected.
 856 Additionally whitelisted cookies also enable HTML5 local storage for the
 857 domain.
 858 .It Cm enable_js_whitelist
 859 When enabled all domains must be in the js whitelist in order to run Java
 860 Script.
 861 NOTE: Make sure
 862 .Cm enable_scripts
 863 is set to 0.
 864 .It Cm enable_plugins
 865 Enable plugins.
 866 .It Cm enable_scripts
 867 Enable scripts.
 868 .It Cm enable_socket
 869 When enabled the first instance of
 870 .Nm
 871 will create a socket in the
 872 .Pa ~/.xxxterm
 873 directory.
 874 Using the -n url option on subsequent
 875 .Nm
 876 invocations will cause the specified URL to be loaded in a new tab.
 877 Only a user with identical UID and GID can use this option.
 878 .It Cm enable_localstorage
 879 Enable html5 Local Storage.
 880 .It Cm enable_spell_checking
 881 Enables spell checking. Preferred languages can be set using
 882 .Cm spell_check_languages
 883 option.
 884 .It Cm fancy_bar
 885 Enables a backward, forward, and stop button to the toolbar.
 886 Additionally if
 887 .Cm search_string
 888 is set it'll enable an entry box for searches.
 889 .It Cm guess_search
 890 When enabled
 891 .Nm
 892 will try to guess if the string you entered, in the URI entry widget or
 893 the command widget, is term you want to search for using search_string
 894 (see above).
 895 If the string does not contain a dot nor a slash, is not a
 896 path to a local file and does not resolves to an IP then it is assumed
 897 to be a search term.
 898 .It Cm history_autosave
 899 When enabled
 900 .Nm
 901 will save all command and search history.
 902 Upon restarting
 903 .Nm
 904 the saved command and search history will be restored.
 905 .It Cm home
 906 Homepage in URL format.
 907 .It Cm http_proxy
 908 Proxy server in URL format.
 909 .Nm
 910 overrides
 911 .Cm http_proxy
 912 if it is specified as an environment variable.
 913 It must be noted that on older webkit versions one MUST use an IP address and
 914 not a FQDN.
 915 This works as expected with webkit 1.4.2.
 916 .Pp
 917 If one desires to use a socks proxy then an intermediary tool must be used.
 918 It has been reported that tsocks works with
 919 .Nm .
 920 .It Cm icon_size
 921 Permits icon sizes to be changed if
 922 .Cm fancy_bar
 923 is enabled.
 924 Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
 925 .It Cm js_wl
 926 This is a Java Script whitelist item.
 927 See
 928 .Cm cookie_wl
 929 for semantics and more details.
 930 .It Cm max_connections
 931 The maximum number of connections that
 932 .Nm
 933 can open at once.
 934 .It Cm max_host_connections
 935 The maximum number of connections that
 936 .Nm
 937 can open at once to a given host.
 938 .It Cm mime_type
 939 Sets an action for a specific or default MIME type.
 940 For example, to download and view a pdf using kpdf set
 941 .Pa mime_type = application/pdf,kpdf .
 942 To set a default value use *, for example,
 943 .Pa mime_type = video/*,mplayer .
 944 Note that the action is only passed the URL and not all applications are
 945 capable of dealing with a URL and therefore one might have to create a wrapper
 946 script to download the content first.  Alternatively one can add the
 947 .Pa @
 948 in front of the MIME type to indicate "download first".
 949 For example,
 950 .Pa mime_type = @application/pdf,xpdf .
 951 When
 952 .Pa @
 953 is use the file will be downloaded to the
 954 .Pa download_dir
 955 before the MIME handler is called.
 956 .It Cm oops_font
 957 Set the font used to display error messages.
 958 E.g.
 959 .Pa oops_font = monospace normal 9 .
 960 .It Cm read_only_cookies
 961 Mark cookies file read-only and discard all cookies once the session is
 962 terminated.
 963 .It Cm refresh_interval
 964 Refresh interval while in the download manager.
 965 The default is 10.
 966 .It Cm resource_dir
 967 Directory that contains various
 968 .Nm
 969 resources such as icons.
 970 This is OS-specific and should be handled by the porter.
 971 .It Cm save_global_history
 972 If set the global history will be saved to
 973 .Pa ~/.xxxterm/history
 974 when quitting
 975 and restored at startup.
 976 See the
 977 .Sx KEY BINDINGS
 978 section above for how the global history is accessed.
 979 Global history is not saved to disk by default.
 980 .It Cm save_rejected_cookies
 981 Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
 982 All cookies are saved and unlike a cookie jar they are never replaced.
 983 Make sure there is enough disk space to enable this feature.
 984 .It Cm search_string
 985 Default search engine string.
 986 See the
 987 .Pa xxxterm.conf
 988 file for details.
 989 .It Cm session_autosave
 990 Enable session auto-saving when changing state (e.g. adding or removing a tab).
 991 The session name is what is currently in use and is described in the
 992 .Cm session save
 993 and
 994 .Cm session open
 995 commands.
 996 .It Cm session_timeout
 997 This value is the time that is added in seconds to a session cookie.
 998 .It Cm show_tabs
 999 Enable or disable showing tabs.
1000 .It Cm show_url
1001 Enable or disable showing the url and toolbar.
1002 .It Cm show_statusbar
1003 Enable or disable showing the status bar.
1004 .It Cm single_instance
1005 If set only one
1006 .Nm
1007 will be permitted to run.
1008 If there is a URL specified it will be opened in a new tab in the already
1009 running
1010 .Nm
1011 session.
1012 .It Cm spell_check_languages
1013 The languages to be used for spell checking, separated by commas. For example,
1014 en_US.
1015 .It Cm ssl_ca_file
1016 If set to a valid PEM file
1017 all server certificates will be validated against it.
1018 The URL bar will be colored green (or blue when saved ) when the certificate is
1019 trusted and yellow when untrusted.
1020 .Pp
1021 If
1022 .Cm ssl_ca_file
1023 is not set then the URL bar will color all HTTPS connections red.
1024 .Pp
1025 WebKit only supports a single PEM file.
1026 Many OS' or distributions have many PEM files.
1027 One can simply concatenate all separate files into one large one.
1028 E.g.
1029 .Cm for i in `ls`; do cat $i >> cert.pem; done
1030 and use the resulting cert.pem file as the input to
1031 .Cm ssl_ca_file .
1032 It is advisable to periodically recreate the cert.pem file.
1033 .It Cm ssl_strict_certs
1034 If this value is set connections to untrusted sites will be aborted.
1035 This value is only used if
1036 .Cm ssl_ca_file
1037 is set.
1038 .It Cm statusbar_elems
1039 Define the components of the status bar. The possible components are:
1040 .Bd -literal -offset indent
1041 | - separator
1042 P - page progress percent
1043 B - buffer command
1044 Z - page zoom level
1045 .Ed
1046 The default is "BP".
1047 These components show nothing if there is nothing worth showing, like
1048 zoom amount 100%.
1049 .It Cm statusbar_font
1050 Set the status bar font.
1051 E.g.
1052 .Pa statusbar_font = monospace normal 9 .
1053 .It Cm tab_style
1054 Set the tab style to either
1055 .Cm normal
1056 - the default gtk notebook tabs, or
1057 .Cm compact
1058 for an alternative.
1059 You can switch the tab style with the
1060 .Pa tabnextstyle
1061 command.
1062 .It Cm tabbar_font
1063 Set the compact tab bar font.
1064 E.g.
1065 .Pa tabbar_font = monospace normal 9 .
1066 .It Cm url_regex
1067 This is the regular expression that is used to match what constitutes a valid
1068 URL when using
1069 .Pa guess_search .
1070 .It Cm user_agent
1071 Set to override the default
1072 .Nm
1073 user-agent string.
1074 .It Cm window_height
1075 Set the default height of the browser window.
1076 .It Cm window_width
1077 Set the default width of the browser window.
1078 .It Cm work_dir
1079 Set the work directory where all
1080 .Nm
1081 scratch files are stored.
1082 Default is
1083 .Cm ~/.xxxterm .
1084 .It Cm xterm_workaround
1085 When enabled
1086 .Nm
1087 will look additionally at CUT_BUFFER0 if PRIMARY clipboard is empty.
1088 Additionally when the PRIMARY clipboard is cleared it will copy CUT_BUFFER0
1089 into the PRIMARY clipboard.
1090 Default is 0.
1091 .El
1092 .Sh HISTORY
1093 .Nm
1094 was inspired by vimprobable2 and the bloat in other
1095 .Ux
1096 web browsers.
1097 .Sh AUTHORS
1098 .An -nosplit
1099 .Nm
1100 was written by
1101 .An Marco Peereboom Aq marco@peereboom.us ,
1102 .An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
1103 .An Edd Barrett Aq vext01@gmail.com ,
1104 .An Todd T. Fries Aq todd@fries.net ,
1105 .An Raphael Graf Aq r@undefined.ch ,
1106 and
1107 .An Michal Mazurek Aq akfaew@jasminek.net .
1108 .Sh BUGS
1109 When
1110 .Cm save_global_history
1111 is enabled
1112 .Nm
1113 is supposed to, in addition to restoring the global history, color the
1114 visited links accordingly; however due to bug #51747 in WebKit this does
1115 not happen.