summaryrefslogtreecommitdiff
path: root/doc/qutebrowser.1.asciidoc
blob: 8db231add35354291d3b1e9ba57f31255ac70929 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
// Note some sections in this file (everything between QUTE_*_START and
// QUTE_*_END) are autogenerated by scripts/src2asciidoc.sh. DO NOT edit them
// by hand.

= qutebrowser(1)
:doctype: manpage
:man source: qutebrowser
:man manual: qutebrowser manpage
:toc:
:homepage: https://www.qutebrowser.org/

== NAME
qutebrowser - a keyboard-driven, vim-like browser based on PyQt5.

== SYNOPSIS
*qutebrowser* ['-OPTION' ['...']] [':COMMAND' ['...']] ['URL' ['...']]

== DESCRIPTION
qutebrowser is a keyboard-focused browser with a minimal GUI. It's based
on Python and Qt5 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
// QUTE_OPTIONS_START
=== 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

*-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.

*--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-5/qguiapplication.html#desktopFileName-prop

=== 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.
// QUTE_OPTIONS_END

== 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
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at
mailto:qutebrowser@lists.qutebrowser.org[] instead.

For security bugs, please contact me directly at me@the-compiler.org, GPG ID
https://www.the-compiler.org/pubkey.asc[0xFD55A072].

== 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: mailto:qutebrowser@lists.qutebrowser.org[] /
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser
* Announce-only mailinglist: mailto:qutebrowser-announce@lists.qutebrowser.org[] /
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce
* IRC: link:ircs://irc.libera.chat:6697/#qutebrowser[`#qutebrowser`] on
https://libera.chat/[Libera Chat] (https://web.libera.chat/#qutebrowser[webchat],
https://matrix.to/#qutebrowser:libera.chat[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.