3 .\" Copyright (c) 2010, 2011 Marco Peereboom <marco@peereboom.us>
4 .\" Copyright (c) 2011 Jason McIntyre <jmc@openbsd.org>
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.
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.
23 .Nd lightweight web browser
29 .Op Fl s Ar session_name
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
38 It was written by hackers for hackers
39 and it strives to be small, compact, and fast.
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
47 giving web browsing a similar feel to navigating a text document.
50 section below documents the various defaults and possible customizations.
52 The options are as follows:
55 Specify an alternative configuration file.
57 Open a new tab in a running
59 for each specified URL.
64 Execute arbitrary command (see the
66 section below) in a running
68 instance. This option requires
70 to be enabled. Example run: xxxterm -e "tabnew openbsd.org"; xxxterm -e
71 tabclose; xxxterm -e wq.
74 .It Fl s Ar session_name
75 Open session that was saved with ":session save" command.
77 Disable visualization of tabs.
81 Display version and exit.
84 The following notation is used throughout this page:
86 .Bl -tag -width Ds -offset indent -compact
92 Meta 1 (sometimes marked Alt)
98 Meta 4 (sometimes marked Windows)
105 To browse to a specific address,
106 either use the mouse to click on the address bar
109 to shift the keyboard focus to the address bar.
110 The address is then entered manually.
112 The mouse can be used to navigate the page in the traditional manner,
113 or the keyboard can be used instead.
118 will scroll up and down the page.
121 either click on it or use the
125 assign numbers to each link on the page;
126 entering that number on the keyboard will prompt
131 provides many actions accessed via key or mouse bindings.
132 Most can be reprogrammed using a
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:
139 .D1 keybinding = action,(!)keystroke(s)
141 For example, "keybinding = tabnew,C-t" where
147 GTK has some default keybindings for manipulating text inside input
148 fields, such as the URI or search entry widget, for example
150 deletes a word. To override these defaults prefix your key with an
151 exclamation mark, like this: "keybinding = tabclose,!C-w".
154 key word is special and is meant to reset the key binding list to the GTK+
156 This keyword should be the first
158 entry in the configuration file.
160 Shift should be used sparingly since it gets in the way of non-USA keyboards.
161 See the accompanying configuration file for examples.
163 The various bindings are documented below.
164 The relevant keybinding action is given afterwards, in parentheses.
166 These commands are used to search for text strings within a web page.
168 .Bl -tag -width Ds -offset indent -compact
173 Start a backwards search
176 Next item matching search
179 Previous item matching search
183 These commands are used to shift the focus of
185 from one area to another.
187 .Bl -tag -width Ds -offset indent -compact
192 Focus on search entry
196 These commands allow the user to map specific actions to specific keys.
197 It can be useful when the
201 .Bl -tag -width Ds -offset indent -compact
205 Alias for ":toplevel toggle"
210 Alias for ":open current-uri"
211 .Pq Cm promptopencurrent
216 Alias for ":tabnew current-uri"
217 .Pq Cm prompttabnewcurrent
219 .Ss Navigation Commands
220 These commands allow the user to navigate web pages and,
224 .Bl -tag -width "Space, C-f, PageDownXXX" -offset indent -compact
229 Reload page without using any cached data
231 .It Cm Backspace, M-Left
234 .It Cm S-BackSpace, M-Right
241 Previous line on page
249 .It Cm Space, C-f, PageDown
251 .Pq Cm scrollpagedown
263 .Pq Cm scrollfarright
283 Toggle Java Script enabled for FQDN
289 Toggle cookie enabled for FQDN
294 supports tabbed browsing.
295 That is, web pages may be opened in separate tabs,
296 allowing the user to quickly move from one page to another,
298 These commands then are used to create, destroy, and move between tabs.
300 .Bl -tag -width "C-plus, C-equalXXX" -offset indent -compact
302 Open new tab with the clicked link
304 Create new tab with focus in URL entry
313 Go to the previous tab
321 .Pq Cm tabnext [1..0]
323 Shrink font size by one point
325 .It Cm C-plus, C-equal
326 Grow font size by one point
329 .Ss Yanking and pasting
330 These commands copy and paste text to and from the clipboard.
332 .Bl -tag -width Ds -offset indent -compact
334 Paste the contents of the clipboard into the address bar
337 Paste the contents of the clipboard into a new tab
340 Yank the current URL into the clipboard
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
350 will follow the link.
352 .Bl -tag -width Ds -offset indent -compact
354 Highlight all links and prefix them with a number.
358 Commands to exit the browser.
360 .Bl -tag -width Ds -offset indent -compact
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.
369 .Bl -tag -width Ds -offset indent -compact
371 Toggle the current tab's style.
375 Command mode works in a similar fashion to the
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.
387 Display CA certificates.
388 .It Cm cert , cert show
389 Download and display certificates of domain on tab.
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.
399 command is used to manipulate the cookie whitelist.
400 Used by itself it expands to
401 .Cm cookie show all .
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.
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.
412 the www.peereboom.us domain would result in saving .peereboom.us.
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.
426 Show download manager.
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
442 command is used to manipulate the Java Script whitelist.
443 Used by itself it expands to
445 .It Cm js save, save fqdn
446 Saves the FQDN to the persistent whitelist.
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.
452 the www.peereboom.us domain would result in saving .peereboom.us.
454 This action enables Java Script if it is currently disabled for this entry.
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
469 .It Cm qa , qall , quitall
473 Close current tab and quit
475 if it is the last tab.
479 and reload all current tabs.
480 .It Cm session , Cm session show
481 Display the current session name.
482 By default the session name is main_session.
483 To create a new session use the
486 A session is defined as the lifetime of the browser application.
487 .It Cm session delete <session_name>
488 Delete session session_name from persistent storage.
489 If session_name is the current session then the session will revert to
491 .It Cm session open <session_name>
492 Open session_name and close all currently open tabs.
493 Going forward this session is named session_name.
494 .It Cm session save <session_name>
495 Save current tabs to session_name session.
496 This will close the current session and going forward this session is named
499 Show blocked cookie statistics.
500 These statistics vary based on settings and are not persistent.
501 .It Cm statustoggle , statust
503 .It Cm tabclose , tabc
507 .It Cm tabnew , tabedit , tabe URL
508 Create new tab and optionally open provided URL.
509 .It Cm tabnext , tabn
511 .It Cm tabprevious , tabp
512 Go to the previous tab.
515 .It Cm toplevel , toplevel toggle
516 Toggle the top level domain name cookie and JS session whitelist.
517 This is to enable/disable short lived full site functionality without
518 permanently adding the top level domain to the persistent whitelist.
519 .It Cm urlhide , urlh
520 Hide url entry and tool bar.
521 .It Cm urlshow , urls
522 Show url entry and tool bar.
524 Save open tabs to current session.
525 The tabs will be restored next time
527 the session is opened.
528 See the session command for additional details.
530 Save open tabs and quit.
531 The tabs will be restored next time
533 the session is opened.
534 See the session command for additional details.
537 The about screens are internally generated web pages by
539 for user interaction.
540 These are entered in the address bar and the format is
542 where screen is the desired screen to display.
543 For example about:favorites.
544 Any about screen can be used as the home page as specified by
546 in the configuration file.
548 .Bl -tag -width "downloadsXXX" -offset indent -compact
550 show the about screen
554 show the cookie whitelist screen
556 show the cookiejar screen
558 show the downloads screen
560 show the favorites screen
562 show the help web page
564 show the history screen
566 show the Java Script whitelist screen
568 show the settings screen
570 show the statistics screen
573 This section descibes advanced usage settings.
574 Most users should use
578 and skip over this section.
581 has a number of whitelists to control blocking cookies and Java Script
582 execution for FQDNs or domains.
583 When properly enabled these whitelists require either the FQDN or top level
584 domain to exist in the whitelists in order to allow cookies to be stored or
585 Java Script to execute.
586 Both Java Script and cookies have two whitelists associated with them.
587 The whitelists are called session and persistent.
588 Items in the session whitelists are only allowed for the lifetime of the
591 Items in the persistent whitelists are stored on disk and are restored
594 Setting up the whitelists is a little tricky due to intricacies of WebKit.
595 In fact the semantics are different for cookies and Java Script.
597 Cookie whitelist requires the following configuration to be set:
599 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
600 .It Cm cookies_enabled
601 This is a WebKit setting and must be set to
604 in order to be able to use a
606 .It Cm enable_cookie_whitelist
607 This needs to be set to
609 to enable the cookie whitelist functionality.
611 These entries in the configuration file are the actual domains names in the
615 Java Script whitelist requires the following configuration to be set:
617 .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
618 .It Cm enable_scripts
619 This is a WebKit setting and must be set to
622 in order to be able to use a
623 Java Script whitelist.
624 .It Cm enable_js_whitelist
625 This needs to be set to
627 to enable the Java Script whitelist functionality.
629 These entries in the configuration file are the actual domains names in the
630 Java Script whitelist.
635 section for additional configuration file entries and details
636 that alter runtime behavior.
638 .Bl -tag -width "/etc/xxxterm.confXXX" -compact
639 .It Pa ~/.xxxterm.conf
641 user specific settings.
648 tries to open the user specific file,
649 .Pa ~/.xxxterm.conf .
650 If that file is unavailable,
651 it then uses built-in defaults.
653 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
656 .Dl http_proxy = http://127.0.0.1:8080
658 Enabling or disabling an option is done by using 1 or 0 respectively.
660 The file supports the following keywords:
662 .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
664 Defines an alias for a given URL, so that the URL is loaded when the alias is
665 entered in the address bar.
666 If the aliased URL includes a %s format specifier, then any argument given after
667 the alias on the address bar is substituted.
668 For example, if g,http://www.google.com/search?q=%s is defined as an alias,
669 then the URL http://www.google.com/search?q=foo is loaded when navigating to
671 .It Cm allow_volatile_cookies
672 If set cookies are stored in the session cache but will be discarded once
675 Unfortunately enabling this does allow for some limited tracking on the web.
677 When set a new tab is appended after the current tab instead of being appended
682 browser has 3 default operating modes:
690 mode the browser allows all cookies and Java Script as any other browser
692 This means that all cookies are saved to persistent storage and that all
695 On the other hand, using the
697 mode enables whitelists.
698 This requires the user to add all the required
703 If a domain does not appear in the whitelists
705 disallows cookies and Java Script execution.
709 mode the browse works just like
711 mode however the toolbar only has the backward, forward and home button.
713 This setting must be the first entry in
715 because it sets advanced settings that can be overridden later in the file.
716 See the default config file for more details.
718 Set the command prompt font.
720 .Pa cmd_font = monospace normal 9 .
722 This field delineates the cookie policy.
723 Possible values are: no3rdparty, reject 3rd party cookies.
724 accept, accept all cookies.
725 reject, reject all cookies.
727 This is a cookie whitelist item.
728 Use multiple times to add multiple entries.
729 Valid entries are for example *.moo.com and the equivalent .moo.com.
730 A fully qualified host is also valid and is for example www.moo.com.
731 .It Cm cookies_enabled
733 .It Cm ctrl_click_focus
734 Give focus in newly created tab instead of opening it in the background.
735 .It Cm default_font_size
736 Set the default browsing font size.
737 .It Cm default_zoom_level
738 Set the default browsing zoom level.
740 Locations where files are downloaded to.
741 This directory must exist and
743 validates that during startup.
744 .It Cm enable_cookie_whitelist
745 When enabled all cookies must be in the whitelist or they are rejected.
746 .It Cm enable_js_whitelist
747 When enabled all domains must be in the js whitelist in order to run Java Script.
751 .It Cm enable_plugins
753 .It Cm enable_scripts
756 When enabled the first instance of
758 will create a socket in the
761 Using the -n url option on subsequent
763 invocations will cause the specified URL to be loaded in a new tab.
764 Only a user with identical UID and GID can use this option.
765 .It Cm enable_localstorage
766 Enable html5 Local Storage.
767 .It Cm enable_spell_checking
768 Enables spell checking. Preferred languages can be set using
769 .Cm spell_check_languages
772 Enables a backward, forward, and stop button to the toolbar.
775 is set it'll enable an entry box for searches.
779 will try to guess if the string you entered, in the URI entry widget or
780 the command widget, is term you want to search for using search_string
782 If the string does not contain a dot nor a slash, is not a
783 path to a local file and does not resolves to an IP then it is assumed
786 Homepage in URL format.
788 Proxy server in URL format.
792 if it is specified as an environment variable.
793 It must be noted that one MUST use an IP address and not a FQDN.
795 If one desires to use a socks proxy then an intermediary tool must be used.
796 It has been reported that tsocks works with
799 Permits icon sizes to be changed if
802 Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
804 This is a Java Script whitelist item.
807 for semantics and more details.
808 .It Cm max_connections
809 The maximum number of connections that
812 .It Cm max_host_connections
813 The maximum number of connections that
815 can open at once to a given host.
817 Sets an action for a specific or default MIME type.
818 For example, to download and view a pdf using kpdf set
819 .Pa mime_type = application/pdf,kpdf .
820 To set a default value use *, for example,
821 .Pa mime_type = video/*,mplayer .
822 Note that the action is only passed the URL and not all applications are
823 capable of dealing with a URL and therefore one might have to create a wrapper
824 script to download the content first. Alternatively one can add the
826 in front of the MIME type to indicate "download first".
828 .Pa mime_type = @application/pdf,xpdf .
831 is use the file will be downloaded to the
833 before the MIME handler is called.
834 .It Cm read_only_cookies
835 Mark cookies file read-only and discard all cookies once the session is
837 .It Cm refresh_interval
838 Refresh interval while in the download manager.
841 Directory that contains various
843 resources such as icons.
844 This is OS-specific and should be handled by the porter.
845 .It Cm save_global_history
846 If set the global history will be saved to
847 .Pa ~/.xxxterm/history
849 and restored at startup.
852 section above for how the global history is accessed.
853 Global history is not saved to disk by default.
854 .It Cm save_rejected_cookies
855 Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
856 All cookies are saved and unlike a cookie jar they are never replaced.
857 Make sure there is enough disk space to enable this feature.
859 Default search engine string.
863 .It Cm session_autosave
864 Enable session auto-saving when changing state (e.g. adding or removing a tab).
865 The session name is what is currently in use and is described in the
870 .It Cm session_timeout
871 This value is the time that is added in seconds to a session cookie.
873 Enable or disable showing tabs.
875 Enable or disable showing the url and toolbar.
876 .It Cm show_statusbar
877 Enable or disable showing the status bar.
878 .It Cm single_instance
881 will be permitted to run.
882 If there is a URL specified it will be opened in a new tab in the already
886 .It Cm spell_check_languages
887 The languages to be used for spell checking, separated by commas. For example, en_US.
889 If set to a valid PEM file
890 all server certificates will be validated against it.
891 The URL bar will be colored green when the certificate is trusted
892 and yellow when untrusted.
896 is not set then the URL bar will color all HTTPS connections red.
897 .It Cm ssl_strict_certs
898 If this value is set connections to untrusted sites will be aborted.
899 This value is only used if
902 .It Cm statusbar_font
903 Set the status bar font.
905 .Pa statusbar_font = monospace normal 9 .
907 Set the tab style to either
909 - the default gtk notebook tabs, or
912 You can switch the tab style with the
916 Set to override the default
920 Set the default height of the browser window.
922 Set the default width of the browser window.
924 Set the work directory where all
926 scratch files are stored.
932 was inspired by vimprobable2 and the bloat in other
939 .An Marco Peereboom Aq marco@peereboom.us ,
940 .An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
941 .An Edd Barrett Aq vext01@gmail.com ,
942 .An Todd T. Fries Aq todd@fries.net ,
943 .An Raphael Graf Aq r@undefined.ch ,
945 .An Michal Mazurek Aq akfaew@jasminek.net .
948 .Cm save_global_history
951 is supposed to, in addition to restoring the global history, color the
952 visited links accordingly; however due to bug #51747 in WebKit this does