.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "fuzzel" "1" "2022-11-30"
.P
.SH NAME
fuzzel - display XDG applications in a searchable Wayland window
.P
.SH SYNOPSIS
\fBfuzzel\fR [\fIOPTIONS\fR].\&.\&.\&
.P
.SH DESCRIPTION
.P
\fBfuzzel\fR lists all available XDG applications in a searchable
Window.\& The search box supports Emacs-like key bindings.\&
.P
The window size, font and colors can be configured with command line
options:
.P
\fB--config\fR=\fIPATH\fR
.RS 4
Path to configuration file, see \fBfuzzel.\&ini\fR(5) for details.\&
.P
.RE
\fB-o\fR,\fB--output\fR=\fIOUTPUT\fR
.RS 4
Specifies the monitor to display the window on.\& In \fISway\fR, you can
list the available outputs with \fBswaymsg -t get_outputs\fR.\&
.P
The default is to let the compositor choose output.\&
.P
.RE
\fB-f\fR,\fB--font\fR=\fIFONT\fR[,\fIFALLBACK1\fR,\fIFALLBACK2\fR,.\&.\&.\&]
.RS 4
Comma separated list of primary font, and fallback fonts, in
FontConfig format.\& See \fBFONT FORMAT\fR.\& Default: \fImonospace\fR.\&
.P
.RE
\fB-D\fR,\fB--dpi-aware\fR=\fIno|yes|auto\fR
.RS 4
When set to \fByes\fR, fonts are sized using the monitor'\&s DPI, making
a font of a given point size have the same physical size,
regardless of monitor.\&
.P
In this mode, the monitor'\&s scaling factor is ignored; doubling
the scaling factor will \fBnot\fR double the font size.\&
.P
When set to \fBno\fR, the monitor'\&s DPI is ignored.\& The font is
instead sized using the monitor'\&s scaling factor; doubling the
scaling factor \fBdoes\fR double the font size.\&
.P
Finally, if set to \fBauto\fR, fonts will be sized using the monitor'\&s
DPI if \fIall\fR 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.\&
.P
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.\&
.P
Also note that if the font size has been specified in pixels
(\fB:pixelsize=\fR\fIN\fR, instead of \fB:size=\fR\fIN\fR), DPI scaling
(\fBdpi-aware=yes\fR) 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 (\fBdpi-aware=no\fR), the font'\&s pixel size will be
multiplied with the scaling factor.\&
.P
Default: \fIauto\fR
.P
.RE
\fB-p\fR,\fB--prompt\fR=\fIPROMPT\fR
.RS 4
Prompt to use.\& Default: \fI> \fR.\&
.P
.RE
\fB-i\fR
.RS 4
Ignored; for compatibility with other, similar utilities (where
\fB-i\fR means "case insensitive search").\&
.P
.RE
\fB--icon-theme\fR=\fINAME\fR
.RS 4
Icon theme to use.\& Note that this option is case sensitive; the
name must match the theme'\&s folder name.\&
.P
Example: \fIAdwaita\fR.\&
.P
Default: \fIhicolor\fR.\&
.P
.RE
\fB-I\fR,\fB--no-icons\fR
.RS 4
Do not render any icons.\&
.P
.RE
\fB-F\fR,\fB--fields\fR=\fIFIELDS\fR
.RS 4
Comma separated list of XDG Desktop entry fields to match against:
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBfilename\fR: the .\&desktop file'\&s filename
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBname\fR: the application'\&s name (title)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBgeneric\fR: the application'\&s generic name
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBexec\fR: the applications'\&s executable, as specified in the desktop file.\& Note: may include command line options as well.\&
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBkeywords\fR: the application'\&s keywords
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBcategories\fR: the application'\&s categories
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBcomment\fR: the application'\&s comment

