Skip to content

Latest commit

 

History

History
171 lines (124 loc) · 5.26 KB

qutebrowser.1.asciidoc

File metadata and controls

171 lines (124 loc) · 5.26 KB

qutebrowser(1) Manual Page

NAME

qutebrowser - a keyboard-driven, vim-like browser based on PyQt5 and QtWebKit.

SYNOPSIS

qutebrowser ['-OPTION' ['…​']] [':COMMAND' ['…​']] ['URL' ['…​']]

DESCRIPTION

qutebrowser is a keyboard-focused browser with with a minimal GUI. It’s based on Python, PyQt5 and QtWebKit and 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).

optional arguments

-h, --help

show this help message and exit

-c 'CONFDIR', --confdir 'CONFDIR'

Set config directory (empty for no config storage).

--datadir 'DATADIR'

Set data directory (empty for no data storage).

--cachedir 'CACHEDIR'

Set cache directory (empty for no cache storage).

--basedir 'BASEDIR'

Base directory for all storage. Other --*dir arguments are ignored if this is given.

-V, --version

Show version and quit.

-s 'SECTION' 'OPTION' 'VALUE', --set 'SECTION' '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.

debug arguments

-l 'LOGLEVEL', --loglevel 'LOGLEVEL'

Set 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).

--debug

Turn on debugging options.

--nocolor

Turn off colored logging.

--harfbuzz '{old,new,system,auto}'

HarfBuzz engine version to use. Default: auto.

--relaxed-config

Silently remove unknown config options.

--nowindow

Don’t show the main window.

--debug-exit

Turn on debugging of late exit.

--pdb-postmortem

Drop into pdb on exceptions.

--temp-basedir

Use a temporary basedir.

--no-err-windows

Don’t show any error windows (used for tests/smoke.py).

--qt-name 'NAME'

Set the window name.

--qt-style 'STYLE'

Set the Qt GUI style to use.

--qt-stylesheet 'STYLESHEET'

Override the Qt application stylesheet.

--qt-widgetcount

Print debug message at the end about number of widgets left undestroyed and maximum number of widgets existed at the same time.

--qt-reverse

Set the application’s layout direction to right-to-left.

--qt-qmljsdebugger 'port:PORT[,block]'

Activate the QML/JS debugger with a specified port. 'block' is optional and will make the application wait until a debugger connects to it.

FILES

  • '~/.config/qutebrowser/qutebrowser.conf': Main config file.

  • '~/.config/qutebrowser/quickmarks': Saved quickmarks.

  • '~/.config/qutebrowser/keys.conf': Defined key bindings.

  • '~/.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/The-Compiler/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 me directly at me@the-compiler.org, GPG ID 0xFD55A072.

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 http://www.gnu.org/licenses/.

AUTHOR

qutebrowser was written by Florian Bruhin. All contributors can be found in the README file distributed with qutebrowser.