mu - Soul of a tiny new machine. More thorough tests → More comprehensible and rewrite-friendly software → More resilient society.

diff options

Diffstat (limited to 'html/038new_text.cc.html')

-rw-r--r--

html/038new_text.cc.html

1 files changed, 1 insertions, 1 deletions

.\" $xxxterm$ .\" .\" Copyright (c) 2010, 2011 Marco Peereboom <marco@peereboom.us> .\" Copyright (c) 2011 Jason McIntyre <jmc@openbsd.org> .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .Dd $Mdocdate$ .Dt XXXTERM 1 .Os .Sh NAME .Nm xxxterm .Nd lightweight web browser .Sh SYNOPSIS .Nm xxxterm .Bk -words .Op Fl nSTtV .Op Fl f Ar file .Op Fl s Ar session_name .Op Ar url ... .Ek .Sh DESCRIPTION .Nm is a minimalistic web browser that tries to stay out of the way so that valuable screen real estate can be used for much more important stuff. It has sane defaults and does not require one to learn a language to do any configuration. It was written by hackers for hackers and it strives to be small, compact, and fast. .Pp .Nm is very simple in its use. Most actions are initiated via key or mouse bindings. Key bindings are based on those of the .Xr vi 1 text editor, giving web browsing a similar feel to navigating a text document. The .Sx KEY BINDINGS section below documents the various defaults and possible customizations. .Pp The options are as follows: .Bl -tag -width Ds .It Fl f Ar file Specify an alternative configuration file. .It Fl n Open a new tab in a running .Nm for each specified URL. This option requires .Cm enable_socket to be enabled. .It Fl e Ar command Execute arbitrary command (see the .Sx COMMAND MODE section below) in a running .Nm instance. This option requires .Cm enable_socket to be enabled. Example run: xxxterm -e "tabnew openbsd.org"; xxxterm -e tabclose; xxxterm -e wq. .It Fl S Disable the toolbar. .It Fl s Ar session_name Open session that was saved with ":session save" command. .It Fl T Disable visualization of tabs. .It Fl t Disable tabs. .It Fl V Display version and exit. .El .Sh FAST STARTUP The following notation is used throughout this page: .Pp .Bl -tag -width Ds -offset indent -compact .It Cm C- Control .It Cm S- Shift .It Cm M1- Meta 1 (sometimes marked Alt) .It Cm M2- Meta 2 .It Cm M3- Meta 3 .It Cm M4- Meta 4 (sometimes marked Windows) .It Cm M5- Meta 2 .It Cm MB1 Mouse button 1 .El .Pp To browse to a specific address, either use the mouse to click on the address bar or press .Cm F6 to shift the keyboard focus to the address bar. The address is then entered manually. .Pp The mouse can be used to navigate the page in the traditional manner, or the keyboard can be used instead. For example, .Cm PageUp and .Cm PageDown will scroll up and down the page. .Pp To follow a link, either click on it or use the .Cm f key and have .Nm assign numbers to each link on the page; entering that number on the keyboard will prompt .Nm to follow the link. .Sh KEY BINDINGS .Nm provides many actions accessed via key or mouse bindings. Most can be reprogrammed using a .Cm keybinding entry in the configuration file. Each keyboard shortcut requires exactly one entry in the configuration file. A shortcut can have multiple entries in the configuration file. The format of the keybinding entry is as follows: .Pp .D1 keybinding = action,(!)keystroke(s) .Pp For example, "keybinding = tabnew,C-t" where .Cm tabnew is the action and .Cm C-t are the keystrokes. GTK has some default keybindings for manipulating text inside input fields, such as the URI or search entry widget, for example .Cm C-w deletes a word. To override these defaults prefix your key with an exclamation mark, like this: "keybinding = tabclose,!C-w". The .Cm clearall key word is special and is meant to reset the key binding list to the GTK+ and WebKit defaults. This keyword should be the first .Cm keybinding entry in the configuration file. .Pp Shift should be used sparingly since it gets in the way of non-USA keyboards. See the accompanying configuration file for examples. .Pp The various bindings are documented below. The relevant keybinding action is given afterwards, in parentheses. .Ss Search Commands These commands are used to search for text strings within a web page. .Pp .Bl -tag -width Ds -offset indent -compact .It Cm / Start a search .Pq Cm search .It Cm \&? Start a backwards search .Pq Cm searchb .It Cm n Next item matching search .Pq Cm searchnext .It Cm N Previous item matching search .Pq Cm searchprev .El .Ss Focus Commands These commands are used to shift the focus of .Nm from one area to another. .Pp .Bl -tag -width Ds -offset indent -compact .It Cm F6 Focus on address bar .Pq Cm focusaddress .It Cm F7 Focus on search entry .Pq Cm focussearch .El .Ss Command Aliases These commands allow the user to map specific actions to specific keys. It can be useful when the .Fl S option is used. .Pp .Bl -tag -width Ds -offset indent -compact .It Cm F9 Alias for ":open" .Pq Cm promptopen .It Cm F10 Alias for ":open current-uri" .Pq Cm promptopencurrent .It Cm F11 Alias for ":tabnew" .Pq Cm prompttabnew .It Cm F12 Alias for ":tabnew current-uri" .Pq Cm prompttabnewcurrent .El .Ss Navigation Commands These commands allow the user to navigate web pages and, to some extent, control the browser. .Pp .Bl -tag -width "Space, C-f, PageDownXXX" -offset indent -compact .It Cm F5, C-r, C-l Reload page .Pq Cm reload .It Cm C-R Reload page without using any cached data .Pq Cm reloadforce .It Cm Backspace, M-Left Previous page .Pq Cm goback .It Cm S-BackSpace, M-Right Forward page .Pq Cm goforward .It Cm j, Down Next line on page .Pq Cm scrolldown .It Cm k, Up Previous line on page .Pq Cm scrollup .It Cm G, End Bottom of page .Pq Cm scrollbottom .It Cm gg, Home Top of page .Pq Cm scrolltop .It Cm Space, C-f, PageDown Page down .Pq Cm scrollpagedown .It Cm C-b, PageUp Page up .Pq Cm scrollpageup .It Cm l, Right Page right .Pq Cm scrollright .It Cm h, Left Page left .Pq Cm scrollleft .It Cm $ Page far right .Pq Cm scrollfarright .It Cm 0 Page far left .Pq Cm scrollfarleft .It Cm M-f Favorites .Pq Cm fav .It Cm M-j Cookie jar .Pq Cm cookiejar .It Cm M-d Download manager .Pq Cm dl .It Cm C-p Print page .Pq Cm print .It Cm M-h Global history .Pq Cm history .It Cm C-j Toggle Java Script enabled for FQDN .Pq Cm js .It Cm C-s Toggle source view .Pq Cm togglesrc .It Cm M-c Toggle cookie enabled for FQDN .Pq Cm cookie .El .Ss Tab Manipulation .Nm supports tabbed browsing. That is, web pages may be opened in separate tabs, allowing the user to quickly move from one page to another, and back. These commands then are used to create, destroy, and move between tabs. .Pp .Bl -tag -width "C-plus, C-equalXXX" -offset indent -compact .It Cm C-MB1 Open new tab with the clicked link .It Cm C-t Create new tab with focus in URL entry .Pq Cm tabnew .It Cm C-w Destroy current tab .Pq Cm tabclose .It Cm U Undo close tab .Pq Cm tabundoclose .It Cm C-Left Go to the previous tab .Pq Cm tabprevious .It Cm C-Right Go to the next tab .Pq Cm tabnext .It Cm C-[1..0] Jump to page .Ar N .Pq Cm tabnext [1..0] .It Cm C-minus Shrink font size by one point .Pq Cm focusout .It Cm C-plus, C-equal Grow font size by one point .Pq Cm focusin .El .Ss Yanking and pasting These commands copy and paste text to and from the clipboard. .Pp .Bl -tag -width Ds -offset indent -compact .It Cm p Paste the contents of the clipboard into the address bar .Pq Cm pasteuricur .It Cm P Paste the contents of the clipboard into a new tab .Pq Cm pasteurinew .It Cm y Yank the current URL into the clipboard .Pq Cm yankuri .El .Ss Hyperlink Following This allows the user to follow hyperlinks without using a mouse. Enter the corresponding number to follow the link. Alternatively one can type the name of the link and when there are no more possibilities .Nm will follow the link. .Pp .Bl -tag -width Ds -offset indent -compact .It Cm f Highlight all links and prefix them with a number. .Pq Cm hinting .El .Ss Exiting Commands to exit the browser. .Pp .Bl -tag -width Ds -offset indent -compact .It Cm C-q Quit .Pq Cm quitall .El .Ss Low-Contrast Color Scheme This command toggles the page's style between the default CSS and a low-contrast color scheme with light grey text on a dark grey background. .Pp .Bl -tag -width Ds -offset indent -compact .It Cm i Toggle the current tab's style. .Pq Cm userstyle .El .Sh COMMAND MODE Command mode works in a similar fashion to the .Xr vi 1 editor; it is entered by typing a colon and exited by typing Esc. The commands and their descriptions are listed below. .Bl -tag -width Ds -offset indent .It Cm about , version Show the "About" page. .It Cm ca Display CA certificates. .It Cm cert , cert show Download and display certificates of domain on tab. .It Cm cert save Save certificate into a local store. The next time the site is visited it is compared against the store. If the certificate matches, the address bar will be blue; if it doesn't the bar will be red. .It Cm cookie The .Cm cookie command is used to manipulate the cookie whitelist. Used by itself it expands to .Cm cookie show all . .It Cm cookiejar Show cookie jar contents. .It Cm cookie save, cookie save fqdn Save the current fully qualified domain name (FQDN) to the persistent whitelist. For example, the www.peereboom.us domain would result in saving .www.peereboom.us. .It Cm cookie save domain Save the top level domain name to the persistent whitelist. For example, the www.peereboom.us domain would result in saving .peereboom.us. .Pp This action enables cookies if it is currently disabled for this entry. .It Cm cookie show all Show all persistent and session entries in the cookie whitelist. .It Cm cookie show persistent Show all persistent entries in the cookie whitelist. .It Cm cookie show session Show all session entries in the cookie whitelist. .It Cm cookie toggle domain Toggle cookie support for the current top level domain. .It Cm cookie toggle, cookie toggle fqdn Toggle cookie support for the current FQDN. .It Cm dl Show download manager. .It Cm fav Show favorites. .It Cm favadd Add the current page to favorites. .It Cm fullscreen , f Toggle hiding tabs and url entry toolbar. .It Cm h , hist , history Show global history. .It Cm help Show help page. .It Cm home Go to home URL. .It Cm js The .Cm js command is used to manipulate the Java Script whitelist. Used by itself it expands to .Cm js show all . .It Cm js save, save fqdn Saves the FQDN to the persistent whitelist. For example, the www.peereboom.us domain would result in saving .www.peereboom.us. .It Cm js save domain Saves the top level domain name to the persistent whitelist. For example, the www.peereboom.us domain would result in saving .peereboom.us. .Pp This action enables Java Script if it is currently disabled for this entry. .It Cm js show all Shows all persistent and session entries in the JS whitelist. .It Cm js show persistent Shows all persistent entries in the JS whitelist. .It Cm js show session Shows all session entries in the JS whitelist. .It Cm js toggle, js toggle fqdn Toggle Java Script execution for the current FQDN. .It Cm js toggle domain Toggle Java Script execution for the current top level domain. .It Cm open , op , o URL Open URL. .It Cm print Print page. .It Cm qa , qall , quitall Quit .Nm . .It Cm quit , q Close current tab and quit .Nm if it is the last tab. .It Cm restart Restart .Nm and reload all current tabs. .It Cm session , Cm session show Display the current session name. By default the session name is main_session. To create a new session use the .Cm session save command. A session is defined as the lifetime of the browser application. .It Cm session delete <session_name> Delete session session_name from persistent storage. If session_name is the current session then the session will revert to main_session. .It Cm session open <session_name> Open session_name and close all currently open tabs. Going forward this session is named session_name. .It Cm session save <session_name> Save current tabs to session_name session. This will close the current session and going forward this session is named session_name. .It Cm stats Show blocked cookie statistics. These statistics vary based on settings and are not persistent. .It Cm statushide , statush Hide status bar. .It Cm statusshow , statuss Show status bar. .It Cm tabclose , tabc Close current tab. .It Cm tabhide , tabh Hide tabs. .It Cm tabnew , tabedit , tabe URL Create new tab and optionally open provided URL. .It Cm tabnext , tabn Go to the next tab. .It Cm tabprevious , tabp Go to the previous tab. .It Cm tabshow , tabs Show tabs. .It Cm urlhide , urlh Hide url entry and tool bar. .It Cm urlshow , urls Show url entry and tool bar. .It Cm w Save open tabs to current session. The tabs will be restored next time .Nm the session is opened. See the session command for additional details. .It Cm wq Save open tabs and quit. The tabs will be restored next time .Nm the session is opened. See the session command for additional details. .El .Sh ABOUT SCREENS The about screens are internally generated web pages by .Nm for user interaction. These are entered in the address bar and the format is .Cm about:screen where screen is the desired screen to display. For example about:favorites. Any about screen can be used as the home page as specified by .Cm home in the configuration file. .Pp .Bl -tag -width "downloadsXXX" -offset indent -compact .It Cm about show the about screen .It Cm blank show a blank screen .It Cm cookiewl show the cookie whitelist screen .It Cm cookiejar show the cookiejar screen .It Cm downloads show the downloads screen .It Cm favorites show the favorites screen .It Cm help show the help web page .It Cm history show the history screen .It Cm jswl show the Java Script whitelist screen .It Cm set show the settings screen .It Cm stats show the statistics screen .El .Sh WHITELISTS This section descibes advanced usage settings. Most users should use .Cm browser_mode instead to setup .Nm and skip over this section. .Pp .Nm has a number of whitelists to control blocking cookies and Java Script execution for FQDNs or domains. When properly enabled these whitelists require either the FQDN or top level domain to exist in the whitelists in order to allow cookies to be stored or Java Script to execute. Both Java Script and cookies have two whitelists associated with them. The whitelists are called session and persistent. Items in the session whitelists are only allowed for the lifetime of the .Nm instance. Items in the persistent whitelists are stored on disk and are restored upon restarting. .Pp Setting up the whitelists is a little tricky due to intricacies of WebKit. In fact the semantics are different for cookies and Java Script. .Pp Cookie whitelist requires the following configuration to be set: .Pp .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact .It Cm cookies_enabled This is a WebKit setting and must be set to .Pa 1 (ENABLED) in order to be able to use a cookie whitelist. .It Cm enable_cookie_whitelist This needs to be set to .Pa 1 to enable the cookie whitelist functionality. .It Cm cookie_wl These entries in the configuration file are the actual domains names in the cookie whitelist. .El .Pp Java Script whitelist requires the following configuration to be set: .Pp .Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact .It Cm enable_scripts This is a WebKit setting and must be set to .Pa 0 (DISABLED) in order to be able to use a Java Script whitelist. .It Cm enable_js_whitelist This needs to be set to .Pa 1 to enable the Java Script whitelist functionality. .It Cm js_wl These entries in the configuration file are the actual domains names in the Java Script whitelist. .El .Pp See the .Pa FILES section for additional configuration file entries and details that alter runtime behavior. .Sh FILES .Bl -tag -width "/etc/xxxterm.confXXX" -compact .It Pa ~/.xxxterm.conf .Nm user specific settings. .It Pa ~/.xxxterm .Nm scratch directory. .El .Pp .Nm tries to open the user specific file, .Pa ~/.xxxterm.conf . If that file is unavailable, it then uses built-in defaults. .Pp The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt. For example: .Pp .Dl http_proxy = http://127.0.0.1:8080 .Pp Enabling or disabling an option is done by using 1 or 0 respectively. .Pp The file supports the following keywords: .Pp .Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact .It Cm alias Defines an alias for a given URL, so that the URL is loaded when the alias is entered in the address bar. If the aliased URL includes a %s format specifier, then any argument given after the alias on the address bar is substituted. For example, if g,http://www.google.com/search?q=%s is defined as an alias, then the URL http://www.google.com/search?q=foo is loaded when navigating to "g foo". .It Cm allow_volatile_cookies If set cookies are stored in the session cache but will be discarded once .Nm exits. Unfortunately enabling this does allow for some limited tracking on the web. .It Cm append_next When set a new tab is appended after the current tab instead of being appended as the last tab. .It Cm browser_mode The .Nm browser has 3 default operating modes: .Pa normal (the default), .Pa whitelist and .Pa kiosk . In the .Pa normal mode the browser allows all cookies and Java Script as any other browser would. This means that all cookies are saved to persistent storage and that all Java Script runs. .Pp On the other hand, using the .Pa whitelist mode enables whitelists. This requires the user to add all the required .Pa cookie_wl and .Pa js_wl items. If a domain does not appear in the whitelists .Nm disallows cookies and Java Script execution. .Pp In .Pa kiosk mode the browse works just like .Pa normal mode however the toolbar only has the backward, forward and home button. .Pp This setting must be the first entry in .Pa ~/.xxxterm.conf because it sets advanced settings that can be overridden later in the file. See the default config file for more details. .It Cm cookie_policy This field delineates the cookie policy. Possible values are: no3rdparty, reject 3rd party cookies. accept, accept all cookies. reject, reject all cookies. .It Cm cookie_wl This is a cookie whitelist item. Use multiple times to add multiple entries. Valid entries are for example *.moo.com and the equivalent .moo.com. A fully qualified host is also valid and is for example www.moo.com. .It Cm cookies_enabled Enable cookies. .It Cm ctrl_click_focus Give focus in newly created tab instead of opening it in the background. .It Cm default_font_size Set the default browsing font size. .It Cm default_zoom_level Set the default browsing zoom level. .It Cm download_dir Locations where files are downloaded to. This directory must exist and .Nm validates that during startup. .It Cm enable_cookie_whitelist When enabled all cookies must be in the whitelist or they are rejected. .It Cm enable_js_whitelist When enabled all domains must be in the js whitelist in order to run Java Script. NOTE: Make sure .Cm enable_scripts is set to 0. .It Cm enable_plugins Enable plugins. .It Cm enable_scripts Enable scripts. .It Cm enable_socket When enabled the first instance of .Nm will create a socket in the .Pa ~/.xxxterm directory. Using the -n url option on subsequent .Nm invocations will cause the specified URL to be loaded in a new tab. Only a user with identical UID and GID can use this option. .It Cm enable_spell_checking Enables spell checking. Preferred languages can be set using .Cm spell_check_languages option. .It Cm fancy_bar Enables a backward, forward, and stop button to the toolbar. Additionally if .Cm search_string is set it'll enable an entry box for searches. .It Cm guess_search When enabled .Nm will try to guess if the string you entered, in the URI entry widget or the command widget, is term you want to search for using search_string (see above). If the string does not contain a dot nor a slash, is not a path to a local file and does not resolves to an IP then it is assumed to be a search term. .It Cm home Homepage in URL format. .It Cm http_proxy Proxy server in URL format. .Nm overrides .Cm http_proxy if it is specified as an environment variable. It must be noted that one MUST use an IP address and not a FQDN. .Pp If one desires to use a socks proxy then an intermediary tool must be used. It has been reported that tsocks works with .Nm . .It Cm icon_size Permits icon sizes to be changed if .Cm fancy_bar is enabled. Size 1 is small; 2 is normal; 3 through 6 are progressively larger. .It Cm js_wl This is a Java Script whitelist item. See .Cm cookie_wl for semantics and more details. .It Cm max_connections The maximum number of connections that .Nm can open at once. .It Cm max_host_connections The maximum number of connections that .Nm can open at once to a given host. .It Cm mime_type Sets an action for a specific or default MIME type. For example, to download and view a pdf using kpdf set .Pa mime_type = application/pdf,kpdf . To set a default value use *, for example, .Pa mime_type = video/*,mplayer . Note that the action is only passed the URL and not all applications are capable of dealing with a URL and therefore one might have to create a wrapper script to download the content first. Alternatively one can add the .Pa @ in front of the MIME type to indicate "download first". For example, .Pa mime_type = @application/pdf,xpdf . When .Pa @ is use the file will be downloaded to the .Pa download_dir before the MIME handler is called. .It Cm read_only_cookies Mark cookies file read-only and discard all cookies once the session is terminated. .It Cm refresh_interval Refresh interval while in the download manager. The default is 10. .It Cm resource_dir Directory that contains various .Nm resources such as icons. This is OS-specific and should be handled by the porter. .It Cm save_global_history If set the global history will be saved to .Pa ~/.xxxterm/history when quitting and restored at startup. See the .Sx KEY BINDINGS section above for how the global history is accessed. Global history is not saved to disk by default. .It Cm save_rejected_cookies Saves rejected cookies in cookie format in {work_dir}/rejected.txt. All cookies are saved and unlike a cookie jar they are never replaced. Make sure there is enough disk space to enable this feature. .It Cm search_string Default search engine string. See the .Pa xxxterm.conf file for details. .It Cm session_autosave Enable session auto-saving when changing state (e.g. adding or removing a tab). The session name is what is currently in use and is described in the .Cm session save and .Cm session open commands. .It Cm session_timeout This value is the time that is added in seconds to a session cookie. .It Cm show_tabs Enable or disable showing tabs. .It Cm show_url Enable or disable showing the url and toolbar. .It Cm show_statusbar Enable or disable showing the status bar. .It Cm single_instance If set only one .Nm will be permitted to run. If there is a URL specified it will be opened in a new tab in the already running .Nm session. .It Cm spell_check_languages The languages to be used for spell checking, separated by commas. For example, en_US. .It Cm ssl_ca_file If set to a valid PEM file all server certificates will be validated against it. The URL bar will be colored green when the certificate is trusted and yellow when untrusted. .Pp If .Cm ssl_ca_file is not set then the URL bar will color all HTTPS connections red. .It Cm ssl_strict_certs If this value is set connections to untrusted sites will be aborted. This value is only used if .Cm ssl_ca_file is set. .It Cm user_agent Set to override the default .Nm user-agent string. .It Cm window_height Set the default height of the browser window. .It Cm window_width Set the default width of the browser window. .It Cm work_dir Set the work directory where all .Nm scratch files are stored. Default is .Cm ~/.xxxterm . .El .Sh HISTORY .Nm was inspired by vimprobable2 and the bloat in other .Ux web browsers. .Sh AUTHORS .An -nosplit .Nm was written by .An Marco Peereboom Aq marco@peereboom.us , .An Stevan Andjelkovic Aq stevan@student.chalmers.se , .An Edd Barrett Aq vext01@gmail.com , and .An Todd T. Fries Aq todd@fries.net . .Sh BUGS When .Cm save_global_history is enabled .Nm is supposed to, in addition to restoring the global history, color the visited links accordingly; however due to bug #51747 in WebKit this does not happen.


context:
space:
mode: