fuzzel - Man Page

display XDG applications in a searchable Wayland window

Synopsis

fuzzel [OPTIONS]...

Description

fuzzel lists all available XDG applications in a searchable Window. The search box supports Emacs-like key bindings.

The window size, font and colors can be configured with command line options:

--config=PATH

Path to configuration file, see fuzzel.ini(5) for details.

-o,--output=OUTPUT

Specifies the monitor to display the window on. In Sway, you can list the available outputs with swaymsg -t get_outputs.

The default is to let the compositor choose output.

-f,--font=FONT[,FALLBACK1,FALLBACK2,...]

Comma separated list of primary font, and fallback fonts, in FontConfig format. See Font Format. Default: monospace.

-D,--dpi-aware=no|yes|auto

When set to yes, fonts are sized using the monitor's DPI, making a font of a given point size have the same physical size, regardless of monitor.

In this mode, the monitor's scaling factor is ignored; doubling the scaling factor will not double the font size.

When set to no, the monitor's DPI is ignored. The font is instead sized using the monitor's scaling factor; doubling the scaling factor does double the font size.

Finally, if set to auto, fonts will be sized using the monitor's DPI if all monitors have a scaling factor of 1. If at least one monitor as a scaling factor larger than 1 (regardless of whether the fuzzel window is mapped on that monitor or not), fonts will be scaled using the scaling factor.

Note that this option typically does not work with bitmap fonts, which only contains a pre-defined set of sizes, and cannot be dynamically scaled. Whichever size (of the available ones) that best matches the DPI or scaling factor, will be used.

Also note that if the font size has been specified in pixels (:pixelsize=N, instead of :size=N), DPI scaling (dpi-aware=yes) will have no effect (the specified pixel size will be used as is). But, if the monitor's scaling factor is used to size the font (dpi-aware=no), the font's pixel size will be multiplied with the scaling factor.

Default: auto

-p,--prompt=PROMPT

Prompt to use. Default: > .

-i

Ignored; for compatibility with other, similar utilities (where -i means "case insensitive search").

--icon-theme=NAME

Icon theme to use. Note that this option is case sensitive; the name must match the theme's folder name.

Example: Adwaita.

Default: hicolor.

-I,--no-icons

Do not render any icons.

-F,--fields=FIELDS

Comma separated list of XDG Desktop entry fields to match against:

  • filename: the .desktop file's filename
  • name: the application's name (title)
  • generic: the application's generic name
  • exec: the applications's executable, as specified in the desktop file. Note: may include command line options as well.
  • keywords: the application's keywords
  • categories: the application's categories
  • comment: the application's comment

Default: filename,name,generic

--password=[CHARACTER]

Password input. Render all typed text as CHARACTER. If CHARACTER is omitted, a * will be used.

-T,--terminal=TERMINAL ARGS

Command to launch XDG applications with the property Terminal=true (htop, for example). Example: xterm -e. Default: not set.

-l,--lines=COUNT

The (maximum) number of matches to display. This dictates the window height. Default: 15.

-w,--width

Window width, in characters. Margins and borders not included. Default: 30.

-x,--horizontal-pad=PAD

Horizontal padding between border and icons and text. In pixels, subject to output scaling. Default: 40.

-y,--vertical-pad=PAD

Vertical padding between border and text. In pixels, subject to output scaling. Default: 8.

-P,--inner-pad=PAD

Vertical padding between prompt and match list. In pixels, subject to output scaling. Default: 0.

-b,--background=HEX

Background color. See Colors. Default: fdf6e3dd.

-t,--text-color=HEX

Text color. See Colors. Default: 657b83ff.

-m,--match-color=HEX

The color of matching substring(s). As you start typing in the search box, the matching part in each application's name is highlighted with this color. See Colors. Default: cb4b16ff.

-s,--selection-color=HEX

The color to use as background of the currently selected application. See Colors. Default: eee8d5dd.

-S,--selection-text-color=HEX

The text color of the currently selected application. See Colors. Default: 657b83ff.

-M,--selection-match-color=HEX

The color of matching substring(s) of the currently selected application. As you start typing in the search box, the matching part in each application's name is highlighted with this color. See Colors. Default: cb4b16ff.

-B,--border-width=INT

The width of the surrounding border, in pixels (subject to output scaling). Default: 1.

