qutebrowser - Man Page
a keyboard-driven, vim-like browser based on Python and Qt.
Examples (TL;DR)
- Open qutebrowser with a specified storage directory:
qutebrowser --basedir path/to/directory - Open a qutebrowser instance with temporary settings:
qutebrowser --set content.geolocation true|false - Restore a named session of a qutebrowser instance:
qutebrowser --restore session_name - Launch qutebrowser, opening all URLs using the specified method:
qutebrowser --target auto|tab|tab-bg|tab-silent|tab-bg-silent|window|private-window - Open qutebrowser with a temporary base directory and print logs to
stdoutas JSON:qutebrowser --temp-basedir --json-logging
Synopsis
qutebrowser [-OPTION [...]] [:COMMAND [...]] [URL [...]]
Description
qutebrowser is a keyboard-focused browser with a minimal GUI. It’s based on Python and Qt and is free software, licensed under the GPL.
It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
Note the commands and settings of qutebrowser are not described in this manpage, but in the help integrated in qutebrowser - use the ":help" command to show it.
Options
positional arguments
- :command
Commands to execute on startup.
- URL
URLs to open on startup (empty as a window separator).
options
- -h, --help
show this help message and exit
- -B BASEDIR, --basedir BASEDIR
Base directory for all storage.
- -C CONFIG, --config-py CONFIG
Path to config.py.
- -V, --version
Show version and quit.
- -s OPTION VALUE, --set OPTION VALUE
Set a temporary setting for this session.
- -r SESSION, --restore SESSION
Restore a named session.
- -R, --override-restore
Don’t restore a session even if one would be restored.
- --target {auto,tab,tab-bg,tab-silent,tab-bg-silent,window,private-window}
How URLs should be opened if there is already a qutebrowser instance running.
- --backend {webkit,webengine}
Which backend to use.
- --qt-wrapper {PyQt6,PyQt5}
Which Qt wrapper to use. This can also be set via the QUTE_QT_WRAPPER environment variable. If both are set, the command line argument takes precedence.
- --desktop-file-name DESKTOP_FILE_NAME
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-6/qguiapplication.html#desktopFileName-prop
- --untrusted-args
Mark all following arguments as untrusted, which enforces that they are URLs/search terms (and not flags or commands)
debug arguments
- -l {critical,error,warning,info,debug,vdebug}, --loglevel {critical,error,warning,info,debug,vdebug}
Override the configured console loglevel
- --logfilter LOGFILTER
Comma-separated list of things to be logged to the debug log on stdout.
- --loglines LOGLINES
How many lines of the debug log to keep in RAM (-1: unlimited).
- -d, --debug
Turn on debugging options.
- --json-logging
Output log lines in JSON format (one object per line).
- --nocolor
Turn off colored logging.
- --force-color
Force colored logging
- --nowindow
Don’t show the main window.
- -T, --temp-basedir
Use a temporary basedir.
- --no-err-windows
Don’t show any error windows (used for tests/smoke.py).
- --qt-arg NAME VALUE
Pass an argument with a value to Qt. For example, you can do --qt-arg geometry 650x555+200+300 to set the window geometry.
- --qt-flag QT_FLAG
Pass an argument to Qt as flag.
- -D DEBUG_FLAGS, --debug-flag DEBUG_FLAGS
Pass name of debugging feature to be turned on.
Files
- ~/.config/qutebrowser/config.py: Configuration file.
- ~/.config/qutebrowser/autoconfig.yml: Configuration done via the GUI.
- ~/.config/qutebrowser/quickmarks: Saved quickmarks.
- ~/.local/share/qutebrowser/: Various state information.
- ~/.cache/qutebrowser/: Temporary data.
Note qutebrowser conforms to the XDG basedir specification - if XDG_CONFIG_HOME, XDG_DATA_HOME or XDG_CACHE_HOME are set in the environment, the directories configured there are used instead of the above defaults.
Bugs
Bugs are tracked in the Github issue tracker at https://github.com/qutebrowser/qutebrowser/issues.
If you found a bug, use the built-in :report command to create a bug report with all information needed.
If you prefer, you can also write to the mailinglist at qutebrowser@lists.qutebrowser.org instead.
For security bugs, please contact security@qutebrowser.org (or if GPG encryption is desired, contact me@the-compiler.org with GPG ID 0x916EB0C8FD55A072).
Alternatively, report a vulnerability via GitHub’s private reporting feature.
Copyright
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Resources
- Website: https://www.qutebrowser.org/
- Mailinglist: qutebrowser@lists.qutebrowser.org / https://listi.jpberlin.de/mailman/listinfo/qutebrowser
- Announce-only mailinglist: qutebrowser-announce@lists.qutebrowser.org / https://listi.jpberlin.de/mailman/listinfo/qutebrowser-announce
- IRC: #qutebrowser on Libera Chat (webchat, via Matrix)
- Github: https://github.com/qutebrowser/qutebrowser
Author
qutebrowser was written by Florian Bruhin. All contributors can be found in the README file distributed with qutebrowser.