spmenu/spmenu.1

'\" t
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "spmenu" "1" "" "3.5.0" "fancy dynamic menu"
.hy
.SH spmenu
.PP
spmenu is an X11 and Wayland menu application which takes standard
input, parses it, lets the user choose an option and sends the selected
option to standard output.
.PP
Its core functionality is built around taking and parsing input and
returning output, making it a customizable and versatile utility for use
with shell or Python scripts.
.PP
In addition to this, it also serves as a run launcher/dmenu_run
replacement through the included shell script \f[V]spmenu_run\f[R],
which handles both $PATH listing, .desktop entries and file listing.
See spmenu_run(1) for more information regarding using spmenu as a run
launcher.
.SS Usage
.PP
On runtime, spmenu reads from standard input (stdin).
spmenu items are separated by a newline (\f[V]\[rs]n\f[R]).
When (by default) Enter is pressed, the selected item will be piped to
stdout.
.PP
This allows things like
\f[V]printf \[dq]Apple\[rs]nOrange\[rs]nPear\[rs]n\[dq] | spmenu\f[R].
This command will spawn an spmenu window with three items, `Apple',
`Orange' and `Pear'.
The user can select an item using the keyboard or mouse and the output
can then be parsed.
This can be used in shell scripts to create interactive menus.
.PP
Note that spmenu doesn\[cq]t strictly read standard input, it can read
from files too using the \f[V]-lf\f[R] or \f[V]--list-file\f[R]
argument.
.PP
On top of this, you can specify arguments to change the behavior of
spmenu.
See a list below for a list.
.SS Arguments
.PP
You may use long, descriptive arguments or the shorter arguments.
Note that none need to be specified for a basic spmenu prompt.
The most commonly used arguments are \f[V]-l\f[R] or \f[V]--lines\f[R]
and \f[V]-g\f[R] or \f[V]--columns\f[R].
All of the arguments can be defined permanently in the configuration
file.
Arguments take priority over settings defined in the config files.
.TP
\f[V]-mh, --line-height height\f[R]
Set spmenu line height to height
.TP
\f[V]-cw, --center-width width\f[R]
Set width to width when centered
.TP
\f[V]-l, --lines lines\f[R]
Set the number of lines to lines
.TP
\f[V]-g, --columns grid\f[R]
Set the number of grids to grid
.TP
\f[V]-ml, --min-lines\f[R]
Set minimum number of lines allowed to lines
.TP
\f[V]-gc, --generate-cache\f[R]
Generate image cache
.TP
\f[V]-ngc, --no-generate-cache\f[R]
Don\[cq]t generate image cache
.TP
\f[V]-mc, --max-cache size\f[R]
Set max image cache size to size
.TP
\f[V]-cd, --cache-dir dir\f[R]
Set cache directory to dir
.TP
\f[V]-ix, --print-index\f[R]
Print index instead of actual text
.TP
\f[V]-nix, --no-print-index\f[R]
Don\[cq]t print index instead of actual text
.TP
\f[V]-f, --fast\f[R]
Grabs keyboard before reading stdin
.TP
\f[V]-r, --incremental\f[R]
Print text every time a key is pressed
.TP
\f[V]-nr, --no-incremental\f[R]
Don\[cq]t print text every time a key is pressed
.TP
\f[V]-rm, --require-match\f[R]
Require that input text matches an item
.TP
\f[V]-nrm, --no-require-match\f[R]
Don\[cq]t require that input text matches an item
.TP
\f[V]-ma, --mark-items\f[R]
Allow marking/selecting multiple items
.TP
\f[V]-nma, --no-mark-items\f[R]
Don\[cq]t allow marking/selecting multiple items
.TP
\f[V]-F, --fuzzy\f[R]
Enable fuzzy matching
.TP
\f[V]-NF, --no-fuzzy\f[R]
Disable fuzzy matching
.TP
\f[V]-R, --regex\f[R]
Enable regex matching
.TP
\f[V]-NR, --no-regex\f[R]
Disable regex matching
.TP
\f[V]-P, --password\f[R]
Hide characters
.TP
\f[V]-nP, --no-password\f[R]
Don\[cq]t hide characters
.TP
\f[V]-p, --prompt text\f[R]
Set spmenu prompt text to text
.TP
\f[V]-pt, --pretext text\f[R]
Set spmenu pretext to text
.TP
\f[V]-It, --input text\f[R]
Set initial input text to text
.TP
\f[V]-ip, --indent\f[R]
Indent items to prompt width
.TP
\f[V]-nip, --no-indent\f[R]
Don\[cq]t indent items to prompt width
.TP
\f[V]-ci, --color-items\f[R]
Color items
.TP
\f[V]-nci, --no-color-items\f[R]
Don\[cq]t color items
.TP
\f[V]-sgr, --sgr\f[R]
Interpret SGR sequences
.TP
\f[V]-nsgr, --no-sgr\f[R]
Display SGR sequences as text
.TP
\f[V]-a, --alpha\f[R]
Enable alpha
.TP
\f[V]-na, --no-alpha\f[R]
Disable alpha
.TP
\f[V]-tp, --allow-typing\f[R]
Allow the user to type
.TP
\f[V]-nt, --no-allow-typing\f[R]
Don\[cq]t allow typing, the user must select an option
.TP
\f[V]-ol, --override-lines\f[R]
Allow keybinds to override lines
.TP
\f[V]-oc, --override-columns\f[R]
Allow keybinds to override columns
.TP
\f[V]-nol, --no-override-lines\f[R]
Don\[cq]t allow keybinds to override lines
.TP
\f[V]-noc, --no-override-columns\f[R]
Don\[cq]t allow keybinds to override columns
.TP
\f[V]-x, --x-position x offset\f[R]
Offset spmenu x position by x offset (X11 only)
.TP
\f[V]-y, --y-position y offset\f[R]
Offset spmenu y position by y offset (X11 only)
.TP
\f[V]-n, --preselect line\f[R]
Preselect line line in the list of items
.TP
\f[V]-z, --width width\f[R]
Width of the spmenu window
.TP
\f[V]-nmt, --normal-mode-text text\f[R]
Set normal mode text to text
.TP
\f[V]-imt, --insert-mode-text text\f[R]
Set insert mode text to text
.TP
\f[V]-clon, --caps-lock-on-text text\f[R]
Set caps lock on text to text
.TP
\f[V]-clof, --caps-lock-off-text text\f[R]
Set caps lock off text to text
.TP
\f[V]-bw, --border-width width\f[R]
Set width of the border to width.
0 will disable the border (X11 only)
.TP
\f[V]-so, --sort\f[R]
Sort matches
.TP
\f[V]-nso, --no-sort\f[R]
Don\[cq]t sort matches
.TP
\f[V]-pri, --priority pri1,pri2,pri3\f[R]
Specify a list of items that take priority
.TP
\f[V]-s, --case-sensitive\f[R]
Use case-sensitive matching
.TP
\f[V]-ns, --case-insensitive\f[R]
Use case-insensitive matching
.TP
\f[V]-nm, --normal\f[R]
Start spmenu in normal mode
.TP
\f[V]-im, --insert\f[R]
Start spmenu in insert mode
.TP
\f[V]-t, --top\f[R]
Position spmenu at the top of the screen
.TP
\f[V]-b, --bottom\f[R]
Position spmenu at the bottom of the screen
.TP
\f[V]-c, --center\f[R]
Position spmenu at the center of the screen
.TP
\f[V]-itt, --item-top\f[R]
Position items above all other elements
.TP
\f[V]-itb, --item-bottom\f[R]
Position items below all other elements
.TP
\f[V]-hm, --hide-mode\f[R]
Hide mode indicator
.TP
\f[V]-hit, --hide-item\f[R]
Hide items
.TP
\f[V]-hmc, --hide-match-count\f[R]
Hide match count
.TP
\f[V]-hla, --hide-left-arrow\f[R]
Hide left arrow
.TP
\f[V]-hra, --hide-right-arrow\f[R]
Hide right arrow
.TP
\f[V]-hpr, --hide-prompt\f[R]
Hide prompt
.TP
\f[V]-hpt, --hide-pretext\f[R]
Hide pretext
.TP
\f[V]-hip, --hide-input\f[R]
Hide input
.TP
\f[V]-hpl, --hide-powerline\f[R]
Hide powerline
.TP
\f[V]-hc, --hide-caret, --hide-cursor\f[R]
Hide caret
.TP
\f[V]-hhl, --hide-highlighting\f[R]
Hide highlight
.TP
\f[V]-hi, --hide-image\f[R]
Hide image
.TP
\f[V]-hcl, --hide-caps\f[R]
Hide caps lock indicator
.TP
\f[V]-sm, --show-mode\f[R]
Show mode indicator
.TP
\f[V]-sit, --show-item\f[R]
Show items
.TP
\f[V]-smc, --show-match-count\f[R]
Show match count
.TP
\f[V]-sla, --show-left-arrow\f[R]
Show left arrow
.TP
\f[V]-sra, --show-right-arrow\f[R]
Show right arrow
.TP
\f[V]-spr, --show-prompt\f[R]
Show prompt
.TP
\f[V]-sin, --show-input\f[R]
Show input
.TP
\f[V]-spt, --show-pretext\f[R]
Show pretext
.TP
\f[V]-spl, --show-powerline\f[R]
Show powerline
.TP
\f[V]-sc, --show-caret, --show-cursor\f[R]
Show caret
.TP
\f[V]-shl, --show-highlighting\f[R]
Show highlight
.TP
\f[V]-si, --show-image\f[R]
Show image
.TP
\f[V]-scl, --show-caps\f[R]
Show caps lock indicator
.TP
\f[V]-xrdb, --xrdb\f[R]
Load .Xresources on runtime (X11 only)
.TP
\f[V]-nxrdb, --no-xrdb\f[R]
Don\[cq]t load .Xresources on runtime (X11 only)
.TP
\f[V]-m, --monitor monitor\f[R]
Specify a monitor to run spmenu on (X11 only)
.TP
\f[V]-w, --embed window id\f[R]
Embed spmenu inside window id (X11 only)
.TP
\f[V]-H, --hist-file hist file\f[R]
Specify a file to save the history to
.TP
\f[V]-lf, --list-file list file\f[R]
Specify a file to load entries from
.TP
\f[V]-ig, --image-gaps gaps\f[R]
Set image gaps to gaps
.TP
\f[V]-txp, --text-padding padding\f[R]
Set text padding to padding
.TP
\f[V]-vem, --vertical-margin margin\f[R]
Set the vertical margin to margin
.TP
\f[V]-hom, --horizontal-margin margin\f[R]
Set the horizontal margin to margin
.TP
\f[V]-lp, --vertical-padding padding\f[R]
Set the vertical padding to padding
.TP
\f[V]-hp, --horizontal-padding padding\f[R]
Set the horizontal padding to padding
.TP
\f[V]-la, --left-arrow-symbol symbol\f[R]
Set the left arrow to symbol
.TP
\f[V]-ra, --right-arrow-symbol symbol\f[R]
Set the right arrow to symbol
.TP
\f[V]-is, --image-size size\f[R]
Image size
.TP
\f[V]-it, --image-top\f[R]
Position the image at the top
.TP
\f[V]-ib, --image-bottom\f[R]
Position the image at the bottom
.TP
\f[V]-ic, --image-center\f[R]
Position the image in the center
.TP
\f[V]-itc, --image-topcenter\f[R]
Position the image in the top center
.TP
\f[V]-ir, --image-resize\f[R]
Allow spmenu to resize itself to fit the image
.TP
\f[V]-nir, --no-image-resize\f[R]
Don\[cq]t allow spmenu to resize itself to fit the image
.TP
\f[V]-di, --display-icons\f[R]
Display the images as icons
.TP
\f[V]-df, --display-image\f[R]
Display the images as images in the image pane
.TP
\f[V]-wm, --managed, --x11-client\f[R]
Spawn spmenu as a window manager controlled client/window (X11 only)
.TP
\f[V]-nwm, --unmanaged\f[R]
Don\[cq]t spawn spmenu as a window manager controlled client/window (X11
only)
.TP
\f[V]-gk, --grab-keyboard\f[R]
Grab keyboard on runtime
.TP
\f[V]-ngk, --no-grab-keyboard\f[R]
Grab keyboard on runtime
.TP
\f[V]-cf, --config-file file\f[R]
Set config file to load to file
.TP
\f[V]-lcfg, --load-config\f[R]
Load spmenu configuration (\[ti]/.config/spmenu/spmenu.conf) on runtime
.TP
\f[V]-ncfg, --no-load-config\f[R]
Don\[cq]t load spmenu configuration (\[ti]/.config/spmenu/spmenu.conf)
on runtime
.TP
\f[V]-bf, --bind-file file\f[R]
Set bind file to load to file
.TP
\f[V]-lbi, --load-binds\f[R]
Exclusively load binds from file (\[ti]/.config/spmenu/binds.conf) on
runtime
.TP
\f[V]-nlbi, --no-load-binds\f[R]
Don\[cq]t exclusively load binds from file
(\[ti]/.config/spmenu/binds.conf) on runtime
.TP
\f[V]-tm, --theme theme\f[R]
Load theme `theme' on runtime
.TP
\f[V]-ltm, --load-theme\f[R]
Load theme (\[ti]/.config/spmenu/theme.conf) on runtime
.TP
\f[V]-nltm, --no-load-theme\f[R]
Don\[cq]t load theme (\[ti]/.config/spmenu/theme.conf) on runtime
.TP
\f[V]-x11, --x11\f[R]
Run spmenu in X11 mode
.TP
\f[V]-wl, --wayland\f[R]
Run spmenu in Wayland mode
.TP
\f[V]-v, --version\f[R]
Print spmenu version to stdout
.TP
\f[V]-rv, --raw-version\f[R]
Print raw spmenu version number to stdout
.TP
\f[V]-fl, --feature-list\f[R]
List the state of all features that can be toggled
.TP
\f[V]-fn, --font font\f[R]
Set the spmenu font to font
.TP
\f[V]-nif, --normal-item-foreground color\f[R]
Set the normal item foreground color
.TP
\f[V]-nib, --normal-item-background color\f[R]
Set the normal item background color
.TP
\f[V]-nnif, --normal-next-item-foreground color\f[R]
Set the normal next item foreground color
.TP
\f[V]-nnib, --normal-next-item-background color\f[R]
Set the normal next item background color
.TP
\f[V]-sif, --selected-item-foreground color\f[R]
Set the selected item foreground color
.TP
\f[V]-sib, --selected-item-background color\f[R]
Set the selected item background color
.TP
\f[V]-npf, --normal-item-priority-foreground color\f[R]
Set the normal item (high priority) foreground color
.TP
\f[V]-npb, --normal-item-priority-background color\f[R]
Set the normal item (high priority) background color
.TP
\f[V]-spf, --selected-item-priority-foreground color\f[R]
Set the selected item (high priority) foreground color
.TP
\f[V]-spb, --selected-item-priority-background color\f[R]
Set the selected item (high priority) background color
.TP
\f[V]-pfg, --prompt-foreground color\f[R]
Set the prompt foreground color
.TP
\f[V]-pbg, --prompt-background color\f[R]
Set the prompt background color
.TP
\f[V]-ifg, --input-foreground color\f[R]
Set input foreground color
.TP
\f[V]-ibg, --input-background color\f[R]
Set input background color
.TP
\f[V]-ptfg, --pretext-foreground color\f[R]
Set pretext foreground color
.TP
\f[V]-ptbg, --pretext-background color\f[R]
Set pretext background color
.TP
\f[V]-mnbg, --menu-background color\f[R]
Set the menu background color
.TP
\f[V]-nhf, --normal-highlight-foreground color\f[R]
Set the normal highlight foreground color
.TP
\f[V]-nhb, --normal-highlight-background color\f[R]
Set the normal highlight background color
.TP
\f[V]-shf, --selected-highlight-foreground color\f[R]
Set the selected highlight foreground color
.TP
\f[V]-shb, --selected-highlight-background color\f[R]
Set the selected highlight background color
.TP
\f[V]-nfg, --number-foreground color\f[R]
Set the foreground color for the match count
.TP
\f[V]-nbg, --number-background color\f[R]
Set the background color for the match count
.TP
\f[V]-mfg, --mode-foreground color\f[R]
Set the foreground color for the mode indicator
.TP
\f[V]-mbg, --mode-background color\f[R]
Set the background color for the mode indicator
.TP
\f[V]-laf, --left-arrow-foreground color\f[R]
Set the left arrow foreground color
.TP
\f[V]-raf, --right-arrow-foreground color\f[R]
Set the right arrow foreground color
.TP
\f[V]-lab, --left-arrow-background color\f[R]
Set the left arrow background color
.TP
\f[V]-rab, --right-arrow-background color\f[R]
Set the right arrow background color
.TP
\f[V]-cfc, --caret-foreground color\f[R]
Set the caret foreground color
.TP
\f[V]-cbc, --caret-background color\f[R]
Set the caret background color
.TP
\f[V]-bc, --border-background color\f[R]
Set the border color
.TP
\f[V]-sgr0, --sgr0 color\f[R]
Set the SGR 0 color
.TP
\f[V]-sgr1, --sgr1 color\f[R]
Set the SGR 1 color
.TP
\f[V]-sgr2, --sgr2 color\f[R]
Set the SGR 2 color
.TP
\f[V]-sgr3, --sgr3 color\f[R]
Set the SGR 3 color
.TP
\f[V]-sgr4, --sgr4 color\f[R]
Set the SGR 4 color
.TP
\f[V]-sgr5, --sgr5 color\f[R]
Set the SGR 5 color
.TP
\f[V]-sgr6, --sgr6 color\f[R]
Set the SGR 6 color
.TP
\f[V]-sgr7, --sgr7 color\f[R]
Set the SGR 7 color
.TP
\f[V]-sgr8, --sgr8 color\f[R]
Set the SGR 8 color
.TP
\f[V]-sgr9, --sgr9 color\f[R]
Set the SGR 9 color
.TP
\f[V]-sgr10, --sgr10 color\f[R]
Set the SGR 10 color
.TP
\f[V]-sgr11, --sgr11 color\f[R]
Set the SGR 11 color
.TP
\f[V]-sgr12, --sgr12 color\f[R]
Set the SGR 12 color
.TP
\f[V]-sgr13, --sgr13 color\f[R]
Set the SGR 13 color
.TP
\f[V]-sgr14, --sgr14 color\f[R]
Set the SGR 14 color
.TP
\f[V]-sgr15, --sgr15 color\f[R]
Set the SGR 15 color
.PP
dmenu compatibility can be achieved using these arguments:
.TP
\f[V]-S\f[R]
Don\[cq]t sort matches
.TP
\f[V]-i\f[R]
Use case-insensitive matching
.TP
\f[V]-nb color\f[R]
Set the normal background color
.TP
\f[V]-nf color\f[R]
Set the normal foreground color
.TP
\f[V]-sb color\f[R]
Set the selected background color
.TP
\f[V]-sf color\f[R]
Set the selected foreground color
.PP
There are more options, that can be set in the configuration file but
not using arguments passed to spmenu.
.SS Matching
.PP
\f[V]printf \[dq]Apple\[rs]nPear\[rs]nBanana\[rs]n\[dq] | spmenu\f[R]
.PP
With the default configuration, typing in \f[V]Apple\f[R],
\f[V]apple\f[R], \f[V]aPpLe\f[R] and \f[V]pple\f[R] will match
\f[V]Apple\f[R] in this example.
Matching is case insensitive, and fuzzy matching is enabled by default.
You can disable fuzzy matching and enable case sensitivity using
arguments, or by enabling it in the configuration.
.PP
\f[V]printf \[dq]1 Apple\[rs]nOne Apple\[rs]n\[dq] | spmenu\f[R]
.PP
spmenu also supports regex matching, but it is not enabled by default.
Therefore, typing in \f[V][0-9]\f[R] will return no matches.
In the default configuration, you can press Ctrl+r to enable regex
matching.
Now typing in \f[V][0-9]\f[R] will return the \f[V]1 Apple\f[R] entry,
but not the \f[V]One Apple\f[R] entry.
Of course, more advanced regex can be used as well.
.SS Modes
.PP
There are two modes.
Normal mode and Insert mode.
These modes are of course similar to Vim.
.PP
Normal mode is the mode spmenu starts in unless a mode argument is
specified or another mode is set in the configuration file.
Note that if \f[V]forceinsertmode\f[R] is enabled, Normal mode cannot be
used and spmenu will start in Insert mode instead.
.PP
In normal mode, all keys perform some action, but you cannot type any
actual text to filter items.
This mode is commonly used for navigation, general keybinds, as well as
quickly selecting an item.
By default though, this mode is not used.
.PP
Insert mode is entered through (by default) pressing \f[V]i\f[R] in
normal mode.
In this mode, most keybinds do nothing.
When you are in insert mode, you filter items by typing text into the
field.
.PP
Once you\[cq]re done with insert mode and normal mode is enabled, you
can press (by default) Escape to enter normal mode again.
.PP
All of these keybinds can be overriden in the configuration file.
Should you unbind your switchmode key, you can always press
\f[V]Ctrl+Alt+Delete\f[R] to exit spmenu, allowing you to fix your
spmenu configuration.
.SS History buffer
.PP
spmenu allows you to specify a history file using the \f[V]-H\f[R]
argument.
When this argument is specified, the selected item(s) will be appended
to the file.
In spmenu.conf, you can specify a max number of entries, and whether you
want duplicate entries or not.
.PP
To access the history buffer, call \f[V]viewhist\f[R].
By default, the keybind for that is Shift+h in normal mode.
You can also access it by clicking the match indicator.
To hide the history buffer again, call \f[V]viewhist\f[R].
.PP
If \f[V]-H\f[R] is not specified, the history buffer will not be
available, and calling \f[V]viewhist\f[R] will do nothing.
.SS -p option
.PP
spmenu has a \f[V]-p\f[R] or \f[V]--prompt\f[R] option.
It allows you to specify text to display next to the item list.
It is displayed on the left side of the spmenu window.
It should be noted that the prompt is purely visual though.
.PP
It may be useful when you want to display information, such as the
current directory or what the items actually do.
This is a field that can be overriden with almost any text.
.SS Displaying images
.PP
spmenu supports displaying images.
This image is placed on the left side of the menu window, as long as
spmenu isn\[cq]t a single line.
.PP
To use an image, pipe \f[V]img:///path/to/image\f[R] to spmenu.
If you want you can specify arguments like usual.
Note that you should add a Tab (\f[V]\[rs]t\f[R]) character after the
path to the image file.
Otherwise the text after will be interpreted as part of the filename and
the image will not be drawn.
.PP
Any text after the Tab character will be interpreted as a regular item.
In practice, drawing an image might look like this:
.PP
\f[V]printf \[dq]img:///path/to/image\[rs]tLook at that image, isn\[aq]t it awesome?\[rs]n\[dq] | spmenu\f[R]
.PP
There are also a few image related arguments, such as:
.PP
\f[V]-is\f[R], \f[V]-ig\f[R], \f[V]-it\f[R], \f[V]-ib\f[R],
\f[V]-ic\f[R], \f[V]-itc\f[R] and \f[V]-gc\f[R].
.PP
Vector images (such as .svg) can be displayed too in the same way.
This is all done using \f[V]imlib2\f[R] and \f[V]cairo\f[R] so as long
as imlib2 support it, it can be used.
.PP
If the image cannot be located, isn\[cq]t a valid format or cannot be
displayed for some reason, the space where the image would be displayed
is blank.
.SS Colored text
.PP
spmenu supports colored text through SGR sequences.
This is the same colors that you might already be using in your shell
scripts.
This means you can pipe practically any colored shell script straight
into spmenu, no need to filter the output or anything.
.PP
Not only does it support colored text, but it also supports colored
backgrounds.
This allows something similar to the emoji highlight patch on the
suckless website, except even more useful.
.PP
Example:
\f[V]printf \[dq]\[rs]033[0;44m\[u1F600]\[rs]033[0m Emoji highlighting\[rs]n\[dq] | spmenu --columns 1\f[R]
.PP
It should be noted that font sequences are not yet supported.
See `SGR sequences' for more information.
.SS SGR sequences
.PP
SGR sequences (ANSI escape codes) can be used to set the color of spmenu
items.
Here\[cq]s a simple table of good SGR sequences.
Note that sequences can also be combined, and that this isn\[cq]t the
only way to format them.
.PP
.TS
tab(@);
lw(12.7n) lw(57.3n).
T{
Sequence
T}@T{
Description
T}
_
T{
\[rs]033[0m
T}@T{
Reset foreground and background color and alpha
T}
T{
\[rs]033[0;3nm
T}@T{
Set foreground color to normal color index `n' (0-7)
T}
T{
\[rs]033[1;3nm
T}@T{
Set foreground color to bright color index `n' (0-7)
T}
T{
\[rs]033[0;4nm
T}@T{
Set background color to normal color index `n' (0-7)
T}
T{
\[rs]033[1;4nm
T}@T{
Set background color to bright color index `n' (0-7)
T}
T{
\[rs]033[9nm
T}@T{
Set foreground color to bright color index `n' (0-7)
T}
T{
\[rs]033[10nm
T}@T{
Set background color to bright color index `n' (0-7)
T}
T{
\[rs]033[38;2;r;g;bm
T}@T{
Set foreground color to a specified RGB color, r is red, g is green, b
is blue
T}
T{
\[rs]033[48;2;r;g;bm
T}@T{
Set background color to a specified RGB color, r is red, g is green, b
is blue
T}
T{
\[rs]033[38;5;nm
T}@T{
Set foreground color to color index `n' (0-256)
T}
T{
\[rs]033[48;5;nm
T}@T{
Set background color to color index `n' (0-256)
T}
T{
\[rs]033[39m
T}@T{
Reset foreground color and alpha
T}
T{
\[rs]033[49m
T}@T{
Reset background color and alpha
T}
T{
;
T}@T{
Semicolon is used as a separator
T}
T{
m
T}@T{
Ends the sequence
T}
.TE
.PP
Other sequences \f[I]may\f[R] be supported but are not listed here.
In any case, this allows for all RGB colors to be theoretically used all
at the same time.
.PP
For example, to set the foreground color to red and print `Hello world',
one could do the following:
\f[V]printf \[aq]\[rs]033[0;31mHello world\[rs]n\[dq] | spmenu\f[R] This
will set the foreground color to \f[V]sgr1\f[R] in the config/theme
file.
You can do this for \f[V]sgr0\f[R] through \f[V]sgr7\f[R].
To access \f[V]sgr8\f[R] through \f[V]sgr15\f[R] you use
\f[V]\[rs]033[1\f[R] rather than \f[V]\[rs]033[0\f[R], specifying that
you want bright colors to be used.
.PP
As for 256 colors, you simply specify a value between 0 and 256.
These colors are built into spmenu and cannot be overridden.
They are only really implemented into spmenu for compatibility, in
practice you should use true color sequences instead, as they are much
more flexible.
.PP
True color is slightly more complicated.
For example, to print black text on a white background, one could do
something like this:
\f[V]printf \[dq]\[rs]033[48;2;255;255;255;38;2;0;0;0mTest\[rs]033[0m\[rs]n\[dq] | spmenu\f[R]
.PP
This might look confusing if you aren\[cq]t familiar with these
sequences, but it\[cq]s fairly simple.
First we set the background color and specify that this is a true color
sequence.
(\f[V]48;2\f[R]) Then we set the red, green and blue channel to fully
opaque (\f[V]255;255;255\f[R] for red;green;blue), resulting in white.
Then we repeat this for a foreground color (\f[V]38;2\f[R]) but replace
\f[V]255\f[R] with \f[V]0\f[R], which results in black.
Do however note that you don\[cq]t need to specify \f[I]both\f[R] a
foreground and background color.
.PP
\f[B]Note: Background colors will used until a reset sequence is
found.\f[R]
.SS FIFO
.PP
spmenu has support for FIFO.
This means you can tell spmenu to perform certain actions while it is
running.
spmenu checks the FIFO every 0.1 seconds.
To use it, simply append a valid name to the FIFO file, which by default
is /tmp/spmenu.fifo.
.PP
You must append \f[B]without\f[R] a newline.
Otherwise it will be considered invalid.
It is recommended that you sleep for 0.1 seconds after appending to the
file for performance reasons.
.PP
.TS
tab(@);
lw(12.7n) lw(57.3n).
T{
Name
T}@T{
Description
T}
_
T{
drawmenu
T}@T{
Draw the menu
T}
T{
match
T}@T{
Match entries again, useful if you\[cq]re loading items from file
T}
T{
update
T}@T{
Match and then draw the menu.
Both drawmenu and match one after another
T}
T{
output
T}@T{
Output selected item text
T}
T{
output_index
T}@T{
Output selected item index
T}
T{
loadconfig
T}@T{
Reload config
T}
T{
test
T}@T{
Print out `Test print' to standard output
T}
T{
die
T}@T{
Print out `FIFO told me to die.' using the die() function
T}
T{
toggleinput
T}@T{
Toggle input
T}
T{
togglepretext
T}@T{
Toggle pretext
T}
T{
togglelarrow
T}@T{
Toggle left arrow
T}
T{
togglerarrow
T}@T{
Toggle right arrow
T}
T{
toggleitem
T}@T{
Toggle item
T}
T{
toggleprompt
T}@T{
Toggle prompt
T}
T{
togglecaps
T}@T{
Toggle caps lock indicator
T}
T{
togglepowerline
T}@T{
Toggle powerline
T}
T{
togglecaret
T}@T{
Toggle caret
T}
T{
togglehighlight
T}@T{
Toggle highlighting
T}
T{
togglematchcount
T}@T{
Toggle match count
T}
T{
togglemode
T}@T{
Toggle mode indicator
T}
T{
toggleregex
T}@T{
Toggle regex
T}
T{
togglefuzzy
T}@T{
Toggle fuzzy
T}
T{
toggleimg
T}@T{
Toggle images
T}
T{
toggleimgtype
T}@T{
Toggle image type
T}
T{
screenshot
T}@T{
Screenshot spmenu
T}
T{
setprofile
T}@T{
Open profile menu
T}
T{
setlines+
T}@T{
Increase lines by 1
T}
T{
setlines-
T}@T{
Decrease lines by 1
T}
T{
setcolumns+
T}@T{
Increase columns by 1
T}
T{
setcolumns-
T}@T{
Decrease columns by 1
T}
T{
setx+
T}@T{
Increase X position by 1
T}
T{
setx-
T}@T{
Decrease X position by 1
T}
T{
sety+
T}@T{
Increase Y position by 1
T}
T{
sety-
T}@T{
Decrease Y position by 1
T}
T{
setw+
T}@T{
Increase width by 1
T}
T{
setw-
T}@T{
Decrease width by 1
T}
T{
moveup
T}@T{
Move up one item
T}
T{
movedown
T}@T{
Move down one item
T}
T{
moveleft
T}@T{
Move left one item
T}
T{
moveright
T}@T{
Move right one item
T}
T{
movestart
T}@T{
Move to the start
T}
T{
moveend
T}@T{
Move to the end
T}
T{
movenext
T}@T{
Move to the next page
T}
T{
moveprev
T}@T{
Move to the previous page
T}
T{
moveword+
T}@T{
Move caret to the next word
T}
T{
moveword-
T}@T{
Move caret to the previous word
T}
T{
movecaret+
T}@T{
Move caret to the next character
T}
T{
movecaret-
T}@T{
Move caret to the previous character
T}
T{
clear
T}@T{
Clear input
T}
T{
viewhist
T}@T{
View history buffer
T}
T{
backspace
T}@T{
Backspace
T}
T{
deleteword
T}@T{
Remove one full word forward
T}
T{
exit_0
T}@T{
Exit with exit code 0
T}
T{
exit_1
T}@T{
Exit with exit code 1
T}
.TE
.SS Pango markup and text formatting
.PP
Because spmenu uses Pango and Cairo for text drawing, Pango markup can
be used to format text and other elements.
.PP
Pango markup allows you to style text similar to an HTML document.
It also provides the \f[V]<span>\f[R] tag, which can be used to do
surprisingly complex things, such as drawing shapes.
.PP
There are many convenient tags as well which can be used to avoid using
a \f[V]<span>\f[R] tag, such as:
.TP
\f[V]<b>\f[R]
\f[B]Bold\f[R] text (\f[V]<b>Bold</b>\f[R])
.TP
\f[V]<i>\f[R]
\f[I]Italic\f[R] text (\f[V]<i>Italic</i>\f[R])
.TP
\f[V]<s>\f[R]
Strikethrough text (\f[V]<s>Strikethrough</s>\f[R])
.TP
\f[V]<u>\f[R]
Underline text (\f[V]<u>Underline</u>\f[R])
.TP
\f[V]<sub>\f[R]
Subscript (\f[V]<sub>Subscript</sub>\f[R])
.TP
\f[V]<sup>\f[R]
Superscript (\f[V]<sup>Supscript</sup>\f[R])
.TP
\f[V]<tt>\f[R]
Monospace font (\f[V]<tt>Monospaced font is used here</tt>\f[R])
.TP
\f[V]<small>\f[R]
Small text (\f[V]<small>text is so small here</small>\f[R])
.TP
\f[V]<big>\f[R]
Big text (\f[V]<big>text is so big here</big>\f[R])
.PP
You can also color foreground or background text using the
\f[V]<span>\f[R] tag.
For example
\f[V]<span foreground=\[dq]#FFFF00\[dq] background=\[dq]#00FFFF\[dq]>text</span>\f[R]
will color the foreground and background.
Of course, this is a bad way to color text in spmenu because SGR
sequences can be used instead.
.PP
Note that Pango markup is NOT escaped, and is piped to stdout.
Therefore you need to parse it manually.
Doing so with \f[V]sed\f[R] is very easy.
For example:
\f[V]... | spmenu ... | sed \[aq]s/<big>//g; s/</big>//g\[aq]\f[R]
.PP
See this page (https://docs.gtk.org/Pango/pango_markup.html) for more
information.
.SS Configuration
.PP
Unlike dmenu, spmenu has a configuration file which can be edited by
hand.
It is located in \[ti]/.config/spmenu/spmenu.conf, but you can override
this by exporting \f[V]$XDG_CONFIG_HOME\f[R].
.PP
When spmenu is installed, it copies a sample configuration to
/usr/share/spmenu/spmenu.conf.
You can copy this to your \f[V].config/spmenu\f[R] directory.
This configuration file is loaded on startup.
.PP
You can also include other configuration files in the configuration file
using \f[V]\[at]include \[dq]path/to/config\[dq]\f[R], useful if you
wish to split your config file up into multiple segments.
.PP
Note that spmenu also has a \f[V]binds.conf\f[R] configuration file,
which isn\[cq]t used very much.
This file is documented well
here (https://spmenu.speedie.site/binds.conf+documentation).
.SS Keybinds
.PP
You can set keybinds through the config file.
A default config file is available after installing spmenu.
This configuration file has identical keybinds to the default hardcoded
keybinds.
.PP
By default, the configuration file will ignore all hardcoded keybinds to
prevent keybind conflicts, but if you do not like this behavior you can
simply set \f[V]ignoreglobalkeys = 0\f[R].
.PP
Note that if you do unbind your exit or switchmode key by accident and
find that you cannot exit spmenu, press \f[V]Ctrl+Alt+Delete\f[R].
This is a hardcoded keybind which cannot be disabled from the
configuration file.
.PP
These are the default keybinds.
.PP
.TS
tab(@);
lw(14.0n) lw(14.0n) lw(14.0n) lw(14.0n) lw(14.0n).
T{
Mode
T}@T{
Modifier
T}@T{
Key
T}@T{
Function
T}@T{
Argument
T}
_
T{
-1
T}@T{
None
T}@T{
Enter
T}@T{
selectitem
T}@T{
+1
T}
T{
-1
T}@T{
Shift
T}@T{
Enter
T}@T{
selectitem
T}@T{
0
T}
T{
-1
T}@T{
Ctrl
T}@T{
Enter
T}@T{
markitem
T}@T{
0
T}
T{
-1
T}@T{
None
T}@T{
Tab
T}@T{
complete
T}@T{
0
T}
T{
-1
T}@T{
Ctrl
T}@T{
v
T}@T{
paste
T}@T{
2
T}
T{
-1
T}@T{
None
T}@T{
Backspace
T}@T{
backspace
T}@T{
0
T}
T{
-1
T}@T{
Ctrl
T}@T{
Backspace
T}@T{
deleteword
T}@T{
0
T}
T{
-1
T}@T{
Ctrl+Shift
T}@T{
p
T}@T{
setprofile
T}@T{
0
T}
T{
-1
T}@T{
Ctrl
T}@T{
=
T}@T{
setimgsize
T}@T{
+10
T}
T{
-1
T}@T{
Ctrl
T}@T{
-
T}@T{
setimgsize
T}@T{
-10
T}
T{
-1
T}@T{
None
T}@T{
Up
T}@T{
moveup
T}@T{
0
T}
T{
-1
T}@T{
None
T}@T{
Down
T}@T{
movedown
T}@T{
0
T}
T{
-1
T}@T{
None
T}@T{
Left
T}@T{
moveleft
T}@T{
0
T}
T{
-1
T}@T{
None
T}@T{
Right
T}@T{
moveright
T}@T{
0
T}
T{
-1
T}@T{
Ctrl
T}@T{
u
T}@T{
moveup
T}@T{
5
T}
T{
-1
T}@T{
Ctrl
T}@T{
d
T}@T{
movedown
T}@T{
5
T}
T{
-1
T}@T{
Ctrl
T}@T{
h
T}@T{
viewhist
T}@T{
0
T}
T{
-1
T}@T{
None
T}@T{
Esc
T}@T{
quit
T}@T{
0
T}
T{
-1
T}@T{
Ctrl
T}@T{
p
T}@T{
navhistory
T}@T{
-1
T}
T{
-1
T}@T{
Ctrl
T}@T{
n
T}@T{
navhistory
T}@T{
+1
T}
T{
-1
T}@T{
None
T}@T{
PrintScr
T}@T{
screenshot
T}@T{
0
T}
.TE
.SS Mouse
.PP
spmenu supports mouse clicks.
The following parts can be clicked on:
.IP \[bu] 2
\f[V]ClickWindow\f[R]
.RS 2
.IP \[bu] 2
Clicking on the spmenu window
.RE
.IP \[bu] 2
\f[V]ClickPrompt\f[R]
.RS 2
.IP \[bu] 2
Clicking on the prompt
.RE
.IP \[bu] 2
\f[V]ClickInput\f[R]
.RS 2
.IP \[bu] 2
Clicking on the input
.RE
.IP \[bu] 2
\f[V]ClickLArrow\f[R]
.RS 2
.IP \[bu] 2
Clicking on the left arrow
.RE
.IP \[bu] 2
\f[V]ClickRArrow\f[R]
.RS 2
.IP \[bu] 2
Clicking on the right arrow
.RE
.IP \[bu] 2
\f[V]ClickItem\f[R]
.RS 2
.IP \[bu] 2
Clicking on an item
.RE
.IP \[bu] 2
\f[V]ClickImage\f[R]
.RS 2
.IP \[bu] 2
Clicking on an image
.RE
.IP \[bu] 2
\f[V]ClickNumber\f[R]
.RS 2
.IP \[bu] 2
Clicking on the match count indicator
.RE
.IP \[bu] 2
\f[V]ClickCaps\f[R]
.RS 2
.IP \[bu] 2
Clicking on the caps lock indicator
.RE
.IP \[bu] 2
\f[V]ClickMode\f[R]
.RS 2
.IP \[bu] 2
Clicking on the mode indicator
.RE
.IP \[bu] 2
\f[V]None\f[R]
.RS 2
.IP \[bu] 2
Any click
.RE
.PP
For information on the different functions you can pass, see the bottom
of this man page, `List of all configurable functions'.
.PP
You can set mouse binds through the config file.
A default config file is available after installing spmenu.
This configuration file has identical keybinds to the default hardcoded
keybinds.
.PP
By default, the configuration file will ignore all hardcoded mouse binds
to prevent conflicts, but if you do not like this behavior you can
simply set \f[V]ignoreglobalmouse = 0\f[R].
.PP
These are the default mouse binds.
Mode does not apply for mouse binds.
.PP
.TS
tab(@);
lw(17.5n) lw(17.5n) lw(17.5n) lw(17.5n).
T{
Click
T}@T{
Button
T}@T{
Function
T}@T{
Argument
T}
_
T{
ClickInput
T}@T{
Left Click
T}@T{
clear
T}@T{
0
T}
T{
ClickPrompt
T}@T{
Left Click
T}@T{
clear
T}@T{
0
T}
T{
ClickMode
T}@T{
Left Click
T}@T{
switchmode
T}@T{
0
T}
T{
ClickNumber
T}@T{
Left Click
T}@T{
viewhist
T}@T{
0
T}
T{
ClickItem
T}@T{
Left Click
T}@T{
selecthover
T}@T{
0
T}
T{
ClickItem
T}@T{
Right Click
T}@T{
markhover
T}@T{
0
T}
T{
None
T}@T{
Scroll Up
T}@T{
moveprev
T}@T{
0
T}
T{
None
T}@T{
Scroll Down
T}@T{
movenext
T}@T{
0
T}
.TE
.SS .Xresources
.PP
\f[B]NOTE: Only applies for X11 users\f[R]
.PP
spmenu also has .Xresources (xrdb) support built in.
It reads the xrdb (.Xresources database) on runtime.
You may disable it by passing -nxrdb, or enable it by passing -xrdb.
You can also set this in the config file.
.PP
You can also use wildcards (such as \f[V]*\f[R]) to achieve a global
colorscheme.
Programs like \f[V]pywal\f[R] do this to apply universal colorschemes.
.PP
\f[V]spmenu.color0\f[R] through \f[V]spmenu.color15\f[R] and
\f[V]spmenu.font\f[R] preferences are read by spmenu, these alter the
font and colorscheme spmenu uses.
.PP
.TS
tab(@);
l l.
T{
Xresources name
T}@T{
spmenu name
T}
_
T{
font
T}@T{
font
T}
T{
color10
T}@T{
caretfg
T}
T{
color0
T}@T{
caretbg
T}
T{
color4
T}@T{
larrowfg
T}
T{
color4
T}@T{
rarrowfg
T}
T{
color10
T}@T{
itemnormfg
T}
T{
color10
T}@T{
itemnormfg2
T}
T{
color10
T}@T{
itemnormprifg
T}
T{
color10
T}@T{
inputfg
T}
T{
color10
T}@T{
pretextfg
T}
T{
color0
T}@T{
itemnormbg
T}
T{
color0
T}@T{
itemnormbg2
T}
T{
color0
T}@T{
itemnormpribg
T}
T{
color0
T}@T{
menu
T}
T{
color0
T}@T{
larrowbg
T}
T{
color0
T}@T{
rarrowbg
T}
T{
color0
T}@T{
itemselfg
T}
T{
color0
T}@T{
itemmarkedfg
T}
T{
color0
T}@T{
itemselprifg
T}
T{
color0
T}@T{
inputbg
T}
T{
color0
T}@T{
pretextbg
T}
T{
color12
T}@T{
promptbg
T}
T{
color0
T}@T{
promptfg
T}
T{
color7
T}@T{
capsbg
T}
T{
color0
T}@T{
capsfg
T}
T{
color6
T}@T{
itemselbg
T}
T{
color6
T}@T{
itemmarkedbg
T}
T{
color6
T}@T{
itemselpribg
T}
T{
color6
T}@T{
border
T}
T{
color0
T}@T{
numfg
T}
T{
color5
T}@T{
numbg
T}
T{
color0
T}@T{
modefg
T}
T{
color11
T}@T{
modebg
T}
T{
color2
T}@T{
hlnormbg
T}
T{
color3
T}@T{
hlselbg
T}
T{
color0
T}@T{
hlnormfg
T}
T{
color0
T}@T{
hlselfg
T}
T{
color0
T}@T{
sgr0
T}
T{
color1
T}@T{
sgr1
T}
T{
color2
T}@T{
sgr2
T}
T{
color3
T}@T{
sgr3
T}
T{
color4
T}@T{
sgr4
T}
T{
color5
T}@T{
sgr5
T}
T{
color6
T}@T{
sgr6
T}
T{
color7
T}@T{
sgr7
T}
T{
color8
T}@T{
sgr8
T}
T{
color9
T}@T{
sgr9
T}
T{
color10
T}@T{
sgr10
T}
T{
color11
T}@T{
sgr11
T}
T{
color12
T}@T{
sgr12
T}
T{
color13
T}@T{
sgr13
T}
T{
color14
T}@T{
sgr14
T}
T{
color15
T}@T{
sgr15
T}
.TE
.SS Themes
.PP
You could just \f[V]\[at]include\f[R] themes from the aforementioned
\f[V]spmenu.conf\f[R], but it\[cq]s kind of inconvenient.
For this reason, spmenu reads \f[V].config/spmenu/theme.conf\f[R] on
startup as well.
To apply a basic theme, you simply replace theme.conf with the theme you
want to use.
.PP
There is a Git
repository (https://git.speedie.site/speedie/spmenu-themes) and wiki
article (https://spmenu.speedie.site/User+themes) which contains a bunch
of themes written for spmenu, and you can use them as a template when
making your own themes.
You may also contribute to this repository if you have a theme to show.
.PP
Do however note that the theme file is \f[B]not\f[R] the same as the
config file.
There are quite a lot of differences, and many options are not
available.
This is by design, as these options should be set by the user, not the
theme.
.PP
Having a single theme file is not very convenient if you have many
themes because you constantly have to replace your theme file, so theme
managers exist to make this a bit easier.
spmenuify (https://git.speedie.site/speedie/spmenuify) is the official
theme manager, but you could use another one or write your own.
.PP
For more information on the theme.conf configuration file, see this
page (https://spmenu.speedie.site/theme.conf+documentation).
.SS List of all configurable functions
.PP
This is a list of all functions that can be called using a key or mouse
bind:
.IP \[bu] 2
\f[V]moveup\f[R]
.RS 2
.IP \[bu] 2
Move up by MAX(passed argument, 1)
.RE
.IP \[bu] 2
\f[V]movedown\f[R]
.RS 2
.IP \[bu] 2
Move down by MAX(passed argument, 1)
.RE
.IP \[bu] 2
\f[V]moveleft\f[R]
.RS 2
.IP \[bu] 2
Move left by MAX(passed argument, 1)
.RE
.IP \[bu] 2
\f[V]moveright\f[R]
.RS 2
.IP \[bu] 2
Move right by MAX(passed argument, 1)
.RE
.IP \[bu] 2
\f[V]movestart\f[R]
.RS 2
.IP \[bu] 2
Move to the first item
.RE
.IP \[bu] 2
\f[V]moveend\f[R]
.RS 2
.IP \[bu] 2
Move to the last item
.RE
.IP \[bu] 2
\f[V]movenext\f[R]
.RS 2
.IP \[bu] 2
Move to the next page
.RE
.IP \[bu] 2
\f[V]moveprev\f[R]
.RS 2
.IP \[bu] 2
Move to the previous page
.RE
.IP \[bu] 2
\f[V]moveitem\f[R]
.RS 2
.IP \[bu] 2
Move to item passed argument
.RE
.IP \[bu] 2
\f[V]paste\f[R]
.RS 2
.IP \[bu] 2
Paste from clipboard, 0 means clipboard selection, 1 means primary
selection
.RE
.IP \[bu] 2
\f[V]restoresel\f[R]
.RS 2
.IP \[bu] 2
Move back to the first item
.RE
.IP \[bu] 2
\f[V]clear\f[R]
.RS 2
.IP \[bu] 2
Clear input
.RE
.IP \[bu] 2
\f[V]clearins\f[R]
.RS 2
.IP \[bu] 2
Clear input text and switch to insert mode
.RE
.IP \[bu] 2
\f[V]viewhist\f[R]
.RS 2
.IP \[bu] 2
Toggle history and item buffer
.RE
.IP \[bu] 2
\f[V]moveword\f[R]
.RS 2
.IP \[bu] 2
Navigate through input text by 1 word, -1 means start, +1 means end
.RE
.IP \[bu] 2
\f[V]deleteword\f[R]
.RS 2
.IP \[bu] 2
Delete input text by 1 word
.RE
.IP \[bu] 2
\f[V]movecursor\f[R]
.RS 2
.IP \[bu] 2
Move cursor (caret) by MAX(passed argument, 1)
.RE
.IP \[bu] 2
\f[V]navhistory\f[R]
.RS 2
.IP \[bu] 2
Navigate through history buffer, -1 means forward, +1 means backwards
.RE
.IP \[bu] 2
\f[V]backspace\f[R]
.RS 2
.IP \[bu] 2
Backspace 1 character from input text
.RE
.IP \[bu] 2
\f[V]selectitem\f[R]
.RS 2
.IP \[bu] 2
Select the current selected item
.RE
.IP \[bu] 2
\f[V]quit\f[R]
.RS 2
.IP \[bu] 2
Quit spmenu
.RE
.IP \[bu] 2
\f[V]complete\f[R]
.RS 2
.IP \[bu] 2
Tab complete the selected item
.RE
.IP \[bu] 2
\f[V]setimgsize\f[R]
.RS 2
.IP \[bu] 2
Set image size to passed argument
.RE
.IP \[bu] 2
\f[V]defaultimg\f[R]
.RS 2
.IP \[bu] 2
Reset image size to the default
.RE
.IP \[bu] 2
\f[V]toggleinput\f[R]
.RS 2
.IP \[bu] 2
Toggle input
.RE
.IP \[bu] 2
\f[V]togglepretext\f[R]
.RS 2
.IP \[bu] 2
Toggle pretext
.RE
.IP \[bu] 2
\f[V]togglelarrow\f[R]
.RS 2
.IP \[bu] 2
Toggle left arrow
.RE
.IP \[bu] 2
\f[V]togglerarrow\f[R]
.RS 2
.IP \[bu] 2
Toggle right arrow
.RE
.IP \[bu] 2
\f[V]toggleitem\f[R]
.RS 2
.IP \[bu] 2
Toggle items
.RE
.IP \[bu] 2
\f[V]toggleprompt\f[R]
.RS 2
.IP \[bu] 2
Toggle prompt
.RE
.IP \[bu] 2
\f[V]togglecaps\f[R]
.RS 2
.IP \[bu] 2
Toggle caps lock indicator
.RE
.IP \[bu] 2
\f[V]togglepowerline\f[R]
.RS 2
.IP \[bu] 2
Toggle powerlines
.RE
.IP \[bu] 2
\f[V]togglecaret\f[R]
.RS 2
.IP \[bu] 2
Toggle caret (cursor)
.RE
.IP \[bu] 2
\f[V]togglehighlight\f[R]
.RS 2
.IP \[bu] 2
Toggle highlighting
.RE
.IP \[bu] 2
\f[V]togglematchcount\f[R]
.RS 2
.IP \[bu] 2
Toggle match count
.RE
.IP \[bu] 2
\f[V]togglemode\f[R]
.RS 2
.IP \[bu] 2
Toggle mode
.RE
.IP \[bu] 2
\f[V]toggleregex\f[R]
.RS 2
.IP \[bu] 2
Toggle regex mode
.RE
.IP \[bu] 2
\f[V]togglefuzzy\f[R]
.RS 2
.IP \[bu] 2
Toggle fuzzy matching
.RE
.IP \[bu] 2
\f[V]toggleimg\f[R]
.RS 2
.IP \[bu] 2
Toggle images
.RE
.IP \[bu] 2
\f[V]toggleimgtype\f[R]
.RS 2
.IP \[bu] 2
Toggle image type
.RE
.IP \[bu] 2
\f[V]flipimg\f[R]
.RS 2
.IP \[bu] 2
Flip image, 0 means vertically, 1 means horizontally
.RE
.IP \[bu] 2
\f[V]setimgpos\f[R]
.RS 2
.IP \[bu] 2
Move to the next image position
.RE
.IP \[bu] 2
\f[V]setimggaps\f[R]
.RS 2
.IP \[bu] 2
Set image gaps to passed argument
.RE
.IP \[bu] 2
\f[V]setlines\f[R]
.RS 2
.IP \[bu] 2
Set lines to passed argument
.RE
.IP \[bu] 2
\f[V]setcolumns\f[R]
.RS 2
.IP \[bu] 2
Set columns to passed argument
.RE
.IP \[bu] 2
\f[V]setx\f[R]
.RS 2
.IP \[bu] 2
Set X position to passed argument
.RE
.IP \[bu] 2
\f[V]sety\f[R]
.RS 2
.IP \[bu] 2
Set Y position to passed argument
.RE
.IP \[bu] 2
\f[V]setlineheight\f[R]
.RS 2
.IP \[bu] 2
Set line height to passed argument
.RE
.IP \[bu] 2
\f[V]setprofile\f[R]
.RS 2
.IP \[bu] 2
Open profile menu if available
.RE
.IP \[bu] 2
\f[V]switchmode\f[R]
.RS 2
.IP \[bu] 2
Switch between Normal mode and Insert mode
.RE
.IP \[bu] 2
\f[V]selecthover\f[R]
.RS 2
.IP \[bu] 2
Output the item clicked on
.RE
.IP \[bu] 2
\f[V]markhover\f[R]
.RS 2
.IP \[bu] 2
Mark the item clicked on
.RE
.IP \[bu] 2
\f[V]screenshot\f[R]
.RS 2
.IP \[bu] 2
Take a screenshot of spmenu
.RE
.SS License
.PP
spmenu is licensed under the MIT license.
The documentation is licensed under the CC-BY-SA 4.0 license.
.SS Reporting issues
.PP
Please report issues on the Git
repository (https://git.speedie.site/speedie/spmenu) or the GitHub
mirror (https://github.com/speediegq/spmenu).
.SS See also
.IP \[bu] 2
spmenu_run(1)
.IP \[bu] 2
spmenu_test(1)
.IP \[bu] 2
spmenu wiki (https://spmenu.speedie.site)
.IP \[bu] 2
spmenu git repository (https://git.speedie.site/speedie/spmenu)
.IP \[bu] 2
spmenu GitHub mirror (https://github.com/speediegq/spmenu)
.IP \[bu] 2
spmenuify (https://git.speedie.site/speedie/spmenuify)