.RE
.P
Default: \fIfilename,name,generic\fR
.P
.RE
\fB--password\fR=[\fICHARACTER\fR]
.RS 4
Password input.\& Render all typed text as \fICHARACTER\fR.\& If
\fICHARACTER\fR is omitted, a \fB*\fR will be used.\&
.P
.RE
\fB-T\fR,\fB--terminal\fR=\fITERMINAL ARGS\fR
.RS 4
Command to launch XDG applications with the property
\fBTerminal=true\fR (\fIhtop\fR, for example).\& Example: \fIxterm -e\fR.\&
Default: \fInot set\fR.\&
.P
.RE
\fB-l\fR,\fB--lines\fR=COUNT
.RS 4
The (maximum) number of matches to display.\& This dictates the
window height.\& Default: \fI15\fR.\&
.P
.RE
\fB-w\fR,\fB--width\fR
.RS 4
Window width, in characters.\& Margins and borders not
included.\& Default: \fI30\fR.\&
.P
.RE
\fB-x\fR,\fB--horizontal-pad\fR=\fIPAD\fR
.RS 4
Horizontal padding between border and icons and text.\& In pixels,
subject to output scaling.\& Default: \fI40\fR.\&
.P
.RE
\fB-y\fR,\fB--vertical-pad\fR=\fIPAD\fR
.RS 4
Vertical padding between border and text.\& In pixels, subject to
output scaling.\& Default: \fI8\fR.\&
.P
.RE
\fB-P\fR,\fB--inner-pad\fR=\fIPAD\fR
.RS 4
Vertical padding between prompt and match list.\& In pixels, subject to
output scaling.\& Default: \fI0\fR.\&
.P
.RE
\fB-b\fR,\fB--background\fR=\fIHEX\fR
.RS 4
Background color.\& See \fBCOLORS\fR.\& Default: \fIfdf6e3dd\fR.\&
.P
.RE
\fB-t\fR,\fB--text-color\fR=\fIHEX\fR
.RS 4
Text color.\& See \fBCOLORS\fR.\& Default: \fI657b83ff\fR.\&
.P
.RE
\fB-m\fR,\fB--match-color\fR=\fIHEX\fR
.RS 4
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 \fBCOLORS\fR.\& Default: \fIcb4b16ff\fR.\&
.P
.RE
\fB-s\fR,\fB--selection-color\fR=\fIHEX\fR
.RS 4
The color to use as background of the currently selected
application.\& See \fBCOLORS\fR.\& Default: \fIeee8d5dd\fR.\&
.P
.RE
\fB-S\fR,\fB--selection-text-color\fR=\fIHEX\fR
.RS 4
The text color of the currently selected application.\& See
\fBCOLORS\fR.\& Default: \fI657b83ff\fR.\&
.P
.RE
\fB-M\fR,\fB--selection-match-color\fR=\fIHEX\fR
.RS 4
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 \fBCOLORS\fR.\& Default: \fIcb4b16ff\fR.\&
.P
.RE
\fB-B\fR,\fB--border-width\fR=\fIINT\fR
.RS 4
The width of the surrounding border, in pixels (subject to output
scaling).\& Default: \fI1\fR.\&
.P
.RE
\fB-r\fR,\fB--border-radius\fR=\fIINT\fR
.RS 4
The corner curvature.\& Larger means more rounded corners.\&
0 disables rounded corners.\& Default: \fI10\fR.\&
.P
.RE
\fB-C\fR,\fB--border-color\fR=\fIHEX\fR
.RS 4
The color of the border.\& See \fBCOLORS\fR.\& Default: \fI002b36ff\fR.\&
.P
.RE
\fB--show-actions\fR
.RS 4
Include desktop actions in the list.\& Desktop actions are
alternative actions some desktop entries have.\& Examples include
"New Window", "New Document", etc.\&
.P
.RE
\fB--no-fuzzy\fR
.RS 4
Disables fuzzy matching.\& When disabled, only exact (case
insensitive) substring matches are considered.\&
.P
.RE
\fB--fuzzy-min-length\fR=\fIVALUE\fR
.RS 4
Search strings shorter than this will not by fuzzy
matched.\& Default: \fI3\fR.\&
.P
.RE
\fB--fuzzy-max-length-discrepancy\fR=\fIVALUE\fR
.RS 4
Maximum allowed length difference between the search string, and a
fuzzy match.\& Larger values result in more fuzzy matches.\& Default:
\fI2\fR.\&
.P
.RE
\fB--fuzzy-max-distance\fR=\fIVALUE\fR
.RS 4
Maximum allowed levenshtein distance between the search string,
and a fuzzy match.\& Larger values result in more fuzzy
matches.\& Default: \fI1\fR.\&
.P
.RE
\fB--line-height\fR=\fIHEIGHT\fR
.RS 4
Override line height from font metrics.\& In points by default, but
can be specified as pixels by appending '\&px'\&
(i.\&e.\& \fB--line-height=16px\fR).\& Default: \fInot set\fR.\&
.P
.RE
\fB--letter-spacing\fR=\fIAMOUNT\fR
.RS 4
Additional space between letters.\& In points by default, but can be
specified as pixels by appending '\&px'\&
(i.\&e.\& \fBletter-spacing=5px\fR).\& Negative values are
supported.\& Default: \fI0\fR.\&
.P
.RE
\fB--layer\fR=\fItop\fR|\fIoverlay\fR
.RS 4
Which layer to render the fuzzel window on.\& Valid values are \fBtop\fR
and \fBoverlay\fR.\&
.P
\fBtop\fR renders above normal windows, but typically below fullscreen
windows and lock screens.\&
.P
\fBoverlay\fR 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 \fBoverlay\fR,
that means fuzzel may or may not appear on top of a lock screen.\&
.P
Default: \fItop\fR
.P
.RE
\fB--launch-prefix\fR=\fICOMMAND\fR
.RS 4
Command to launch XDG applications with.\& Example: \fIswaymsg exec --\fR.\&
Default: \fInot set\fR.\&
.P
.RE
\fB-d\fR,\fB--dmenu\fR
.RS 4
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.\&
.P
Alternatively, you can symlink the fuzzel binary to
\fBdmenu\fR.\& Fuzzel will then start in dmenu mode, without the
\fB--dmenu\fR argument.\&
.P
Fuzzel also supports icons, using Rofi'\&s extended dmenu
protocol.\& To set an icon for an entry, append
\fB\\0icon\\x1f<icon-name>\fR.\& Example:
.P
.RS 4
echo -en "Firefox\\0icon\\x1ffirefox" | fuzzel --dmenu
.P
.RE
.RE
\fB--index\fR
.RS 4
Print selected entry'\&s index instead of its text.\& \fB\fRdmenu\fB\fR mode
only.\&
.P
.RE
\fB-R\fR,\fB--no-run-if-empty\fR
.RS 4
Exit immediately, without showing the UI, if stdin is
empty.\& \fB\fRdmenu\fB\fR mode only.\&
.P
.RE
\fB--log-level\fR={\fBinfo\fR,\fBwarning\fR,\fBerror\fR,\fBnone\fR}
.RS 4
Log level, used both for log output on stderr as well as
syslog.\& Default: \fIinfo\fR.\&
.P
.RE
\fB--log-colorize\fR=[{\fBnever\fR,\fBalways\fR,\fBauto\fR}]
.RS 4
Enables or disables colorization of log output on stderr.\&
.P
.RE
\fB--log-no-syslog\fR
.RS 4
Disables syslog logging.\& Logging is only done on stderr.\&
.P
.RE
\fB-v\fR,\fB--version\fR
.RS 4
Show the version number and quit
.P
.RE
.SH CONFIGURATION
.P
fuzzel will search for a configuration file in the following locations,
in this order:
.P
.RS 4
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBXDG_CONFIG_HOME/fuzzel/fuzzel.\&ini\fR (defaulting to
\fB~/.\&config/fuzzel/fuzzel.\&ini\fR if unset)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBXDG_CONFIG_DIRS/fuzzel/fuzzel.\&ini\fR (defaulting to
\fB/etc/xdg/fuzzel/fuzzel.\&ini\fR if unset)

