diff --git a/doc/commands.asciidoc b/doc/commands.asciidoc new file mode 100644 index 000000000..edbe9b05d --- /dev/null +++ b/doc/commands.asciidoc @@ -0,0 +1,622 @@ += Commands + +== Normal commands +.Quick reference +[options="header",width="75%",cols="25%,75%"] +|============== +|Command|Description +|<>|Go back in the history of the current tab. +|<>|Cancel the first/[count]th download. +|<>|Download the current page. +|<>|Go forward in the history of the current tab. +|<>|Get the value from a section/option. +|<>|Start hinting. +|<>|Open main startpage in current tab. +|<>|Toggle the web inspector. +|<>|Execute a command after some time. +|<>|Open a "next" link. +|<>|Open a URL in the current/[count]th tab. +|<>|Open a page from the clipboard. +|<>|Open a "previous" link. +|<>|Print the current/[count]th tab. +|<>|Quit qutebrowser. +|<>|Add a new quickmark. +|<>|Load a quickmark. +|<>|Save the current page as a quickmark. +|<>|Quit qutebrowser. +|<>|Reload the current/[count]th tab. +|<>|Report a bug in qutebrowser. +|<>|Restart qutebrowser while keeping existing tabs open. +|<>|Run an userscript given as argument. +|<>|Save the config file. +|<>|Set an option. +|<>|Preset the statusbar to some text. +|<>|Spawn a command in a shell. +|<>|Stop loading in the current/[count]th tab. +|<>|Close the current/[count]th tab. +|<>|Select the tab given as argument/[count]. +|<>|Move the current tab. +|<>|Switch to the next tab, or switch [count] tabs forward. +|<>|Close all tabs except for the current one. +|<>|Switch to the previous tab, or switch [count] tabs back. +|<>|Re-open a closed tab (optionally skipping [count] closed tabs). +|<>|Yank the current URL/title to the clipboard or primary selection. +|<>|Set the zoom level for the current tab. +|<>|Increase the zoom level for the current tab. +|<>|Decrease the zoom level for the current tab. +|============== +[[back]] +=== back +Go back in the history of the current tab. + +[[cancel-download]] +=== cancel-download +Cancel the first/[count]th download. + +[[download-page]] +=== download-page +Download the current page. + +[[forward]] +=== forward +Go forward in the history of the current tab. + +[[get]] +=== get +Syntax: +:get 'sectname' 'optname'+ + +Get the value from a section/option. + +==== positional arguments +* +'sectname'+: The section where the option is in. +* +'optname'+: The name of the option. + +[[hint]] +=== hint +Syntax: +:hint ['group'] ['target'] ['args']+ + +Start hinting. + +==== positional arguments +* +'group'+: The hinting mode to use. + + - `all`: All clickable elements. + - `links`: Only links. + - `images`: Only images. + + + +* +'target'+: What to do with the selected element. + + - `normal`: Open the link in the current tab. + - `tab`: Open the link in a new tab. + - `tab-bg`: Open the link in a new background tab. + - `yank`: Yank the link to the clipboard. + - `yank-primary`: Yank the link to the primary selection. + - `fill`: Fill the commandline with the command given as + argument. + - `cmd-tab`: Fill the commandline with `:open -t` and the + link. + - `cmd-tag-bg`: Fill the commandline with `:open -b` and + the link. + - `rapid`: Open the link in a new tab and stay in hinting mode. + - `download`: Download the link. + - `userscript`: Call an userscript with `$QUTE_URL` set to the + link. + - `spawn`: Spawn a command. + + + +* +'args'+: Arguments for spawn/userscript/fill. + + - With `spawn`: The executable and arguments to spawn. + `{hint-url}` will get replaced by the selected + URL. + - With `userscript`: The userscript to execute. + - With `fill`: The command to fill the statusbar with. + `{hint-url}` will get replaced by the selected + URL. + + +[[home]] +=== home +Open main startpage in current tab. + +[[inspector]] +=== inspector +Toggle the web inspector. + +[[later]] +=== later +Syntax: +:later 'ms' 'command' ['command' ...]+ + +Execute a command after some time. + +==== positional arguments +* +'ms'+: How many milliseconds to wait. +* +'command'+: The command/args to run. + +[[next-page]] +=== next-page +Syntax: +:next-page [*--tab*]+ + +Open a "next" link. + +This tries to automatically click on typical "Next Page" links using some heuristics. + +==== optional arguments +* +*-t*+, +*--tab*+: Whether to open a new tab. + +[[open]] +=== open +Syntax: +:open [*--bg*] [*--tab*] 'urlstr'+ + +Open a URL in the current/[count]th tab. + +==== positional arguments +* +'urlstr'+: The URL to open, as string. + +==== optional arguments +* +*-b*+, +*--bg*+: Whether to open in a background tab. +* +*-t*+, +*--tab*+: Whether to open in a tab. + +[[paste]] +=== paste +Syntax: +:paste [*--sel*] [*--tab*]+ + +Open a page from the clipboard. + +==== optional arguments +* +*-s*+, +*--sel*+: True to use primary selection, False to use clipboard +* +*-t*+, +*--tab*+: True to open in a new tab. + +[[prev-page]] +=== prev-page +Syntax: +:prev-page [*--tab*]+ + +Open a "previous" link. + +This tries to automaticall click on typical "Previous Page" links using some heuristics. + +==== optional arguments +* +*-t*+, +*--tab*+: Whether to open a new tab. + +[[print]] +=== print +Syntax: +:print [*--preview*]+ + +Print the current/[count]th tab. + +==== optional arguments +* +*-p*+, +*--preview*+: Whether to preview instead of printing. + +[[q]] +=== q +Syntax: +:quit+ + +Quit qutebrowser. + +[[quickmark-add]] +=== quickmark-add +Syntax: +:quickmark-add 'urlstr' 'name'+ + +Add a new quickmark. + +==== positional arguments +* +'urlstr'+: The url to add as quickmark, as string. +* +'name'+: The name for the new quickmark. + +[[quickmark-load]] +=== quickmark-load +Syntax: +:quickmark-load [*--tab*] [*--bg*] 'name'+ + +Load a quickmark. + +==== positional arguments +* +'name'+: The name of the quickmark to load. + +==== optional arguments +* +*-t*+, +*--tab*+: Whether to load the quickmark in a new tab. +* +*-b*+, +*--bg*+: Whether to load the quickmark in the background. + +[[quickmark-save]] +=== quickmark-save +Save the current page as a quickmark. + +[[quit]] +=== quit +Quit qutebrowser. + +[[reload]] +=== reload +Reload the current/[count]th tab. + +[[report]] +=== report +Report a bug in qutebrowser. + +[[restart]] +=== restart +Restart qutebrowser while keeping existing tabs open. + +[[run-userscript]] +=== run-userscript +Syntax: +:run-userscript 'cmd' ['args' ['args' ...]]+ + +Run an userscript given as argument. + +==== positional arguments +* +'cmd'+: The userscript to run. +* +'args'+: Arguments to pass to the userscript. + +[[save]] +=== save +Save the config file. + +[[set]] +=== set +Syntax: +:set [*--temp*] 'sectname' 'optname' 'value'+ + +Set an option. + +==== positional arguments +* +'sectname'+: The section where the option is in. +* +'optname'+: The name of the option. +* +'value'+: The value to set. + +==== optional arguments +* +*-t*+, +*--temp*+: Set value temporarely. + +[[set-cmd-text]] +=== set-cmd-text +Syntax: +:set-cmd-text 'text'+ + +Preset the statusbar to some text. + +==== positional arguments +* +'text'+: The commandline to set. + +[[spawn]] +=== spawn +Syntax: +:spawn ['args' ['args' ...]]+ + +Spawn a command in a shell. + +Note the {url} variable which gets replaced by the current URL might be useful here. + +==== positional arguments +* +'args'+: The commandline to execute. + +[[stop]] +=== stop +Stop loading in the current/[count]th tab. + +[[tab-close]] +=== tab-close +Close the current/[count]th tab. + +[[tab-focus]] +=== tab-focus +Syntax: +:tab-focus ['index']+ + +Select the tab given as argument/[count]. + +==== positional arguments +* +'index'+: The tab index to focus, starting with 1. The special value `last` focuses the last focused tab. + + +[[tab-move]] +=== tab-move +Syntax: +:tab-move ['direction']+ + +Move the current tab. + +==== positional arguments +* +'direction'+: + or - for relative moving, none for absolute. + +[[tab-next]] +=== tab-next +Switch to the next tab, or switch [count] tabs forward. + +[[tab-only]] +=== tab-only +Close all tabs except for the current one. + +[[tab-prev]] +=== tab-prev +Switch to the previous tab, or switch [count] tabs back. + +[[undo]] +=== undo +Re-open a closed tab (optionally skipping [count] closed tabs). + +[[yank]] +=== yank +Syntax: +:yank [*--title*] [*--sel*]+ + +Yank the current URL/title to the clipboard or primary selection. + +==== optional arguments +* +*-t*+, +*--title*+: Whether to yank the title instead of the URL. +* +*-s*+, +*--sel*+: True to use primary selection, False to use clipboard + +[[zoom]] +=== zoom +Syntax: +:zoom ['zoom']+ + +Set the zoom level for the current tab. + +The zoom can be given as argument or as [count]. If neither of both is given, the zoom is set to 100%. + +==== positional arguments +* +'zoom'+: The zoom percentage to set. + +[[zoom-in]] +=== zoom-in +Increase the zoom level for the current tab. + +[[zoom-out]] +=== zoom-out +Decrease the zoom level for the current tab. + + +== Hidden commands +.Quick reference +[options="header",width="75%",cols="25%,75%"] +|============== +|Command|Description +|<>|Execute the command currently in the commandline. +|<>|Go forward in the commandline history. +|<>|Go back in the commandline history. +|<>|Select the next completion item. +|<>|Select the previous completion item. +|<>|Enter a key mode. +|<>|Follow the currently selected hint. +|<>|Leave the mode we're currently in. +|<>|Open an external editor with the currently selected form field. +|<>|Accept the current prompt. +|<>|Answer no to a yes/no prompt. +|<>|Answer yes to a yes/no prompt. +|<>|Move back a character. +|<>|Delete the character before the cursor. +|<>|Move back to the start of the current or previous word. +|<>|Move to the start of the line. +|<>|Delete the character after the cursor. +|<>|Move to the end of the line. +|<>|Move forward a character. +|<>|Move forward to the end of the next word. +|<>|Remove chars from the cursor to the end of the line. +|<>|Remove chars from the cursor to the end of the current word. +|<>|Remove chars backward from the cursor to the beginning of the line. +|<>|Remove chars from the cursor to the beginning of the word. +|<>|Paste the most recently deleted text. +|<>|Scroll the current tab by 'count * dx/dy'. +|<>|Scroll the frame page-wise. +|<>|Scroll to a specific percentage of the page. +|<>|Continue the search to the ([count]th) next term. +|<>|Continue the search to the ([count]th) previous term. +|============== +[[command-accept]] +=== command-accept +Execute the command currently in the commandline. + +[[command-history-next]] +=== command-history-next +Go forward in the commandline history. + +[[command-history-prev]] +=== command-history-prev +Go back in the commandline history. + +[[completion-item-next]] +=== completion-item-next +Select the next completion item. + +[[completion-item-prev]] +=== completion-item-prev +Select the previous completion item. + +[[enter-mode]] +=== enter-mode +Syntax: +:enter-mode 'mode'+ + +Enter a key mode. + +==== positional arguments +* +'mode'+: The mode to enter. + +[[follow-hint]] +=== follow-hint +Follow the currently selected hint. + +[[leave-mode]] +=== leave-mode +Leave the mode we're currently in. + +[[open-editor]] +=== open-editor +Open an external editor with the currently selected form field. + +The editor which should be launched can be configured via the `general -> editor` config option. + +[[prompt-accept]] +=== prompt-accept +Accept the current prompt. + +[[prompt-no]] +=== prompt-no +Answer no to a yes/no prompt. + +[[prompt-yes]] +=== prompt-yes +Answer yes to a yes/no prompt. + +[[rl-backward-char]] +=== rl-backward-char +Move back a character. + +This acts like readline's backward-char. + +[[rl-backward-delete-char]] +=== rl-backward-delete-char +Delete the character before the cursor. + +This acts like readline's backward-delete-char. + +[[rl-backward-word]] +=== rl-backward-word +Move back to the start of the current or previous word. + +This acts like readline's backward-word. + +[[rl-beginning-of-line]] +=== rl-beginning-of-line +Move to the start of the line. + +This acts like readline's beginning-of-line. + +[[rl-delete-char]] +=== rl-delete-char +Delete the character after the cursor. + +This acts like readline's delete-char. + +[[rl-end-of-line]] +=== rl-end-of-line +Move to the end of the line. + +This acts like readline's end-of-line. + +[[rl-forward-char]] +=== rl-forward-char +Move forward a character. + +This acts like readline's forward-char. + +[[rl-forward-word]] +=== rl-forward-word +Move forward to the end of the next word. + +This acts like readline's forward-word. + +[[rl-kill-line]] +=== rl-kill-line +Remove chars from the cursor to the end of the line. + +This acts like readline's kill-line. + +[[rl-kill-word]] +=== rl-kill-word +Remove chars from the cursor to the end of the current word. + +This acts like readline's kill-word. + +[[rl-unix-line-discard]] +=== rl-unix-line-discard +Remove chars backward from the cursor to the beginning of the line. + +This acts like readline's unix-line-discard. + +[[rl-unix-word-rubout]] +=== rl-unix-word-rubout +Remove chars from the cursor to the beginning of the word. + +This acts like readline's unix-word-rubout. + +[[rl-yank]] +=== rl-yank +Paste the most recently deleted text. + +This acts like readline's yank. + +[[scroll]] +=== scroll +Syntax: +:scroll 'dx' 'dy'+ + +Scroll the current tab by 'count * dx/dy'. + +==== positional arguments +* +'dx'+: How much to scroll in x-direction. +* +'dy'+: How much to scroll in x-direction. + +[[scroll-page]] +=== scroll-page +Syntax: +:scroll-page 'x' 'y'+ + +Scroll the frame page-wise. + +==== positional arguments +* +'x'+: How many pages to scroll to the right. +* +'y'+: How many pages to scroll down. + +[[scroll-perc]] +=== scroll-perc +Syntax: +:scroll-perc [*--horizontal*] ['perc']+ + +Scroll to a specific percentage of the page. + +The percentage can be given either as argument or as count. If no percentage is given, the page is scrolled to the end. + +==== positional arguments +* +'perc'+: Percentage to scroll. + +==== optional arguments +* +*-x*+, +*--horizontal*+: Whether to scroll horizontally. + +[[search-next]] +=== search-next +Continue the search to the ([count]th) next term. + +[[search-prev]] +=== search-prev +Continue the search to the ([count]th) previous term. + + +== Debugging commands +These commands are mainly intended for debugging. They are hidden if qutebrowser was started without the `--debug`-flag. + +.Quick reference +[options="header",width="75%",cols="25%,75%"] +|============== +|Command|Description +|<>|Print a list of all objects to the debug log. +|<>|Print a list of all widgets to debug log. +|<>|Print LRU cache stats. +|<>|Show the debugging console. +|<>|Crash for debugging purposes. +|<>|Evaluate a python string and display the results as a webpage. +|============== +[[debug-all-objects]] +=== debug-all-objects +Print a list of all objects to the debug log. + +[[debug-all-widgets]] +=== debug-all-widgets +Print a list of all widgets to debug log. + +[[debug-cache-stats]] +=== debug-cache-stats +Print LRU cache stats. + +[[debug-console]] +=== debug-console +Show the debugging console. + +[[debug-crash]] +=== debug-crash +Syntax: +:debug-crash ['typ']+ + +Crash for debugging purposes. + +==== positional arguments +* +'typ'+: either 'exception' or 'segfault'. + +[[debug-pyeval]] +=== debug-pyeval +Syntax: +:debug-pyeval 's'+ + +Evaluate a python string and display the results as a webpage. + +==== positional arguments +* +'s'+: The string to evaluate. + diff --git a/doc/settings.asciidoc b/doc/settings.asciidoc new file mode 100644 index 000000000..e0acf4553 --- /dev/null +++ b/doc/settings.asciidoc @@ -0,0 +1,1255 @@ += Settings + +.Quick reference for section ``general'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Whether to find text on a page case-insensitively. +|<>|Whether to wrap finding text to the top when arriving at the end. +|<>|The default page(s) to open at the start, separated by commas. +|<>|Whether to start a search when something else than a URL is entered. +|<>|Whether to save the config automatically on quit. +|<>|The editor (and arguments) to use for the `open-editor` command. +|<>|Encoding to use for editor. +|<>|Do not record visited pages in the history or store web page icons. +|<>|Enable extra tools for Web developers. +|<>|Whether the background color and images are also drawn when the page is printed. +|<>|Whether load requests should be monitored for cross-site scripting attempts. +|<>|Enable workarounds for broken sites. +|<>|Default encoding to use for websites. +|============== + +.Quick reference for section ``ui'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|The available zoom levels, separated by commas. +|<>|The default zoom level. +|<>|Time (in ms) to show messages in the statusbar for. +|<>|Whether to confirm quitting the application. +|<>|Whether to display javascript statusbar messages. +|<>|Whether the zoom factor on a frame applies only to the text or to all content. +|<>|Whether to expand each subframe to its contents. +|<>|User stylesheet to use. +|<>|Set the CSS media type. +|============== + +.Quick reference for section ``network'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Value to send in the `DNT` header. +|<>|Value to send in the `accept-language` header. +|<>|User agent to send. Empty to send the default. +|<>|The proxy to use. +|<>|Whether to validate SSL handshakes. +|<>|Whether to try to pre-fetch DNS entries to speed up browsing. +|============== + +.Quick reference for section ``completion'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Whether to show the autocompletion window. +|<>|The height of the completion, in px or as percentage of the window. +|<>|How many commands to save in the history. +|<>|Whether to move on to the next part when there's only one possible completion left. +|<>|Whether to shrink the completion to be smaller than the configured size if there are no scrollbars. +|============== + +.Quick reference for section ``input'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Timeout for ambiguous keybindings. +|<>|Whether to switch to insert mode when clicking flash and other plugins. +|<>|Whether to leave insert mode if a non-editable element is clicked. +|<>|Whether to automatically enter insert mode if an editable element is focused after page load. +|<>|Whether to forward unbound keys to the webview in normal mode. +|<>|Enables or disables the Spatial Navigation feature +|<>|Whether hyperlinks should be included in the keyboard focus chain. +|============== + +.Quick reference for section ``tabs'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Whether to open new tabs (middleclick/ctrl+click) in background. +|<>|Which tab to select when the focused tab is removed. +|<>|How new tabs are positioned. +|<>|How new tabs opened explicitely are positioned. +|<>|Behaviour when the last tab is closed. +|<>|Whether to wrap when changing tabs. +|<>|Whether tabs should be movable. +|<>|On which mouse button to close tabs. +|<>|The position of the tab bar. +|<>|Whether to show favicons in the tab bar. +|<>|The width of the tab bar if it's vertical, in px or as percentage of the window. +|<>|Width of the progress indicator (0 to disable). +|<>|Spacing between tab edge and indicator. +|============== + +.Quick reference for section ``storage'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|The directory to save downloads to. An empty value selects a sensible os-specific default. +|<>|The maximum number of pages to hold in the memory page cache. +|<>|The capacities for the memory cache for dead objects such as stylesheets or scripts. Syntax: cacheMinDeadCapacity, cacheMaxDead, totalCapacity. +|<>|Default quota for new offline storage databases. +|<>|Quota for the offline web application cache. +|<>|Whether support for the HTML 5 offline storage feature is enabled. +|<>|Whether support for the HTML 5 web application cache feature is enabled. +|<>|Whether support for the HTML 5 local storage feature is enabled. +|<>|Size of the HTTP network cache. +|============== + +.Quick reference for section ``permissions'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Whether images are automatically loaded in web pages. +|<>|Enables or disables the running of JavaScript programs. +|<>|Enables or disables plugins in Web pages. +|<>|Whether JavaScript programs can open new windows. +|<>|Whether JavaScript programs can close windows. +|<>|Whether JavaScript programs can read or write to the clipboard. +|<>|Whether locally loaded documents are allowed to access remote urls. +|<>|Whether locally loaded documents are allowed to access other local urls. +|<>|Whether to accept cookies. +|<>|Whether to store cookies. +|============== + +.Quick reference for section ``hints'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|CSS border value for hints. +|<>|Opacity for hints. +|<>|Mode to use for hints. +|<>|Chars used for hint strings. +|<>|Whether to auto-follow a hint if there's only one left. +|<>|A comma-separated list of regexes to use for 'next' links. +|<>|A comma-separated list of regexes to use for 'prev' links. +|============== + +.Quick reference for section ``colors'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Text color of the completion widget. +|<>|Background color of the completion widget. +|<>|Background color of completion widget items. +|<>|Foreground color of completion widget category headers. +|<>|Background color of the completion widget category headers. +|<>|Top border color of the completion widget category headers. +|<>|Bottom border color of the completion widget category headers. +|<>|Foreground color of the selected completion item. +|<>|Background color of the selected completion item. +|<>|Top border color of the completion widget category headers. +|<>|Bottom border color of the selected completion item. +|<>|Foreground color of the matched text in the completion. +|<>|Foreground color of the statusbar. +|<>|Foreground color of the statusbar. +|<>|Background color of the statusbar if there was an error. +|<>|Background color of the statusbar if there is a prompt. +|<>|Background color of the statusbar in insert mode. +|<>|Background color of the progress bar. +|<>|Default foreground color of the URL in the statusbar. +|<>|Foreground color of the URL in the statusbar on successful load. +|<>|Foreground color of the URL in the statusbar on error. +|<>|Foreground color of the URL in the statusbar when there's a warning. +|<>|Foreground color of the URL in the statusbar for hovered links. +|<>|Foreground color of tabs. +|<>|Background color of unselected odd tabs. +|<>|Background color of unselected even tabs. +|<>|Background color of selected tabs. +|<>|Background color of the tabbar. +|<>|Color gradient start for the tab indicator. +|<>|Color gradient end for the tab indicator. +|<>|Color for the tab indicator on errors.. +|<>|Color gradient interpolation system for the tab indicator. +|<>|Color for the tab seperator. +|<>|Font color for hints. +|<>|Font color for the matched part of hints. +|<>|Background color for hints. +|<>|Foreground color for downloads. +|<>|Background color for the download bar. +|<>|Color gradient start for downloads. +|<>|Color gradient end for downloads. +|<>|Color gradient interpolation system for downloads. +|============== + +.Quick reference for section ``fonts'' +[options="header",width="75%",cols="25%,75%"] +|============== +|Setting|Description +|<>|Default monospace fonts. +|<>|Font used in the completion widget. +|<>|Font used in the tabbar. +|<>|Font used in the statusbar. +|<>|Font used for the downloadbar. +|<>|Font used for the hints. +|<>|Font used for the debugging console. +|<>|Font family for standard fonts. +|<>|Font family for fixed fonts. +|<>|Font family for serif fonts. +|<>|Font family for sans-serif fonts. +|<>|Font family for cursive fonts. +|<>|Font family for fantasy fonts. +|<>|The hard minimum font size. +|<>|The minimum logical font size that is applied when zooming out. +|<>|The default font size for regular text. +|<>|The default font size for fixed-pitch text. +|============== + +== general +General/miscellaneous options. + +[[general-ignore-case]] +=== ignore-case +Whether to find text on a page case-insensitively. + +Default: +pass:[smart]+ + +[[general-wrap-search]] +=== wrap-search +Whether to wrap finding text to the top when arriving at the end. + +Default: +pass:[true]+ + +[[general-startpage]] +=== startpage +The default page(s) to open at the start, separated by commas. + +Default: +pass:[http://www.duckduckgo.com]+ + +[[general-auto-search]] +=== auto-search +Whether to start a search when something else than a URL is entered. + +Valid values: + + * +naive+: Use simple/naive check. + * +dns+: Use DNS requests (might be slow!). + * +false+: Never search automatically. + +Default: +pass:[naive]+ + +[[general-auto-save-config]] +=== auto-save-config +Whether to save the config automatically on quit. + +Default: +pass:[true]+ + +[[general-editor]] +=== editor +The editor (and arguments) to use for the `open-editor` command. + +Use `{}` for the filename. The value gets split like in a shell, so you can use `"` or `'` to quote arguments. + +Default: +pass:[gvim -f "{}"]+ + +[[general-editor-encoding]] +=== editor-encoding +Encoding to use for editor. + +Default: +pass:[utf-8]+ + +[[general-private-browsing]] +=== private-browsing +Do not record visited pages in the history or store web page icons. + +Default: +pass:[false]+ + +[[general-developer-extras]] +=== developer-extras +Enable extra tools for Web developers. + +This needs to be enabled for `:inspector` to work and also adds an _Inspect_ entry to the context menu. + +Default: +pass:[false]+ + +[[general-print-element-backgrounds]] +=== print-element-backgrounds +Whether the background color and images are also drawn when the page is printed. + +Default: +pass:[true]+ + +[[general-xss-auditing]] +=== xss-auditing +Whether load requests should be monitored for cross-site scripting attempts. + +Suspicious scripts will be blocked and reported in the inspector's JavaScript console. Enabling this feature might have an impact on performance. + +Default: +pass:[false]+ + +[[general-site-specific-quirks]] +=== site-specific-quirks +Enable workarounds for broken sites. + +Default: +pass:[true]+ + +[[general-default-encoding]] +=== default-encoding +Default encoding to use for websites. + +The encoding must be a string describing an encoding such as _utf-8_, _iso-8859-1_, etc. If left empty a default value will be used. + +Default: empty + +== ui +General options related to the user interface. + +[[ui-zoom-levels]] +=== zoom-levels +The available zoom levels, separated by commas. + +Default: +pass:[25%,33%,50%,67%,75%,90%,100%,110%,125%,150%,175%,200%,250%,300%,400%,500%]+ + +[[ui-default-zoom]] +=== default-zoom +The default zoom level. + +Default: +pass:[100%]+ + +[[ui-message-timeout]] +=== message-timeout +Time (in ms) to show messages in the statusbar for. + +Default: +pass:[2000]+ + +[[ui-confirm-quit]] +=== confirm-quit +Whether to confirm quitting the application. + +Valid values: + + * +always+: Always show a confirmation. + * +multiple-tabs+: Show a confirmation if multiple tabs are opened. + * +never+: Never show a confirmation. + +Default: +pass:[never]+ + +[[ui-display-statusbar-messages]] +=== display-statusbar-messages +Whether to display javascript statusbar messages. + +Default: +pass:[false]+ + +[[ui-zoom-text-only]] +=== zoom-text-only +Whether the zoom factor on a frame applies only to the text or to all content. + +Default: +pass:[false]+ + +[[ui-frame-flattening]] +=== frame-flattening +Whether to expand each subframe to its contents. + +This will flatten all the frames to become one scrollable page. + +Default: +pass:[false]+ + +[[ui-user-stylesheet]] +=== user-stylesheet +User stylesheet to use. + +Default: empty + +[[ui-css-media-type]] +=== css-media-type +Set the CSS media type. + +Default: empty + +== network +Settings related to the network. + +[[network-do-not-track]] +=== do-not-track +Value to send in the `DNT` header. + +Default: +pass:[true]+ + +[[network-accept-language]] +=== accept-language +Value to send in the `accept-language` header. + +Default: +pass:[en-US,en]+ + +[[network-user-agent]] +=== user-agent +User agent to send. Empty to send the default. + +Default: empty + +[[network-proxy]] +=== proxy +The proxy to use. + +In addition to the listed values, you can use a `socks://...` or `http://...` URL. + +Valid values: + + * +system+: Use the system wide proxy. + * +none+: Don't use any proxy + +Default: +pass:[system]+ + +[[network-ssl-strict]] +=== ssl-strict +Whether to validate SSL handshakes. + +Default: +pass:[true]+ + +[[network-dns-prefetch]] +=== dns-prefetch +Whether to try to pre-fetch DNS entries to speed up browsing. + +Default: +pass:[true]+ + +== completion +Options related to completion and command history. + +[[completion-show]] +=== show +Whether to show the autocompletion window. + +Default: +pass:[true]+ + +[[completion-height]] +=== height +The height of the completion, in px or as percentage of the window. + +Default: +pass:[50%]+ + +[[completion-history-length]] +=== history-length +How many commands to save in the history. + +0: no history / -1: unlimited + +Default: +pass:[100]+ + +[[completion-quick-complete]] +=== quick-complete +Whether to move on to the next part when there's only one possible completion left. + +Default: +pass:[true]+ + +[[completion-shrink]] +=== shrink +Whether to shrink the completion to be smaller than the configured size if there are no scrollbars. + +Default: +pass:[false]+ + +== input +Options related to input modes. + +[[input-timeout]] +=== timeout +Timeout for ambiguous keybindings. + +Default: +pass:[500]+ + +[[input-insert-mode-on-plugins]] +=== insert-mode-on-plugins +Whether to switch to insert mode when clicking flash and other plugins. + +Default: +pass:[false]+ + +[[input-auto-leave-insert-mode]] +=== auto-leave-insert-mode +Whether to leave insert mode if a non-editable element is clicked. + +Default: +pass:[true]+ + +[[input-auto-insert-mode]] +=== auto-insert-mode +Whether to automatically enter insert mode if an editable element is focused after page load. + +Default: +pass:[false]+ + +[[input-forward-unbound-keys]] +=== forward-unbound-keys +Whether to forward unbound keys to the webview in normal mode. + +Valid values: + + * +all+: Forward all unbound keys. + * +auto+: Forward unbound non-alphanumeric keys. + * +none+: Don't forward any keys. + +Default: +pass:[auto]+ + +[[input-spatial-navigation]] +=== spatial-navigation +Enables or disables the Spatial Navigation feature + +Spatial navigation consists in the ability to navigate between focusable elements in a Web page, such as hyperlinks and form controls, by using Left, Right, Up and Down arrow keys. For example, if a user presses the Right key, heuristics determine whether there is an element he might be trying to reach towards the right and which element he probably wants. + +Default: +pass:[false]+ + +[[input-links-included-in-focus-chain]] +=== links-included-in-focus-chain +Whether hyperlinks should be included in the keyboard focus chain. + +Default: +pass:[true]+ + +== tabs +Configuration of the tab bar. + +[[tabs-background-tabs]] +=== background-tabs +Whether to open new tabs (middleclick/ctrl+click) in background. + +Default: +pass:[false]+ + +[[tabs-select-on-remove]] +=== select-on-remove +Which tab to select when the focused tab is removed. + +Valid values: + + * +left+: Select the tab on the left. + * +right+: Select the tab on the right. + * +previous+: Select the previously selected tab. + +Default: +pass:[right]+ + +[[tabs-new-tab-position]] +=== new-tab-position +How new tabs are positioned. + +Valid values: + + * +left+: On the left of the current tab. + * +right+: On the right of the current tab. + * +first+: At the left end. + * +last+: At the right end. + +Default: +pass:[right]+ + +[[tabs-new-tab-position-explicit]] +=== new-tab-position-explicit +How new tabs opened explicitely are positioned. + +Valid values: + + * +left+: On the left of the current tab. + * +right+: On the right of the current tab. + * +first+: At the left end. + * +last+: At the right end. + +Default: +pass:[last]+ + +[[tabs-last-close]] +=== last-close +Behaviour when the last tab is closed. + +Valid values: + + * +ignore+: Don't do anything. + * +blank+: Load a blank page. + * +quit+: Quit qutebrowser. + +Default: +pass:[ignore]+ + +[[tabs-wrap]] +=== wrap +Whether to wrap when changing tabs. + +Default: +pass:[true]+ + +[[tabs-movable]] +=== movable +Whether tabs should be movable. + +Default: +pass:[true]+ + +[[tabs-close-mouse-button]] +=== close-mouse-button +On which mouse button to close tabs. + +Valid values: + + * +right+: Close tabs on right-click. + * +middle+: Close tabs on middle-click. + * +none+: Don't close tabs using the mouse. + +Default: +pass:[middle]+ + +[[tabs-position]] +=== position +The position of the tab bar. + +Valid values: + + * +north+ + * +south+ + * +east+ + * +west+ + +Default: +pass:[north]+ + +[[tabs-show-favicons]] +=== show-favicons +Whether to show favicons in the tab bar. + +Default: +pass:[true]+ + +[[tabs-width]] +=== width +The width of the tab bar if it's vertical, in px or as percentage of the window. + +Default: +pass:[20%]+ + +[[tabs-indicator-width]] +=== indicator-width +Width of the progress indicator (0 to disable). + +Default: +pass:[3]+ + +[[tabs-indicator-space]] +=== indicator-space +Spacing between tab edge and indicator. + +Default: +pass:[3]+ + +== storage +Settings related to cache and storage. + +[[storage-download-directory]] +=== download-directory +The directory to save downloads to. An empty value selects a sensible os-specific default. + +Default: empty + +[[storage-maximum-pages-in-cache]] +=== maximum-pages-in-cache +The maximum number of pages to hold in the memory page cache. + +The Page Cache allows for a nicer user experience when navigating forth or back to pages in the forward/back history, by pausing and resuming up to _n_ pages. + +For more information about the feature, please refer to: http://webkit.org/blog/427/webkit-page-cache-i-the-basics/ + +Default: empty + +[[storage-object-cache-capacities]] +=== object-cache-capacities +The capacities for the memory cache for dead objects such as stylesheets or scripts. Syntax: cacheMinDeadCapacity, cacheMaxDead, totalCapacity. + +The _cacheMinDeadCapacity_ specifies the minimum number of bytes that dead objects should consume when the cache is under pressure. + +_cacheMaxDead_ is the maximum number of bytes that dead objects should consume when the cache is *not* under pressure. + +_totalCapacity_ specifies the maximum number of bytes that the cache should consume *overall*. + +Default: empty + +[[storage-offline-storage-default-quota]] +=== offline-storage-default-quota +Default quota for new offline storage databases. + +Default: empty + +[[storage-offline-web-application-cache-quota]] +=== offline-web-application-cache-quota +Quota for the offline web application cache. + +Default: empty + +[[storage-offline-storage-database]] +=== offline-storage-database +Whether support for the HTML 5 offline storage feature is enabled. + +Default: +pass:[true]+ + +[[storage-offline-web-application-storage]] +=== offline-web-application-storage +Whether support for the HTML 5 web application cache feature is enabled. + +An application cache acts like an HTTP cache in some sense. For documents that use the application cache via JavaScript, the loader engine will first ask the application cache for the contents, before hitting the network. + +The feature is described in details at: http://dev.w3.org/html5/spec/Overview.html#appcache + +Default: +pass:[true]+ + +[[storage-local-storage]] +=== local-storage +Whether support for the HTML 5 local storage feature is enabled. + +Default: +pass:[true]+ + +[[storage-cache-size]] +=== cache-size +Size of the HTTP network cache. + +Default: +pass:[52428800]+ + +== permissions +Loaded plugins/scripts and allowed actions. + +[[permissions-allow-images]] +=== allow-images +Whether images are automatically loaded in web pages. + +Default: +pass:[true]+ + +[[permissions-allow-javascript]] +=== allow-javascript +Enables or disables the running of JavaScript programs. + +Default: +pass:[true]+ + +[[permissions-allow-plugins]] +=== allow-plugins +Enables or disables plugins in Web pages. + +Qt plugins with a mimetype such as "application/x-qt-plugin" are not affected by this setting. + +Default: +pass:[false]+ + +[[permissions-javascript-can-open-windows]] +=== javascript-can-open-windows +Whether JavaScript programs can open new windows. + +Default: +pass:[false]+ + +[[permissions-javascript-can-close-windows]] +=== javascript-can-close-windows +Whether JavaScript programs can close windows. + +Default: +pass:[false]+ + +[[permissions-javascript-can-access-clipboard]] +=== javascript-can-access-clipboard +Whether JavaScript programs can read or write to the clipboard. + +Default: +pass:[false]+ + +[[permissions-local-content-can-access-remote-urls]] +=== local-content-can-access-remote-urls +Whether locally loaded documents are allowed to access remote urls. + +Default: +pass:[false]+ + +[[permissions-local-content-can-access-file-urls]] +=== local-content-can-access-file-urls +Whether locally loaded documents are allowed to access other local urls. + +Default: +pass:[true]+ + +[[permissions-cookies-accept]] +=== cookies-accept +Whether to accept cookies. + +Valid values: + + * +default+: Default QtWebKit behaviour. + * +never+: Don't accept cookies at all. + +Default: +pass:[default]+ + +[[permissions-cookies-store]] +=== cookies-store +Whether to store cookies. + +Default: +pass:[true]+ + +== hints +Hinting settings. + +[[hints-border]] +=== border +CSS border value for hints. + +Default: +pass:[1px solid #E3BE23]+ + +[[hints-opacity]] +=== opacity +Opacity for hints. + +Default: +pass:[0.7]+ + +[[hints-mode]] +=== mode +Mode to use for hints. + +Valid values: + + * +number+: Use numeric hints. + * +letter+: Use the chars in the hints -> chars setting. + +Default: +pass:[letter]+ + +[[hints-chars]] +=== chars +Chars used for hint strings. + +Default: +pass:[asdfghjkl]+ + +[[hints-auto-follow]] +=== auto-follow +Whether to auto-follow a hint if there's only one left. + +Default: +pass:[true]+ + +[[hints-next-regexes]] +=== next-regexes +A comma-separated list of regexes to use for 'next' links. + +Default: +pass:[\bnext\b,\bmore\b,\bnewer\b,\b[>→≫]\b,\b(>>|»)\b]+ + +[[hints-prev-regexes]] +=== prev-regexes +A comma-separated list of regexes to use for 'prev' links. + +Default: +pass:[\bprev(ious)?\b,\bback\b,\bolder\b,\b[<←≪]\b,\b(<<|«)\b]+ + +== searchengines +Definitions of search engines which can be used via the address bar. +The searchengine named `DEFAULT` is used when `general -> auto-search` is true and something else than a URL was entered to be opened. Other search engines can be used via the bang-syntax, e.g. `:open qutebrowser !google`. The string `{}` will be replaced by the search term, use `{{` and `}}` for literal `{`/`}` signs. + +== keybind +Bindings from a key(chain) to a command. +For special keys (can't be part of a keychain), enclose them in `<`...`>`. For modifiers, you can use either `-` or `+` as delimiters, and these names: + + * Control: `Control`, `Ctrl` + * Meta: `Meta`, `Windows`, `Mod4` + * Alt: `Alt`, `Mod1` + * Shift: `Shift` + +For simple keys (no `<>`-signs), a capital letter means the key is pressed with Shift. For special keys (with `<>`-signs), you need to explicitely add `Shift-` to match a key pressed with shift. You can bind multiple commands by separating them with `;;`. + +== keybind.insert +Keybindings for insert mode. +Since normal keypresses are passed through, only special keys are supported in this mode. +Useful hidden commands to map in this section: + + * `open-editor`: Open a texteditor with the focused field. + * `leave-mode`: Leave the command mode. + +== keybind.hint +Keybindings for hint mode. +Since normal keypresses are passed through, only special keys are supported in this mode. +Useful hidden commands to map in this section: + + * `follow-hint`: Follow the currently selected hint. + * `leave-mode`: Leave the command mode. + +== keybind.passthrough +Keybindings for passthrough mode. +Since normal keypresses are passed through, only special keys are supported in this mode. +Useful hidden commands to map in this section: + + * `leave-mode`: Leave the passthrough mode. + +== keybind.command +Keybindings for command mode. +Since normal keypresses are passed through, only special keys are supported in this mode. +Useful hidden commands to map in this section: + + * `command-history-prev`: Switch to previous command in history. + * `command-history-next`: Switch to next command in history. + * `completion-item-prev`: Select previous item in completion. + * `completion-item-next`: Select next item in completion. + * `command-accept`: Execute the command currently in the commandline. + * `leave-mode`: Leave the command mode. + +== keybind.prompt +Keybindings for prompts in the status line. +You can bind normal keys in this mode, but they will be only active when a yes/no-prompt is asked. For other prompt modes, you can only bind special keys. +Useful hidden commands to map in this section: + + * `prompt-accept`: Confirm the entered value. + * `prompt-yes`: Answer yes to a yes/no question. + * `prompt-no`: Answer no to a yes/no question. + * `leave-mode`: Leave the prompt mode. + +== aliases +Aliases for commands. +By default, no aliases are defined. Example which adds a new command `:qtb` to open qutebrowsers website: + +`qtb = open http://www.qutebrowser.org/` + +== colors +Colors used in the UI. +A value can be in one of the following format: + + * `#RGB`/`#RRGGBB`/`#RRRGGGBBB`/`#RRRRGGGGBBBB` + * A SVG color name as specified in http://www.w3.org/TR/SVG/types.html#ColorKeywords[the W3C specification]. + * transparent (no color) + * `rgb(r, g, b)` / `rgba(r, g, b, a)` (values 0-255 or percentages) + * `hsv(h, s, v)` / `hsva(h, s, v, a)` (values 0-255, hue 0-359) + * A gradient as explained in http://qt-project.org/doc/qt-4.8/stylesheet-reference.html#list-of-property-types[the Qt documentation] under ``Gradient''. + +The `hints.*` values are a special case as they're real CSS colors, not Qt-CSS colors. There, for a gradient, you need to use `-webkit-gradient`, see https://www.webkit.org/blog/175/introducing-css-gradients/[the WebKit documentation]. + +[[colors-completion.fg]] +=== completion.fg +Text color of the completion widget. + +Default: +pass:[white]+ + +[[colors-completion.bg]] +=== completion.bg +Background color of the completion widget. + +Default: +pass:[#333333]+ + +[[colors-completion.item.bg]] +=== completion.item.bg +Background color of completion widget items. + +Default: +pass:[${completion.bg}]+ + +[[colors-completion.category.fg]] +=== completion.category.fg +Foreground color of completion widget category headers. + +Default: +pass:[white]+ + +[[colors-completion.category.bg]] +=== completion.category.bg +Background color of the completion widget category headers. + +Default: +pass:[qlineargradient(x1:0, y1:0, x2:0, y2:1, stop:0 #888888, stop:1 #505050)]+ + +[[colors-completion.category.border.top]] +=== completion.category.border.top +Top border color of the completion widget category headers. + +Default: +pass:[black]+ + +[[colors-completion.category.border.bottom]] +=== completion.category.border.bottom +Bottom border color of the completion widget category headers. + +Default: +pass:[${completion.category.border.top}]+ + +[[colors-completion.item.selected.fg]] +=== completion.item.selected.fg +Foreground color of the selected completion item. + +Default: +pass:[black]+ + +[[colors-completion.item.selected.bg]] +=== completion.item.selected.bg +Background color of the selected completion item. + +Default: +pass:[#e8c000]+ + +[[colors-completion.item.selected.border.top]] +=== completion.item.selected.border.top +Top border color of the completion widget category headers. + +Default: +pass:[#bbbb00]+ + +[[colors-completion.item.selected.border.bottom]] +=== completion.item.selected.border.bottom +Bottom border color of the selected completion item. + +Default: +pass:[${completion.item.selected.border.top}]+ + +[[colors-completion.match.fg]] +=== completion.match.fg +Foreground color of the matched text in the completion. + +Default: +pass:[#ff4444]+ + +[[colors-statusbar.bg]] +=== statusbar.bg +Foreground color of the statusbar. + +Default: +pass:[black]+ + +[[colors-statusbar.fg]] +=== statusbar.fg +Foreground color of the statusbar. + +Default: +pass:[white]+ + +[[colors-statusbar.bg.error]] +=== statusbar.bg.error +Background color of the statusbar if there was an error. + +Default: +pass:[red]+ + +[[colors-statusbar.bg.prompt]] +=== statusbar.bg.prompt +Background color of the statusbar if there is a prompt. + +Default: +pass:[darkblue]+ + +[[colors-statusbar.bg.insert]] +=== statusbar.bg.insert +Background color of the statusbar in insert mode. + +Default: +pass:[darkgreen]+ + +[[colors-statusbar.progress.bg]] +=== statusbar.progress.bg +Background color of the progress bar. + +Default: +pass:[white]+ + +[[colors-statusbar.url.fg]] +=== statusbar.url.fg +Default foreground color of the URL in the statusbar. + +Default: +pass:[${statusbar.fg}]+ + +[[colors-statusbar.url.fg.success]] +=== statusbar.url.fg.success +Foreground color of the URL in the statusbar on successful load. + +Default: +pass:[lime]+ + +[[colors-statusbar.url.fg.error]] +=== statusbar.url.fg.error +Foreground color of the URL in the statusbar on error. + +Default: +pass:[orange]+ + +[[colors-statusbar.url.fg.warn]] +=== statusbar.url.fg.warn +Foreground color of the URL in the statusbar when there's a warning. + +Default: +pass:[yellow]+ + +[[colors-statusbar.url.fg.hover]] +=== statusbar.url.fg.hover +Foreground color of the URL in the statusbar for hovered links. + +Default: +pass:[aqua]+ + +[[colors-tab.fg]] +=== tab.fg +Foreground color of tabs. + +Default: +pass:[white]+ + +[[colors-tab.bg.odd]] +=== tab.bg.odd +Background color of unselected odd tabs. + +Default: +pass:[grey]+ + +[[colors-tab.bg.even]] +=== tab.bg.even +Background color of unselected even tabs. + +Default: +pass:[darkgrey]+ + +[[colors-tab.bg.selected]] +=== tab.bg.selected +Background color of selected tabs. + +Default: +pass:[black]+ + +[[colors-tab.bg.bar]] +=== tab.bg.bar +Background color of the tabbar. + +Default: +pass:[#555555]+ + +[[colors-tab.indicator.start]] +=== tab.indicator.start +Color gradient start for the tab indicator. + +Default: +pass:[#0000aa]+ + +[[colors-tab.indicator.stop]] +=== tab.indicator.stop +Color gradient end for the tab indicator. + +Default: +pass:[#00aa00]+ + +[[colors-tab.indicator.error]] +=== tab.indicator.error +Color for the tab indicator on errors.. + +Default: +pass:[#ff0000]+ + +[[colors-tab.indicator.system]] +=== tab.indicator.system +Color gradient interpolation system for the tab indicator. + +Valid values: + + * +rgb+: Interpolate in the RGB color system. + * +hsv+: Interpolate in the HSV color system. + * +hsl+: Interpolate in the HSL color system. + +Default: +pass:[rgb]+ + +[[colors-tab.seperator]] +=== tab.seperator +Color for the tab seperator. + +Default: +pass:[#555555]+ + +[[colors-hints.fg]] +=== hints.fg +Font color for hints. + +Default: +pass:[black]+ + +[[colors-hints.fg.match]] +=== hints.fg.match +Font color for the matched part of hints. + +Default: +pass:[green]+ + +[[colors-hints.bg]] +=== hints.bg +Background color for hints. + +Default: +pass:[-webkit-gradient(linear, left top, left bottom, color-stop(0%,#FFF785), color-stop(100%,#FFC542))]+ + +[[colors-downloads.fg]] +=== downloads.fg +Foreground color for downloads. + +Default: +pass:[#ffffff]+ + +[[colors-downloads.bg.bar]] +=== downloads.bg.bar +Background color for the download bar. + +Default: +pass:[black]+ + +[[colors-downloads.bg.start]] +=== downloads.bg.start +Color gradient start for downloads. + +Default: +pass:[#0000aa]+ + +[[colors-downloads.bg.stop]] +=== downloads.bg.stop +Color gradient end for downloads. + +Default: +pass:[#00aa00]+ + +[[colors-downloads.bg.system]] +=== downloads.bg.system +Color gradient interpolation system for downloads. + +Valid values: + + * +rgb+: Interpolate in the RGB color system. + * +hsv+: Interpolate in the HSV color system. + * +hsl+: Interpolate in the HSL color system. + +Default: +pass:[rgb]+ + +== fonts +Fonts used for the UI, with optional style/weight/size. + + * Style: `normal`/`italic`/`oblique` + * Weight: `normal`, `bold`, `100`..`900` + * Size: _number_ `px`/`pt` + +[[fonts-_monospace]] +=== _monospace +Default monospace fonts. + +Default: +pass:[Terminus, Monospace, "DejaVu Sans Mono", Consolas, Monaco, "Bitstream Vera Sans Mono", "Andale Mono", "Liberation Mono", "Courier New", Courier, monospace, Fixed, Terminal]+ + +[[fonts-completion]] +=== completion +Font used in the completion widget. + +Default: +pass:[8pt ${_monospace}]+ + +[[fonts-tabbar]] +=== tabbar +Font used in the tabbar. + +Default: +pass:[8pt ${_monospace}]+ + +[[fonts-statusbar]] +=== statusbar +Font used in the statusbar. + +Default: +pass:[8pt ${_monospace}]+ + +[[fonts-downloads]] +=== downloads +Font used for the downloadbar. + +Default: +pass:[8pt ${_monospace}]+ + +[[fonts-hints]] +=== hints +Font used for the hints. + +Default: +pass:[bold 12px Monospace]+ + +[[fonts-debug-console]] +=== debug-console +Font used for the debugging console. + +Default: +pass:[8pt ${_monospace}]+ + +[[fonts-web-family-standard]] +=== web-family-standard +Font family for standard fonts. + +Default: empty + +[[fonts-web-family-fixed]] +=== web-family-fixed +Font family for fixed fonts. + +Default: empty + +[[fonts-web-family-serif]] +=== web-family-serif +Font family for serif fonts. + +Default: empty + +[[fonts-web-family-sans-serif]] +=== web-family-sans-serif +Font family for sans-serif fonts. + +Default: empty + +[[fonts-web-family-cursive]] +=== web-family-cursive +Font family for cursive fonts. + +Default: empty + +[[fonts-web-family-fantasy]] +=== web-family-fantasy +Font family for fantasy fonts. + +Default: empty + +[[fonts-web-size-minimum]] +=== web-size-minimum +The hard minimum font size. + +Default: empty + +[[fonts-web-size-minimum-logical]] +=== web-size-minimum-logical +The minimum logical font size that is applied when zooming out. + +Default: empty + +[[fonts-web-size-default]] +=== web-size-default +The default font size for regular text. + +Default: empty + +[[fonts-web-size-default-fixed]] +=== web-size-default-fixed +The default font size for fixed-pitch text. + +Default: empty diff --git a/qutebrowser/commands/argparser.py b/qutebrowser/commands/argparser.py index 01e44e79e..884582a4b 100644 --- a/qutebrowser/commands/argparser.py +++ b/qutebrowser/commands/argparser.py @@ -55,7 +55,7 @@ class HelpAction(argparse.Action): def __call__(self, parser, _namespace, _values, _option_string=None): QCoreApplication.instance().mainwindow.tabs.tabopen( - QUrl('qute:help/commands.html#{}'.format(parser.name))) + QUrl('qute://help/commands.html#{}'.format(parser.name))) parser.exit() diff --git a/qutebrowser/network/qutescheme.py b/qutebrowser/network/qutescheme.py index 9138449c9..a6046def9 100644 --- a/qutebrowser/network/qutescheme.py +++ b/qutebrowser/network/qutescheme.py @@ -54,19 +54,25 @@ class QuteSchemeHandler(schemehandler.SchemeHandler): A QNetworkReply. """ path = request.url().path() + host = request.url().host() # An url like "qute:foo" is split as "scheme:path", not "scheme:host". - logutils.misc.debug("url: {}, path: {}".format( - request.url().toDisplayString(), path)) + logutils.misc.debug("url: {}, path: {}, host {}".format( + request.url().toDisplayString(), path, host)) try: handler = getattr(QuteHandlers, path) except AttributeError: - errorstr = "No handler found for {}!".format( - request.url().toDisplayString()) - return schemehandler.ErrorNetworkReply( - request, errorstr, QNetworkReply.ContentNotFoundError, - self.parent()) + try: + handler = getattr(QuteHandlers, host) + except AttributeError: + errorstr = "No handler found for {}!".format( + request.url().toDisplayString()) + return schemehandler.ErrorNetworkReply( + request, errorstr, QNetworkReply.ContentNotFoundError, + self.parent()) + else: + data = handler(request) else: - data = handler() + data = handler(request) return schemehandler.SpecialNetworkReply( request, data, 'text/html', self.parent()) @@ -76,14 +82,14 @@ class QuteHandlers: """Handlers for qute:... pages.""" @classmethod - def pyeval(cls): + def pyeval(cls, _request): """Handler for qute:pyeval. Return HTML content as bytes.""" html = jinja.env.get_template('pre.html').render( title='pyeval', content=pyeval_output) return html.encode('UTF-8', errors='xmlcharrefreplace') @classmethod - def version(cls): + def version(cls, _request): """Handler for qute:version. Return HTML content as bytes.""" html = jinja.env.get_template('version.html').render( title='Version info', version=version.version(), @@ -91,7 +97,7 @@ class QuteHandlers: return html.encode('UTF-8', errors='xmlcharrefreplace') @classmethod - def plainlog(cls): + def plainlog(cls, _request): """Handler for qute:plainlog. Return HTML content as bytes.""" if logutils.ram_handler is None: text = "Log output was disabled." @@ -102,7 +108,7 @@ class QuteHandlers: return html.encode('UTF-8', errors='xmlcharrefreplace') @classmethod - def log(cls): + def log(cls, _request): """Handler for qute:log. Return HTML content as bytes.""" if logutils.ram_handler is None: html_log = None @@ -113,6 +119,12 @@ class QuteHandlers: return html.encode('UTF-8', errors='xmlcharrefreplace') @classmethod - def gpl(cls): + def gpl(cls, _request): """Handler for qute:gpl. Return HTML content as bytes.""" return utils.read_file('html/COPYING.html').encode('ASCII') + + @classmethod + def help(cls, request): + """Handler for qute:help. Return HTML content as bytes.""" + path = 'html/doc/{}'.format(request.url().path()) + return utils.read_file(path).encode('ASCII') diff --git a/scripts/generate_doc.py b/scripts/generate_doc.py index 3ee51bf2a..3000541bf 100755 --- a/scripts/generate_doc.py +++ b/scripts/generate_doc.py @@ -410,9 +410,9 @@ if __name__ == '__main__': regenerate_authors('README.asciidoc') asciidoc_files = [('doc/qutebrowser.1.asciidoc', None), ('doc/settings.asciidoc', - 'qutebrowser/doc/settings.html'), + 'qutebrowser/html/doc/settings.html'), ('doc/commands.asciidoc', - 'qutebrowser/doc/commands.html'), + 'qutebrowser/html/doc/commands.html'), ('README.asciidoc', None)] for src, dst in asciidoc_files: call_asciidoc(src, dst)