1// Note some sections in this file (everything between QUTE_*_START and 2// QUTE_*_END) are autogenerated by scripts/src2asciidoc.sh. DO NOT edit them 3// by hand. 4 5= qutebrowser(1) 6:doctype: manpage 7:man source: qutebrowser 8:man manual: qutebrowser manpage 9:toc: 10:homepage: https://www.qutebrowser.org/ 11 12== NAME 13qutebrowser - a keyboard-driven, vim-like browser based on PyQt5. 14 15== SYNOPSIS 16*qutebrowser* ['-OPTION' ['...']] [':COMMAND' ['...']] ['URL' ['...']] 17 18== DESCRIPTION 19qutebrowser is a keyboard-focused browser with a minimal GUI. It's based 20on Python and Qt5 and is free software, licensed under the GPL. 21 22It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl. 23 24Note the commands and settings of qutebrowser are not described in this 25manpage, but in the help integrated in qutebrowser - use the ":help" command to 26show it. 27 28== OPTIONS 29// QUTE_OPTIONS_START 30=== positional arguments 31*':command'*:: 32 Commands to execute on startup. 33 34*'URL'*:: 35 URLs to open on startup (empty as a window separator). 36 37=== optional arguments 38*-h*, *--help*:: 39 show this help message and exit 40 41*-B* 'BASEDIR', *--basedir* 'BASEDIR':: 42 Base directory for all storage. 43 44*-C* 'CONFIG', *--config-py* 'CONFIG':: 45 Path to config.py. 46 47*-V*, *--version*:: 48 Show version and quit. 49 50*-s* 'OPTION' 'VALUE', *--set* 'OPTION' 'VALUE':: 51 Set a temporary setting for this session. 52 53*-r* 'SESSION', *--restore* 'SESSION':: 54 Restore a named session. 55 56*-R*, *--override-restore*:: 57 Don't restore a session even if one would be restored. 58 59*--target* '{auto,tab,tab-bg,tab-silent,tab-bg-silent,window,private-window}':: 60 How URLs should be opened if there is already a qutebrowser instance running. 61 62*--backend* '{webkit,webengine}':: 63 Which backend to use. 64 65*--desktop-file-name* 'DESKTOP_FILE_NAME':: 66 Set the base name of the desktop entry for this application. Used to set the app_id under Wayland. See https://doc.qt.io/qt-5/qguiapplication.html#desktopFileName-prop 67 68*--untrusted-args*:: 69 Mark all following arguments as untrusted, which enforces that they are URLs/search terms (and not flags or commands) 70 71=== debug arguments 72*-l* '{critical,error,warning,info,debug,vdebug}', *--loglevel* '{critical,error,warning,info,debug,vdebug}':: 73 Override the configured console loglevel 74 75*--logfilter* 'LOGFILTER':: 76 Comma-separated list of things to be logged to the debug log on stdout. 77 78*--loglines* 'LOGLINES':: 79 How many lines of the debug log to keep in RAM (-1: unlimited). 80 81*-d*, *--debug*:: 82 Turn on debugging options. 83 84*--json-logging*:: 85 Output log lines in JSON format (one object per line). 86 87*--nocolor*:: 88 Turn off colored logging. 89 90*--force-color*:: 91 Force colored logging 92 93*--nowindow*:: 94 Don't show the main window. 95 96*-T*, *--temp-basedir*:: 97 Use a temporary basedir. 98 99*--no-err-windows*:: 100 Don't show any error windows (used for tests/smoke.py). 101 102*--qt-arg* 'NAME' 'VALUE':: 103 Pass an argument with a value to Qt. For example, you can do `--qt-arg geometry 650x555+200+300` to set the window geometry. 104 105*--qt-flag* 'QT_FLAG':: 106 Pass an argument to Qt as flag. 107 108*-D* 'DEBUG_FLAGS', *--debug-flag* 'DEBUG_FLAGS':: 109 Pass name of debugging feature to be turned on. 110// QUTE_OPTIONS_END 111 112== FILES 113 114- '~/.config/qutebrowser/config.py': Configuration file. 115- '~/.config/qutebrowser/autoconfig.yml': Configuration done via the GUI. 116- '~/.config/qutebrowser/quickmarks': Saved quickmarks. 117- '~/.local/share/qutebrowser/': Various state information. 118- '~/.cache/qutebrowser/': Temporary data. 119 120Note qutebrowser conforms to the XDG basedir specification - if 121'XDG_CONFIG_HOME', 'XDG_DATA_HOME' or 'XDG_CACHE_HOME' are set in the 122environment, the directories configured there are used instead of the above 123defaults. 124 125== BUGS 126Bugs are tracked in the Github issue tracker at 127https://github.com/qutebrowser/qutebrowser/issues. 128 129If you found a bug, use the built-in ':report' command to create a bug report 130with all information needed. 131 132If you prefer, you can also write to the 133https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at 134mailto:qutebrowser@lists.qutebrowser.org[] instead. 135 136For security bugs, please contact me directly at me@the-compiler.org, GPG ID 137https://www.the-compiler.org/pubkey.asc[0xFD55A072]. 138 139== COPYRIGHT 140This program is free software: you can redistribute it and/or modify it under 141the terms of the GNU General Public License as published by the Free Software 142Foundation, either version 3 of the License, or (at your option) any later 143version. 144 145This program is distributed in the hope that it will be useful, but WITHOUT 146ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 147FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 148 149You should have received a copy of the GNU General Public License along with 150this program. If not, see <https://www.gnu.org/licenses/>. 151 152== RESOURCES 153* Website: https://www.qutebrowser.org/ 154* Mailinglist: mailto:qutebrowser@lists.qutebrowser.org[] / 155https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser 156* Announce-only mailinglist: mailto:qutebrowser-announce@lists.qutebrowser.org[] / 157https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce 158* IRC: link:ircs://irc.libera.chat:6697/#qutebrowser[`#qutebrowser`] on 159https://libera.chat/[Libera Chat] (https://web.libera.chat/#qutebrowser[webchat], 160https://matrix.to/#qutebrowser:libera.chat[via Matrix]) 161* Github: https://github.com/qutebrowser/qutebrowser 162 163== AUTHOR 164*qutebrowser* was written by Florian Bruhin. All contributors can be found in 165the README file distributed with qutebrowser. 166