.RE
.P
.RE
An example configuration file containing all options with their default value
commented out will usually be installed to \fB/etc/xdg/fuzzel/fuzzel.\&ini\fR.\&
.P
For more information, see \fBfuzzel.\&ini\fR(5).\&
.P
.SH FONT FORMAT
.P
The font is specified in FontConfig syntax.\& That is, a colon-separated
list of font name and font options.\&
.P
\fIExamples\fR:
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Dina:weight=bold:slant=italic
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Arial:size=12

.RE
.P
.P
.SH COLORS
.P
All colors must be specified as a RGBA quadruple, in hex format,
without a leading '\&0x'\&.\&
.P
\fIEXAMPLES\fR:
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
white: \fBffffffff\fR (no transparency)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
black: \fB000000ff\fR (no transparency)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
black: \fB00000010\fR (semi-transparent)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
red: \fBff0000ff\fR (no transparency)

.RE
.P
The default color scheme is \fISolarized\fR.\&
.P
.SH FILES
.P
\fI$XDG_CACHE_HOME/fuzzel\fR
.RS 4
Stores a list of applications and their launch count.\& This allows
fuzzel to sort frequently launched applications at the top.\&
.P
.RE
\fI$XDG_RUNTIME_DIR/fuzzel-$WAYLAND_DISPLAY.\&lock\fR
.RS 4
Lock file, used to prevent multiple fuzzel instances from running
at the same time.\&
.P
.RE
.SH SEE ALSO
.P
\fBfuzzel.\&ini\fR(5)