pvsr.dev
1qbpm(1)
2
3# NAME
4
5qbpm - qutebrowser profile manager
6
7# SYNOPSIS
8
9*qbpm* [--profile-dir=<path>|-P <path>] [--config-file|-c <path>] <command> [<args>]
10
11# DESCRIPTION
12
13qbpm is a tool for creating, managing, and running qutebrowser profiles. Profile support
14isn't built in to qutebrowser, at least not directly, but it does have a \--basedir flag
15which allows qutebrowser to use any directory as the location of its config and
16data and effectively act as a profile. qbpm creates profiles that source your
17main qutebrowser config.py, but have their own separate autoconfig.yml, bookmarks, cookies,
18history, and other data. Profiles can be run by starting qutebrowser with the
19appropriate \--basedir, or more conveniently using the qbpm launch and qbpm choose commands.
20
21# OPTIONS
22
23*-h, --help*
24 Show help message and quit.
25
26*--version*
27 Show version information and quit.
28
29*-P, --profile-dir* <path>
30 Use _path_ as the profile directory instead of the default location. Takes
31 precedence over the QBPM_PROFILE_DIR environment variable.
32
33*-c, --config-file* <path>
34 Read configuration for qbpm from _path_. Defaults to ~/.config/qbpm/config.toml.
35
36# COMMANDS
37
38*new* [options] <profile> [<url>]
39 Create a new qutebrowser profile named _profile_. If _url_ is present it will
40 be used as the profile's home page.
41
42 Options:
43
44 *-l, --launch*
45 Launch the profile after it is created.
46
47 *-f, --foreground*
48 If --launch is set, run qutebrowser in the foreground.
49
50 *-C, --qutebrowser-config-dir* <path>
51 Source config files from the provided directory instead of the global
52 qutebrowser config location.
53
54 *--desktop-file/--no-desktop-file*
55 Whether to generate an XDG desktop entry for the profile. Only relevant
56 on linux systems. See https://wiki.archlinux.org/title/Desktop_entries
57 for information on desktop entries.
58
59 *--overwrite*
60 By default qbpm will refuse to create a profile if one with the same name
61 already exists. --overwrite disables this check and replaces the existing
62 profile's configuration files. Profile data is left untouched.
63
64*launch* [options] <profile> [arguments...]
65 Start qutebrowser with --basedir set to the location of _profile_. All
66 arguments following _profile_ will be passed on to qutebrowser.
67
68 Options:
69
70 *-f, --foreground*
71 Run qutebrowser in the foreground instead of forking off a new process.
72
73 *-c, --create*
74 Create the profile if it does not exist.
75
76 Examples:
77
78 ```
79 \# launch my profile called work and open internal.mycompany.com
80 qbpm launch work internal.mycompany.com
81
82 \# launch a new profile called qb-dev, passing the debugging flags to qutebrowser
83 qbpm launch -n qb-dev --debug --json-logging
84 ```
85
86*choose* [options] [arguments...]
87 Open a menu to choose a qutebrowser profile to launch. On linux this defaults
88 to dmenu or another compatible menu program such as rofi, and on macOS this
89 will be an applescript dialog. All arguments are passed to qutebrowser.
90
91 *-m, --menu* <menu>
92 Use _menu_ instead of the default menu program. This may be the name of a
93 program on $PATH or a path to a program, in which case it will be run in
94 dmenu mode if qbpm knows about the program, or a full command line. On
95 MacOS the special value "applescript" is accepted. Run `qbpm choose --help`
96 for a list of known menu programs for your environment.
97
98 Examples:
99
100 ```
101 qbpm choose --menu fzf
102
103 qbpm choose --menu "./build/my-cool-menu --dmenu-mode --prompt qutebrowser"
104
105 \# qbpm knows about fuzzel so it can automatically invoke it as "~/.local/bin/fuzzel --dmenu"
106 qbpm choose --menu ~/.local/bin/fuzzel
107
108 \# if more than one word is provided it will be invoked as is, so `--dmenu` must be included
109 qbpm choose --menu 'fuzzel --dmenu --width 100'
110 ```
111
112*from-session* [options] <session> [<name>]
113 Create a new qutebrowser profile from _session_, which may either be the name
114 of a session in the default qutebrowser data directory, or a path to a session
115 file. By default the new profile will be named after _session_, but a custom
116 profile name can be set via the _name_ argument. Supports the same options as
117 *new*.
118
119*desktop* <profile>
120 Generate an XDG desktop entry for _profile_.
121
122*edit* <profile>
123 Open _profile_'s config.py in your default editor.
124
125*list*
126 List qutebrowser profiles.
127
128# AUTHOR
129
130Peter Rice
131
132# CONTRIBUTE
133
134_https://github.com/pvsr/qbpm_
135
136_https://codeberg.org/pvsr/qbpm_