.\" 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 "tofi" "5" "2022-11-29"
.P
.SH NAME
.P
tofi - configuration file
.P
.SH DESCRIPTION
.P
The config file format is basic .\&ini/.\&cfg style.\& Options are set one per line,
with the syntax:
.P
.RS 4
option = value
.P
.RE
Whitespace is ignored.\& Values starting or ending with whitespace can be given
by enclosing them in double quotes like so:
.P
.RS 4
option = " value "
.P
.RE
Lines beginning with # or ; are treated as comments.\& Section headers of the
form [header] are currently ignored.\& All options and values are
case-insensitive, except where not possible (e.\&g.\& paths).\& Later options
override earlier options, and command line options override config file
options.\&
.P
.SH SPECIAL OPTIONS
.P
\fBinclude\fR=\fIpath\fR
.RS 4
Include the contents of another config file.\& If \fIpath\fR is a relative
path, it is interpreted as relative to this config file'\&s path (or the
current directory if \fB--include\fR is passed on the command line).\&
Inclusion happens immediately, before the rest of the current file'\&s
contents are parsed.\&
.P
.RE
.SH BEHAVIOUR OPTIONS
.P
\fBhide-cursor\fR=\fItrue|false\fR
.RS 4
Hide the cursor.\&
.P
Default: false
.P
.RE
\fBhistory\fR=\fItrue|false\fR
.RS 4
Sort results by number of usages.\& By default, this is only effective in
the run and drun modes - see the \fBhistory-file\fR option for more
information.\&
.P
Default: true
.P
.RE
\fBhistory-file\fR=\fIpath\fR
.RS 4
Specify an alternate file to read and store history information from /
to.\& This shouldn'\&t normally be needed, and is intended to facilitate
the creation of custom modes.\& The default value depends on the current
mode.\&
.P
Defaults:
.RS 4
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
tofi:      None (no history file)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
tofi-run:  \fI$XDG_STATE_HOME/tofi-history\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
tofi-drun: \fI$XDG_STATE_HOME/tofi-drun-history\fR