-r,--border-radius=INT

The corner curvature. Larger means more rounded corners. 0 disables rounded corners. Default: 10.

-C,--border-color=HEX

The color of the border. See Colors. Default: 002b36ff.

--show-actions

Include desktop actions in the list. Desktop actions are alternative actions some desktop entries have. Examples include "New Window", "New Document", etc.

--no-fuzzy

Disables fuzzy matching. When disabled, only exact (case insensitive) substring matches are considered.

--fuzzy-min-length=VALUE

Search strings shorter than this will not by fuzzy matched. Default: 3.

--fuzzy-max-length-discrepancy=VALUE

Maximum allowed length difference between the search string, and a fuzzy match. Larger values result in more fuzzy matches. Default: 2.

--fuzzy-max-distance=VALUE

Maximum allowed levenshtein distance between the search string, and a fuzzy match. Larger values result in more fuzzy matches. Default: 1.

--line-height=HEIGHT

Override line height from font metrics. In points by default, but can be specified as pixels by appending 'px' (i.e. --line-height=16px). Default: not set.

--letter-spacing=AMOUNT

Additional space between letters. In points by default, but can be specified as pixels by appending 'px' (i.e. letter-spacing=5px). Negative values are supported. Default: 0.

--layer=top|overlay

Which layer to render the fuzzel window on. Valid values are top and overlay.

top renders above normal windows, but typically below fullscreen windows and lock screens.

overlay renders on top of both normal windows and fullscreen windows. Note that the order is undefined if several windows use the same layer. Since e.g. lock screens typically use overlay, that means fuzzel may or may not appear on top of a lock screen.

Default: top

--launch-prefix=COMMAND

Command to launch XDG applications with. Example: swaymsg exec --. Default: not set.

-d,--dmenu

dmenu compatibility mode. In this mode, the list entries are read from stdin (newline separated). The selected entry is printed to stdout. If the input string does not match any of the entries, the input string is printed as is on stdout.

Alternatively, you can symlink the fuzzel binary to dmenu. Fuzzel will then start in dmenu mode, without the --dmenu argument.

Fuzzel also supports icons, using Rofi's extended dmenu protocol. To set an icon for an entry, append \0icon\x1f<icon-name>. Example:

echo -en "Firefox\0icon\x1ffirefox" | fuzzel --dmenu

--index

Print selected entry's index instead of its text. dmenu mode only.

-R,--no-run-if-empty

Exit immediately, without showing the UI, if stdin is empty. dmenu mode only.

--log-level={info,warning,error,none}

Log level, used both for log output on stderr as well as syslog. Default: info.

--log-colorize=[{never,always,auto}]

Enables or disables colorization of log output on stderr.

--log-no-syslog

Disables syslog logging. Logging is only done on stderr.

-v,--version

Show the version number and quit

Configuration

fuzzel will search for a configuration file in the following locations, in this order:

  • XDG_CONFIG_HOME/fuzzel/fuzzel.ini (defaulting to ~/.config/fuzzel/fuzzel.ini if unset)
  • XDG_CONFIG_DIRS/fuzzel/fuzzel.ini (defaulting to /etc/xdg/fuzzel/fuzzel.ini if unset)

An example configuration file containing all options with their default value commented out will usually be installed to /etc/xdg/fuzzel/fuzzel.ini.

For more information, see fuzzel.ini(5).

Font Format

The font is specified in FontConfig syntax. That is, a colon-separated list of font name and font options.

Examples:
  • Dina:weight=bold:slant=italic
  • Arial:size=12

Colors

All colors must be specified as a RGBA quadruple, in hex format, without a leading '0x'.

EXAMPLES:
  • white: ffffffff (no transparency)
  • black: 000000ff (no transparency)
  • black: 00000010 (semi-transparent)
  • red: ff0000ff (no transparency)

The default color scheme is Solarized.

Files

$XDG_CACHE_HOME/fuzzel

Stores a list of applications and their launch count. This allows fuzzel to sort frequently launched applications at the top.

$XDG_RUNTIME_DIR/fuzzel-$WAYLAND_DISPLAY.lock

Lock file, used to prevent multiple fuzzel instances from running at the same time.

See Also

fuzzel.ini(5)

Referenced By

fuzzel.ini(5).

2022-11-04