1fuzzel(1) General Commands Manual fuzzel(1)
2
6 fuzzel - display XDG applications in a searchable Wayland window
7
9 fuzzel [OPTIONS]...
10
12 fuzzel lists all available XDG applications in a searchable Window. The
13 search box supports Emacs-like key bindings.
14 The window size, font and colors can be configured with command line
16 options:
17 --config=PATH
19 Path to configuration file, see fuzzel.ini(5) for details.
20 -o,--output=OUTPUT
22 Specifies the monitor to display the window on. In Sway, you can
23 list the available outputs with swaymsg -t get_outputs.
24 The default is to let the compositor choose output.
26 -f,--font=FONT[,FALLBACK1,FALLBACK2,...]
28 Comma separated list of primary font, and fallback fonts, in Font‐
29 Config format. See FONT FORMAT. Default: monospace.
30 -D,--dpi-aware=no|yes|auto
32 When set to yes, fonts are sized using the monitor's DPI, making a
33 font of a given point size have the same physical size, regardless
34 of monitor.
35 In this mode, the monitor's scaling factor is ignored; doubling the
37 scaling factor will not double the font size.
38 When set to no, the monitor's DPI is ignored. The font is instead
40 sized using the monitor's scaling factor; doubling the scaling fac‐
41 tor does double the font size.
42 Finally, if set to auto, fonts will be sized using the monitor's
44 DPI if all monitors have a scaling factor of 1. If at least one
45 monitor as a scaling factor larger than 1 (regardless of whether
46 the fuzzel window is mapped on that monitor or not), fonts will be
47 scaled using the scaling factor.
48 Note that this option typically does not work with bitmap fonts,
50 which only contains a pre-defined set of sizes, and cannot be dy‐
51 namically scaled. Whichever size (of the available ones) that best
52 matches the DPI or scaling factor, will be used.
53 Also note that if the font size has been specified in pixels (:pix‐
55 elsize=N, instead of :size=N), DPI scaling (dpi-aware=yes) will
56 have no effect (the specified pixel size will be used as is). But,
57 if the monitor's scaling factor is used to size the font (dpi-
58 aware=no), the font's pixel size will be multiplied with the scal‐
59 ing factor.
60 Default: auto
62 -p,--prompt=PROMPT
64 Prompt to use. Default: > .
65 -i
67 Ignored; for compatibility with other, similar utilities (where -i
68 means "case insensitive search").
69 --icon-theme=NAME
71 Icon theme to use. Note that this option is case sensitive; the
72 name must match the theme's folder name.
73 Example: Adwaita.
75 Default: hicolor.
77 -I,--no-icons
79 Do not render any icons.
80 -F,--fields=FIELDS
82 Comma separated list of XDG Desktop entry fields to match against:
83 • filename: the .desktop file's filename
85 • name: the application's name (title)
86 • generic: the application's generic name
87 • exec: the applications's executable, as specified in the desk‐
88 top file. Note: may include command line options as well.
89 • keywords: the application's keywords
90 • categories: the application's categories
91 • comment: the application's comment
92 Default: filename,name,generic
95 --password=[CHARACTER]
97 Password input. Render all typed text as CHARACTER. If CHARACTER is
98 omitted, a * will be used.
99 -T,--terminal=TERMINAL ARGS
101 Command to launch XDG applications with the property Terminal=true
102 (htop, for example). Example: xterm -e. Default: not set.
103 -l,--lines=COUNT
105 The (maximum) number of matches to display. This dictates the win‐
106 dow height. Default: 15.
107 -w,--width
109 Window width, in characters. Margins and borders not included. De‐
110 fault: 30.
111 -x,--horizontal-pad=PAD
113 Horizontal padding between border and icons and text. In pixels,
114 subject to output scaling. Default: 40.
115 -y,--vertical-pad=PAD
117 Vertical padding between border and text. In pixels, subject to
118 output scaling. Default: 8.
119 -P,--inner-pad=PAD
121 Vertical padding between prompt and match list. In pixels, subject
122 to output scaling. Default: 0.
123 -b,--background=HEX
125 Background color. See COLORS. Default: fdf6e3dd.
126 -t,--text-color=HEX
128 Text color. See COLORS. Default: 657b83ff.
129 -m,--match-color=HEX
131 The color of matching substring(s). As you start typing in the
132 search box, the matching part in each application's name is high‐
133 lighted with this color. See COLORS. Default: cb4b16ff.
134 -s,--selection-color=HEX
136 The color to use as background of the currently selected applica‐
137 tion. See COLORS. Default: eee8d5dd.
138 -S,--selection-text-color=HEX
140 The text color of the currently selected application. See COLORS.
141 Default: 657b83ff.
142 -M,--selection-match-color=HEX
144 The color of matching substring(s) of the currently selected appli‐
145 cation. As you start typing in the search box, the matching part in
146 each application's name is highlighted with this color. See COLORS.
147 Default: cb4b16ff.
148 -B,--border-width=INT
150 The width of the surrounding border, in pixels (subject to output
151 scaling). Default: 1.
152 -r,--border-radius=INT
154 The corner curvature. Larger means more rounded corners. 0 disables
155 rounded corners. Default: 10.
156 -C,--border-color=HEX
158 The color of the border. See COLORS. Default: 002b36ff.
159 --show-actions
161 Include desktop actions in the list. Desktop actions are alterna‐
162 tive actions some desktop entries have. Examples include "New Win‐
163 dow", "New Document", etc.
164 --no-fuzzy
166 Disables fuzzy matching. When disabled, only exact (case insensi‐
167 tive) substring matches are considered.
168 --fuzzy-min-length=VALUE
170 Search strings shorter than this will not by fuzzy matched. De‐
171 fault: 3.
172 --fuzzy-max-length-discrepancy=VALUE
174 Maximum allowed length difference between the search string, and a
175 fuzzy match. Larger values result in more fuzzy matches. Default:
176 2.
177 --fuzzy-max-distance=VALUE
179 Maximum allowed levenshtein distance between the search string, and
180 a fuzzy match. Larger values result in more fuzzy matches. Default:
181 1.
182 --line-height=HEIGHT
184 Override line height from font metrics. In points by default, but
185 can be specified as pixels by appending 'px' (i.e. --line-
186 height=16px). Default: not set.
187 --letter-spacing=AMOUNT
189 Additional space between letters. In points by default, but can be
190 specified as pixels by appending 'px' (i.e. letter-spacing=5px).
191 Negative values are supported. Default: 0.
192 --layer=top|overlay
194 Which layer to render the fuzzel window on. Valid values are top
195 and overlay.
196 top renders above normal windows, but typically below fullscreen
198 windows and lock screens.
199 overlay renders on top of both normal windows and fullscreen win‐
201 dows. Note that the order is undefined if several windows use the
202 same layer. Since e.g. lock screens typically use overlay, that
203 means fuzzel may or may not appear on top of a lock screen.
204 Default: top
206 --launch-prefix=COMMAND
208 Command to launch XDG applications with. Example: swaymsg exec --.
209 Default: not set.
210 -d,--dmenu
212 dmenu compatibility mode. In this mode, the list entries are read
213 from stdin (newline separated). The selected entry is printed to
214 stdout. If the input string does not match any of the entries, the
215 input string is printed as is on stdout.
216 Alternatively, you can symlink the fuzzel binary to dmenu. Fuzzel
218 will then start in dmenu mode, without the --dmenu argument.
219 Fuzzel also supports icons, using Rofi's extended dmenu protocol.
221 To set an icon for an entry, append \0icon\x1f<icon-name>. Example:
222 echo -en "Firefox\0icon\x1ffirefox" | fuzzel --dmenu
224 --index
226 Print selected entry's index instead of its text. dmenu mode only.
227 -R,--no-run-if-empty
229 Exit immediately, without showing the UI, if stdin is empty. dmenu
230 mode only.
231 --log-level={info,warning,error,none}
233 Log level, used both for log output on stderr as well as syslog.
234 Default: info.
235 --log-colorize=[{never,always,auto}]
237 Enables or disables colorization of log output on stderr.
238 --log-no-syslog
240 Disables syslog logging. Logging is only done on stderr.
241 -v,--version
243 Show the version number and quit
244
246 fuzzel will search for a configuration file in the following locations,
247 in this order:
248 • XDG_CONFIG_HOME/fuzzel/fuzzel.ini (defaulting to ~/.con‐
250 fig/fuzzel/fuzzel.ini if unset)
251 • XDG_CONFIG_DIRS/fuzzel/fuzzel.ini (defaulting to
252 /etc/xdg/fuzzel/fuzzel.ini if unset)
253 An example configuration file containing all options with their default
256 value commented out will usually be installed to
257 /etc/xdg/fuzzel/fuzzel.ini.
258 For more information, see fuzzel.ini(5).
260
262 The font is specified in FontConfig syntax. That is, a colon-separated
263 list of font name and font options.
264 Examples:
266 • Dina:weight=bold:slant=italic
267 • Arial:size=12
268
271 All colors must be specified as a RGBA quadruple, in hex format, with‐
272 out a leading '0x'.
273 EXAMPLES:
275 • white: ffffffff (no transparency)
276 • black: 000000ff (no transparency)
277 • black: 00000010 (semi-transparent)
278 • red: ff0000ff (no transparency)
279 The default color scheme is Solarized.
282
284 $XDG_CACHE_HOME/fuzzel
285 Stores a list of applications and their launch count. This allows
286 fuzzel to sort frequently launched applications at the top.
287 $XDG_RUNTIME_DIR/fuzzel-$WAYLAND_DISPLAY.lock
289 Lock file, used to prevent multiple fuzzel instances from running
290 at the same time.
291
293 fuzzel.ini(5)
294 2022-11-04 fuzzel(1)