.RE
.P
.P
.RE
.RE
\fBfuzzy-match\fR=\fItrue|false\fR
.RS 4
If true, searching is performed via a simple fuzzy matching algorithm.\&
If false, substring matching is used, weighted to favour matches closer
to the beginning of the string.\&
.P
Default: false
.P
.RE
\fBrequire-match\fR=\fItrue|false\fR
.RS 4
If true, require a match to allow a selection to be made.\& If false,
making a selection with no matches will print input to stdout.\&
In drun mode, this is always true.\&
.P
Default: true
.P
.RE
\fBhide-input\fR=\fItrue|false\fR
.RS 4
If true, typed input will be hidden, and what is displayed (if
anything) is determined by the \fBhidden-character\fR option.\&
.P
Default: false
.P
.RE
\fBhidden-character\fR=\fIchar\fR
.RS 4
Replace displayed input characters with \fIchar\fR.\& If \fIchar\fR is set to the
empty string, input will be completely hidden.\&
This option only has an effect when \fBhide-input\fR is set to true.\&
.P
Default: *
.P
.RE
\fBdrun-launch\fR=\fItrue|false\fR
.RS 4
If true, directly launch applications on selection when in drun mode.\&
Otherwise, just print the path of the .\&desktop file to stdout.\&
.P
Default: false
.P
.RE
\fBterminal\fR=\fIcommand\fR
.RS 4
The terminal to run terminal programs in when in drun mode.\& \fIcommand\fR
will be prepended to the the application'\&s command line.\&
This option has no effect if \fBdrun-launch\fR is set to true.\&
.P
Default: the value of the TERMINAL environment variable
.P
.RE
\fBdrun-print-exec\fR=\fItrue|false\fR
.RS 4
\fBWARNING\fR: This option does nothing, and may be removed in a future version
of tofi.\&
.P
Default: true
.P
.RE
\fBlate-keyboard-init\fR=\fItrue|false\fR
.RS 4
Delay keyboard initialisation until after the first draw to screen.\&
This option is experimental, and will cause tofi to miss keypresses
for a short time after launch.\& The only reason to use this option is
performance on slow systems.\&
.P
Default: false
.P
.RE
\fBmulti-instance\fR=\fItrue|false\fR
.RS 4
If true, allow multiple simultaneous processes.\&
If false, create a lock file on startup to prevent multiple instances
from running simultaneously.\&
.P
Default: false
.P
.RE
\fBascii-input\fR=\fItrue|false\fR
.RS 4
Assume input is plain ASCII, and disable some Unicode handling
functions.\& This is faster, but means e.\&g.\& a search for "e" will not
match "é".\&
.P
Default: false
.P
.RE
.SH STYLE OPTIONS
.P
\fBfont\fR=\fIfont\fR
.RS 4
Font to use.\& If \fIfont\fR is a path to a font file, \fBtofi\fR will not have
to use Pango or Fontconfig.\& This greatly speeds up startup, but any
characters not in the chosen font will fail to render.\&
.P
If a path is not given, \fIfont\fR is interpreted as a font name in Pango
format.\&
.P
Default: "Sans"
.P
.RE
\fBfont-size\fR=\fIpt\fR
.RS 4
Point size of text.\&
.P
Default: 24
.P
.RE
\fBfont-features\fR=\fIfeatures\fR
.RS 4
Comma separated list of OpenType font feature settings to apply.\& The
format is similar to the CSS "font-feature-settings" property.\&
For example, "smcp, c2sc" will turn all text into small caps (if
supported by the chosen font).\&
.P
Default: ""
.P
.RE
\fBfont-variations\fR=\fIvariations\fR
.RS 4
Comma separated list of OpenType font variation settings to apply.\& The
format is similar to the CSS "font-variation-settings" property.\& For
example, "wght 900" will set the weight of a variable font to 900 (if
supported by the chosen font).\&
.P
Default: ""
.P
.RE
\fBbackground-color\fR=\fIcolor\fR
.RS 4
Color of the background.\& See \fBCOLORS\fR for more information.\&
.P
Default: #1B1D1E
.P
.RE
\fBoutline-width\fR=\fIpx\fR
.RS 4
Width of the border outlines.\&
.P
Default: 4
.P
.RE
\fBoutline-color\fR=\fIcolor\fR
.RS 4
Color of the border outlines.\& See \fBCOLORS\fR for more information.\&
.P
Default: #080800
.P
.RE
\fBborder-width\fR=\fIpx\fR
.RS 4
Width of the border.\&
.P
Default: 12
.P
.RE
\fBborder-color\fR=\fIcolor\fR
.RS 4
Color of the border.\& See \fBCOLORS\fR for more information.\&
.P
Default: #F92672
.P
.RE
\fBtext-color\fR=\fIcolor\fR
.RS 4
Color of text.\& See \fBCOLORS\fR for more information.\&
.P
Default: #FFFFFF
.P
.RE
\fBprompt-text\fR=\fIstring\fR
.RS 4
Prompt text.\&
.P
Default: "run: "
.P
.RE
\fBprompt-padding\fR=\fIpx\fR
.RS 4
Extra horizontal padding between prompt and input.\&
.P
Default: 0
.P
.RE
\fBprompt-color\fR=\fIcolor\fR
.RS 4
Color of prompt text.\& See \fBCOLORS\fR for more information.\&
.P
Default: Same as \fBtext-color\fR
.P
.RE
\fBprompt-background\fR=\fIcolor\fR
.RS 4
Background color of prompt.\& See \fBCOLORS\fR for more information.\&
.P
Default: #00000000
.P
.RE
\fBprompt-background-padding\fR=\fIdirectional\fR
.RS 4
Extra padding of the prompt background.\& See \fBDIRECTIONAL VALUES\fR for more
information.\&
.P
Default: 0
.P
.RE
\fBprompt-background-corner-radius\fR=\fIpx\fR
.RS 4
Corner radius of the prompt background.\&
.P
Default: 0
.P
.RE
\fBplaceholder-text\fR=\fIstring\fR
.RS 4
Placeholder input text.\&
.P
Default: ""
.P
.RE
\fBplaceholder-color\fR=\fIcolor\fR
.RS 4
Color of placeholder input text.\& See \fBCOLORS\fR for more information.\&
.P
Default: #FFFFFFA8
.P
.RE
\fBplaceholder-background\fR=\fIcolor\fR
.RS 4
Background color of placeholder input text.\& See \fBCOLORS\fR for more
information.\&
.P
Default: #00000000
.P
.RE
\fBplaceholder-background-padding\fR=\fIdirectional\fR
.RS 4
Extra padding of the placeholder input text background.\& See \fBDIRECTIONAL
VALUES\fR for more information.\&
.P
Default: 0
.P
.RE
\fBplaceholder-background-corner-radius\fR=\fIpx\fR
.RS 4
Corner radius of the placeholder input text background.\&
.P
Default: 0
.P
.RE
\fBinput-color\fR=\fIcolor\fR
.RS 4
Color of input text.\& See \fBCOLORS\fR for more information.\&
.P
Default: Same as \fBtext-color\fR
.P
.RE
\fBinput-background\fR=\fIcolor\fR
.RS 4
Background color of input.\& See \fBCOLORS\fR for more information.\&
.P
Default: #00000000
.P
.RE
\fBinput-background-padding\fR=\fIdirectional\fR
.RS 4
Extra padding of the input background.\& See \fBDIRECTIONAL VALUES\fR for more
information.\&
.P
Default: 0
.P
.RE
\fBinput-background-corner-radius\fR=\fIpx\fR
.RS 4
Corner radius of the input background.\&
.P
Default: 0
.P
.RE
\fBdefault-result-color\fR=\fIcolor\fR
.RS 4
Default color of result text.\& See \fBCOLORS\fR for more information.\&
.P
Default: Same as \fBtext-color\fR
.P
.RE
\fBdefault-result-background\fR=\fIcolor\fR
.RS 4
Default background color of results.\& See \fBCOLORS\fR for more information.\&
.P
Default: #00000000
.P
.RE
\fBdefault-result-background-padding\fR=\fIdirectional\fR
.RS 4
Default extra padding of result backgrounds.\& See \fBDIRECTIONAL VALUES\fR for
more information.\&
.P
Default: 0
.P
.RE
\fBdefault-result-background-corner-radius\fR=\fIpx\fR
.RS 4
Default corner radius of result backgrounds.\&
.P
Default: 0
.P
.RE
\fBalternate-result-color\fR=\fIcolor\fR
.RS 4
Color of alternate (even-numbered) result text.\& See \fBCOLORS\fR for more
information.\&
.P
Default: same as \fBdefault-result-color\fR
.P
.RE
\fBalternate-result-background\fR=\fIcolor\fR
.RS 4
Background color of alternate (even-numbered) results.\& See \fBCOLORS\fR for more
information.\&
.P
Default: same as \fBdefault-result-background\fR
.P
.RE
\fBalternate-result-background-padding\fR=\fIdirectional\fR
.RS 4
Extra padding of alternate (even-numbered) result backgrounds.\& See
\fBDIRECTIONAL VALUES\fR for more information.\&
.P
Default: same as \fBdefault-result-background-padding\fR
.P
.RE
\fBalternate-result-background-corner-radius\fR=\fIpx\fR
.RS 4
Corner radius of alternate (even-numbered) result backgrounds.\&
.P
Default: same as \fBdefault-result-background-corner-radius\fR
.P
.RE
\fBnum-results\fR=\fIn\fR
.RS 4
Maximum number of results to display.\& If \fIn\fR = 0, tofi will draw as
many results as it can fit in the window.\&
.P
Default: 0
.P
.RE
\fBselection-color\fR=\fIcolor\fR
.RS 4
Color of selected result.\& See \fBCOLORS\fR for more information.\&
.P
Default: #F92672
.P
.RE
\fBselection-match-color\fR=\fIcolor\fR
.RS 4
Color of the matching portion of the selected result.\& This will not
always be shown if the \fBfuzzy-match\fR option is set to true.\& Any color
that is fully transparent (alpha = 0) will disable this highlighting.\&
See \fBCOLORS\fR for more information.\&
.P
Default: #00000000
.P
.RE
\fBselection-padding\fR=\fIpx\fR
.RS 4
\fBWARNING\fR: This option is deprecated, and will be removed in a future version
of tofi.\& You should use the \fBselection-background-padding\fR option instead.\&
.P
Extra horizontal padding of the selection background.\& If \fIpx\fR = -1,
the padding will fill the whole window width.\&
.P
Default: 0
.P
.RE
\fBselection-background\fR=\fIcolor\fR
.RS 4
Background color of selected result.\& See \fBCOLORS\fR for more information.\&
.P
Default: #00000000
.P
.RE
\fBselection-background-padding\fR=\fIdirectional\fR
.RS 4
Extra padding of the selected result background.\& See \fBDIRECTIONAL VALUES\fR for
more information.\&
.P
Default: 0
.P
.RE
\fBselection-background-corner-radius\fR=\fIpx\fR
.RS 4
Corner radius of the selected result background.\&
Default: 0
.P
.RE
\fBresult-spacing\fR=\fIpx\fR
.RS 4
Spacing between results.\& Can be negative.\&
.P
Default: 0
.P
.RE
\fBmin-input-width\fR=\fIpx\fR
.RS 4
Minimum width of input in horizontal mode.\&
.P
Default: 0
.P
.RE
\fBwidth\fR=\fIpx|%\fR
.RS 4
Width of the window.\& See \fBPERCENTAGE VALUES\fR for more information.\&
.P
Default: 1280
.P
.RE
\fBheight\fR=\fIpx|%\fR
.RS 4
Height of the window.\& See \fBPERCENTAGE VALUES\fR for more information.\&
.P
Default: 720
.P
.RE
\fBcorner-radius\fR=\fIpx\fR
.RS 4
Radius of the window corners.\&
.P
Default: 0
.P
.RE
\fBanchor\fR=\fIposition\fR
.RS 4
Location on screen to anchor the window.\& Supported values are
\fItop-left\fR, \fItop\fR, \fItop-right\fR, \fIright\fR, \fIbottom-right\fR, \fIbottom\fR,
\fIbottom-left\fR, \fIleft\fR, and \fIcenter\fR.\&
.P
Default: center
.P
.RE
\fBexclusive-zone\fR=\fI-1|px|%\fR
.RS 4
Set the size of the exclusive zone.\& A value of -1 means ignore exclusive
zones completely.\& A value of 0 will move tofi out of the way of other
windows'\& exclusive zones.\& A value greater than 0 will set that much space as
an exclusive zone.\& Values greater than 0 are only meaningful when tofi is
anchored to a single edge.\&
.P
Default: -1
.P
.RE
\fBoutput\fR=\fIname\fR
.RS 4
The name of the output to appear on, if multiple outputs are present.\&
If empty, the compositor will choose which output to display the window
on (usually the currently focused output).\&
.P
Default: ""
.P
.RE
\fBscale\fR=\fItrue|false\fR
.RS 4
Scale the window by the output'\&s scale factor.\&
.P
Default: true
.P
.RE
\fBmargin-top\fR=\fIpx|%\fR
.RS 4
Offset from top of screen.\& See \fBPERCENTAGE VALUES\fR for more
information.\& Only has an effect when anchored to the top of the screen.\&
.P
Default: 0
.P
.RE
\fBmargin-bottom\fR=\fIpx|%\fR
.RS 4
Offset from bottom of screen.\& See \fBPERCENTAGE VALUES\fR for more
information.\& Only has an effect when anchored to the bottom of the
screen.\&
.P
Default: 0
.P
.RE
\fBmargin-left\fR=\fIpx|%\fR
.RS 4
Offset from left of screen.\& See \fBPERCENTAGE VALUES\fR for more
information.\& Only has an effect when anchored to the left of the
screen.\&
.P
Default: 0
.P
.RE
\fBmargin-right\fR=\fIpx|%\fR
.RS 4
Offset from right of screen.\& See \fBPERCENTAGE VALUES\fR for more
information.\& Only has an effect when anchored to the right of the
screen.\&
.P
Default: 0
.P
.RE
\fBpadding-top\fR=\fIpx|%\fR
.RS 4
Padding between top border and text.\& See \fBPERCENTAGE VALUES\fR for more
information.\&
.P
Default: 8
.P
.RE
\fBpadding-bottom\fR=\fIpx|%\fR
.RS 4
Padding between bottom border and text.\& See \fBPERCENTAGE VALUES\fR for
more information.\&
.P
Default: 8
.P
.RE
\fBpadding-left\fR=\fIpx|%\fR
.RS 4
Padding between left border and text.\& See \fBPERCENTAGE VALUES\fR for more
information.\&
.P
Default: 8
.P
.RE
\fBpadding-right\fR=\fIpx|%\fR
.RS 4
Padding between right border and text.\& See \fBPERCENTAGE VALUES\fR for more
information.\&
.P
Default: 8
.P
.RE
\fBclip-to-padding\fR=\fItrue|false\fR
.RS 4
Whether to clip text drawing to be within the specified padding.\& This
is mostly important for allowing text to be inset from the border,
while still allowing text backgrounds to reach right to the edge.\&
.P
Default: true
.P
.RE
\fBhorizontal\fR=\fItrue|false\fR
.RS 4
List results horizontally.\&
.P
Default: false
.P
.RE
\fBhint-font\fR=\fItrue|false\fR
.RS 4
Perform font hinting.\& Only applies when a path to a font has been
specified via \fBfont\fR.\& Disabling font hinting speeds up text
rendering appreciably, but will likely look poor at small font pixel
sizes.\&
.P
Default: true
.P
.RE
.SH COLORS
.P
Colors can be specified in the form \fIRGB\fR, \fIRGBA\fR, \fIRRGGBB\fR or \fIRRGGBBAA\fR,
optionally prefixed with a hash (#).\&
.P
.SH PERCENTAGE VALUES
.P
Some pixel values can optionally have a % suffix, like so:
.P
.RS 4
width = 50%
.P
.RE
This will be interpreted as a percentage of the screen resolution in the
relevant direction.\&
.P
.SH DIRECTIONAL VALUES
.P
The background box padding of a type of text can be specified by one to four
comma separated values, with meanings similar to the CSS padding property:
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
One value sets all edges.\&
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Two values set (top & bottom), (left & right) edges.\&
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Three values set (top), (left & right), (bottom) edges.\&
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Four values set (top), (right), (bottom), (left) edges.\&

.RE
.P
Specifying -1 for any of the values will pad as far as possible in that
direction.\&
.P
.SH AUTHORS
.P
Philip Jones <philj56@gmail.\&com>
.P
.SH SEE ALSO
.P
\fBtofi\fR(5), \fBdmenu\fR(1) \fBrofi\fR(1)