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 Fuzzel uses the localized strings from the .desktop files by default.
16 To disable this, run fuzzel with LC_MESSAGES=C.
17 The window size, font and colors can be configured with fuzzel.ini(5)
19 or command line options:
20 --config=PATH
22 Path to configuration file, see fuzzel.ini(5) for details.
23 -o,--output=OUTPUT
25 Specifies the monitor to display the window on. Autocompletion is
26 available for zsh and fish, or you can list the available outputs
27 with wlr-randr or with Sway using swaymsg -t get_outputs.
28 Example: DP-1
30 Default: Let the compositor choose output.
32 -f,--font=FONT[,FALLBACK1,FALLBACK2,...]
34 Comma separated list of primary font, and fallback fonts, in Font‐
35 Config format. See FONT FORMAT. Default: monospace.
36 -D,--dpi-aware=no|yes|auto
38 When set to yes, fonts are sized using the monitor's DPI, making a
39 font of a given point size have the same physical size, regardless
40 of monitor.
41 In this mode, the monitor's scaling factor is ignored; doubling the
43 scaling factor will not double the font size.
44 When set to no, the monitor's DPI is ignored. The font is instead
46 sized using the monitor's scaling factor; doubling the scaling fac‐
47 tor does double the font size.
48 Finally, if set to auto, fonts will be sized using the monitor's
50 DPI if all monitors have a scaling factor of 1. If at least one
51 monitor as a scaling factor larger than 1 (regardless of whether
52 the fuzzel window is mapped on that monitor or not), fonts will be
53 scaled using the scaling factor.
54 Note that this option typically does not work with bitmap fonts,
56 which only contains a pre-defined set of sizes, and cannot be dy‐
57 namically scaled. Whichever size (of the available ones) that best
58 matches the DPI or scaling factor, will be used.
59 Also note that if the font size has been specified in pixels (:pix‐
61 elsize=N, instead of :size=N), DPI scaling (dpi-aware=yes) will
62 have no effect (the specified pixel size will be used as is). But,
63 if the monitor's scaling factor is used to size the font (dpi-
64 aware=no), the font's pixel size will be multiplied with the scal‐
65 ing factor.
66 Default: auto
68 -p,--prompt=PROMPT
70 Prompt to use. Default: > .
71 -i
73 Ignored; for compatibility with other, similar utilities (where -i
74 means "case insensitive search").
75 --icon-theme=NAME
77 Icon theme to use. Note that this option is case sensitive; the
78 name must match the theme's folder name.
79 Example: Adwaita.
81 Default: hicolor.
83 -I,--no-icons
85 Do not render any icons.
86 -F,--fields=FIELDS
88 Comma separated list of XDG Desktop entry fields to match against:
89 • filename: the .desktop file's filename
91 • name: the application's name (title)
92 • generic: the application's generic name
93 • exec: the applications's executable, as specified in the desk‐
94 top file. Note: may include command line options as well.
95 • keywords: the application's keywords
96 • categories: the application's categories
97 • comment: the application's comment
98 Default: filename,name,generic
101 --password=[CHARACTER]
103 Password input. Render all typed text as CHARACTER. If CHARACTER is
104 omitted, a * will be used.
105 -T,--terminal=TERMINAL ARGS
107 Command to launch XDG applications with the property Terminal=true
108 (htop, for example). Example: xterm -e. Default: not set.
109 -l,--lines=COUNT
111 The (maximum) number of matches to display. This dictates the win‐
112 dow height. Default: 15.
113 -w,--width
115 Window width, in characters. Margins and borders not included. De‐
116 fault: 30.
117 --tabs=COUNT
119 Number of spaces a tab is expanded to. Default: 8.
120 -x,--horizontal-pad=PAD
122 Horizontal padding between border and icons and text. In pixels,
123 subject to output scaling. Default: 40.
124 -y,--vertical-pad=PAD
126 Vertical padding between border and text. In pixels, subject to
127 output scaling. Default: 8.
128 -P,--inner-pad=PAD
130 Vertical padding between prompt and match list. In pixels, subject
131 to output scaling. Default: 0.
132 -b,--background=HEX
134 Background color. See COLORS. Default: fdf6e3dd.
135 -t,--text-color=HEX
137 Text color. See COLORS. Default: 657b83ff.
138 -m,--match-color=HEX
140 The color of matching substring(s). As you start typing in the
141 search box, the matching part in each application's name is high‐
142 lighted with this color. See COLORS. Default: cb4b16ff.
143 -s,--selection-color=HEX
145 The color to use as background of the currently selected applica‐
146 tion. See COLORS. Default: eee8d5dd.
147 -S,--selection-text-color=HEX
149 The text color of the currently selected application. See COLORS.
150 Default: 657b83ff.
151 -M,--selection-match-color=HEX
153 The color of matching substring(s) of the currently selected appli‐
154 cation. As you start typing in the search box, the matching part in
155 each application's name is highlighted with this color. See COLORS.
156 Default: cb4b16ff.
157 -B,--border-width=INT
159 The width of the surrounding border, in pixels (subject to output
160 scaling). Default: 1.
161 -r,--border-radius=INT
163 The corner curvature, subject to output scaling. Larger means more
164 rounded corners. 0 disables rounded corners. Default: 10.
165 -C,--border-color=HEX
167 The color of the border. See COLORS. Default: 002b36ff.
168 --show-actions
170 Include desktop actions in the list. Desktop actions are alterna‐
171 tive actions some desktop entries have. Examples include "New Win‐
172 dow", "New Document", etc.
173 --filter-desktop=[no]
175 Filter the visible desktop entries based on the value of XDG_CUR‐
176 RENT_DESKTOP. If the optional parameter is "no", explicitly dis‐
177 ables filtering.
178 --no-fuzzy
180 Disables fuzzy matching. When disabled, only exact (case insensi‐
181 tive) substring matches are considered.
182 --fuzzy-min-length=VALUE
184 Search strings shorter than this will not by fuzzy matched. De‐
185 fault: 3.
186 --fuzzy-max-length-discrepancy=VALUE
188 Maximum allowed length difference between the search string, and a
189 fuzzy match. Larger values result in more fuzzy matches. Default:
190 2.
191 --fuzzy-max-distance=VALUE
193 Maximum allowed levenshtein distance between the search string, and
194 a fuzzy match. Larger values result in more fuzzy matches. Default:
195 1.
196 --line-height=HEIGHT
198 Override line height from font metrics. In points by default, but
199 can be specified as pixels by appending 'px' (i.e. --line-
200 height=16px). Default: not set.
201 --letter-spacing=AMOUNT
203 Additional space between letters. In points by default, but can be
204 specified as pixels by appending 'px' (i.e. letter-spacing=5px).
205 Negative values are supported. Default: 0.
206 --layer=top|overlay
208 Which layer to render the fuzzel window on. Valid values are top
209 and overlay.
210 top renders above normal windows, but typically below fullscreen
212 windows and lock screens.
213 overlay renders on top of both normal windows and fullscreen win‐
215 dows. Note that the order is undefined if several windows use the
216 same layer. Since e.g. lock screens typically use overlay, that
217 means fuzzel may or may not appear on top of a lock screen.
218 Default: top
220 --no-exit-on-keyboard-focus-loss
222 Do not exit when losing keyboard focus. This can be useful on com‐
223 positors where enabling "focus-follows-mouse" causes fuzzel to exit
224 as soon as the mouse is moved over another window. Sway (at least
225 up to, and including 1.7) exhibits this behavior.
226 --launch-prefix=COMMAND
228 Command to launch XDG applications with. If set, fuzzel will pass
229 the Desktop File ID of the chosen application (see the Desktop En‐
230 try specification) in the FUZZEL_DESKTOP_FILE_ID environment vari‐
231 ables. Example: swaymsg exec --. Default: not set.
232 -d,--dmenu
234 dmenu compatibility mode. In this mode, the list entries are read
235 from stdin (newline separated). The selected entry is printed to
236 stdout. If the input string does not match any of the entries, the
237 input string is printed as is on stdout.
238 Alternatively, you can symlink the fuzzel binary to dmenu. Fuzzel
240 will then start in dmenu mode, without the --dmenu argument.
241 Fuzzel also supports icons, using Rofi's extended dmenu protocol.
243 To set an icon for an entry, append \0icon\x1f<icon-name>. Example:
244 echo -en "Firefox\0icon\x1ffirefox" | fuzzel --dmenu
246 --dmenu0
248 Like --dmenu, but input is NUL separated instead of newline sepa‐
249 rated. Note that in this mode, icons are not supported.
250 --index
252 Print selected entry's index instead of its text. dmenu mode only.
253 -R,--no-run-if-empty
255 Exit immediately, without showing the UI, if stdin is empty. dmenu
256 mode only.
257 --log-level={info,warning,error,none}
259 Log level, used both for log output on stderr as well as syslog.
260 Default: info.
261 --log-colorize=[{never,always,auto}]
263 Enables or disables colorization of log output on stderr.
264 --log-no-syslog
266 Disables syslog logging. Logging is only done on stderr.
267 -v,--version
269 Show the version number and quit
270
272 fuzzel will search for a configuration file in the following locations,
273 in this order:
274 • XDG_CONFIG_HOME/fuzzel/fuzzel.ini (defaulting to ~/.con‐
276 fig/fuzzel/fuzzel.ini if unset)
277 • XDG_CONFIG_DIRS/fuzzel/fuzzel.ini (defaulting to
278 /etc/xdg/fuzzel/fuzzel.ini if unset)
279 An example configuration file containing all options with their default
282 value commented out will usually be installed to
283 /etc/xdg/fuzzel/fuzzel.ini.
284 For more information, see fuzzel.ini(5).
286
288 The font is specified in FontConfig syntax. That is, a colon-separated
289 list of font name and font options.
290 Examples:
292 • Dina:weight=bold:slant=italic
293 • Arial:size=12
294
297 All colors must be specified as a RGBA quadruple, in hex format, with‐
298 out a leading '0x'.
299 EXAMPLES:
301 • white: ffffffff (no transparency)
302 • black: 000000ff (no transparency)
303 • black: 00000010 (semi-transparent)
304 • red: ff0000ff (no transparency)
305 The default color scheme is Solarized.
308
310 $XDG_CACHE_HOME/fuzzel
311 Stores a list of applications and their launch count. This allows
312 fuzzel to sort frequently launched applications at the top.
313 $XDG_RUNTIME_DIR/fuzzel-$WAYLAND_DISPLAY.lock
315 Lock file, used to prevent multiple fuzzel instances from running
316 at the same time.
317
319 fuzzel.ini(5), https://specifications.freedesktop.org/desktop-entry-
320 spec/desktop-entry-spec-latest.html
321 2023-07-19 fuzzel(1)