diff --git a/docs/docs.md b/docs/docs.md index 86a5a1a..edbfcea 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -28,137 +28,374 @@ See a list below for a list. ## Arguments -Miscellanious: +You may use long, descriptive arguments or the shorter arguments. -- spmenu -l, --lines line - Set line count to stdin -- spmenu -mh, --lineheight height - Set spmenu line height to height -- spmenu -mw, --min-width width - Set minimum width to width -- spmenu -g, --columns grid - Set the number of grids to grid -- spmenu -gc, --generate-cache - Generate image cache -- spmenu -ngc, --no-generate-cache - Don't generate image cache -- spmenu -rw, --relative-width - Enable relative input width -- spmenu -nrw, --no-relative-width - Disable relative input width -- spmenu -f, --fast - Grabs keyboard before reading stdin -- spmenu -F, --fuzzy - Enable fuzzy matching -- spmenu -NF, --no-fuzzy - Disable fuzzy matching -- spmenu -P, --password - Hide characters -- spmenu -Ps, --password-symbol symbol - Set the password symbol to symbol -- spmenu -p, --prompt text - Set spmenu prompt text to text -- spmenu -ip, --indent - Indent items to prompt width -- spmenu -nip, --no-indent - Don't indent items to prompt width -- spmenu -a, --alpha - Enable alpha -- spmenu -na, --no-alpha - Disable alpha -- spmenu -tp, --allow-typing - Allow the user to type -- spmenu -nt, --no-allow-typing - Don't allow typing, the user must select an option -- spmenu -x, --x-position x offset - Offset spmenu x position by x offset -- spmenu -y, --y-position y offset - Offset spmenu y position by y offset -- spmenu -n, --preselect line - Preselect line in the list of items -- spmenu -z, --width width - Width of the spmenu window -- spmenu -nmt, --normal-mode-text text - Set normal mode text to text -- spmenu -imt, --insert-mode-text text - Set insert mode text to text -- spmenu -bw, --border-width width - Set width of the border to width . 0 will disable the border -- spmenu -so, --sort - Sort matches -- spmenu -nso, --no-sort - Don't sort matches -- spmenu -pri, --priority pri1,pri2,pri3 - Specify a list of items that take priority -- spmenu -s, --case-sensitive - Use case-sensitive matching -- spmenu -ns, --case-insensitive - Use case-insensitive matching -- spmenu -nm, --normal - Start spmenu in normal mode -- spmenu -im, --insert - Start spmenu in insert mode -- spmenu -t, --top - Position spmenu at the top of the screen -- spmenu -b, --bottom - Position spmenu at the bottom of the screen -- spmenu -c, --center - Position spmenu at the center of the screen -- spmenu -hm, --hide-mode - Hide mode indicator -- spmenu -hmc, --hide-match-count - Hide match count -- spmenu -hla, --hide-left-arrow - Hide left arrow -- spmenu -hra, --hide-right-arrow - Hide right arrow -- spmenu -hpr, --hide-prompt - Hide prompt -- spmenu -hc, --hide-cursor - Hide cursor -- spmenu -hhl, --hide-highlighting - Hide highlight -- spmenu -hi, --hide-image - Hide image -- spmenu -sm, --show-mode - Show mode indicator -- spmenu -smc, --show-match-count - Show match count -- spmenu -sla, --show-left-arrow - Show left arrow -- spmenu -sra, --show-right-arrow - Show right arrow -- spmenu -spr, --show-prompt - Show prompt -- spmenu -sc, --show-cursor - Show cursor -- spmenu -shl, --show-highlighting - Show highlight -- spmenu -si, --show-image - Show image -- spmenu -xrdb, --xrdb - Load .Xresources on runtime -- spmenu -nxrdb, --no-xrdb - Don't load .Xresources on runtime -- spmenu -m, --monitor monitor - Specify a monitor to run spmenu on -- spmenu -w, --embed window id - Embed spmenu inside window id -- spmenu -H, --hist-file hist file - Specify a path to save the history to -- spmenu -ig, --image-gaps gaps - Set image gaps to gaps -- spmenu -lp, --vertical-padding padding - Set the vertical padding -- spmenu -hp, --horizontal-padding padding - Set the horizontal padding -- spmenu -la, --left-arrow-symbol symbol - Set the left arrow to symbol -- spmenu -ra, --right-arrow-symbol symbol - Set the right arrow to symbol -- spmenu -is, --image-size size - Image size -- spmenu -it, --image-top - Position the image at the top -- spmenu -ib, --image-bottom - Position the image at the bottom -- spmenu -ic, --image-center - Position the image in the center -- spmenu -itc, --image-topcenter - Position the image in the top center -- spmenu -wm, --managed, --x11-client - Spawn spmenu as a window manager controlled client/window. Useful for testing -- spmenu -nwm, --unmanaged - Don't spawn spmenu as a window manager controlled client/window. Useful for testing -- spmenu -lcfg, --load-config - Load spmenu configuration (~/.spmenu or ~/.config/spmenu/spmenurc) -- spmenu -ncfg, --no-load-config - Don't load spmenu configuration (~/.spmenu or ~/.config/spmenu/spmenurc) -- spmenu -v, --version - Print spmenu version to stdout +`-mh, --lineheight height ` +: Set spmenu line height to height -Appearance: +`-mw, --min-width width ` +: Set minimum width to width -- spmenu -fn, --font font - Set the spmenu font to font -- spmenu -nif, --normal-item-foreground color - Set the normal item foreground color -- spmenu -nib, --normal-item-background color - Set the normal item background color -- spmenu -sif, --selected-item-foreground color - Set the selected item foreground color -- spmenu -sib, --selected-item-background color - Set the selected item background color -- spmenu -npf, --normal-item-priority-foreground color - Set the normal item (high priority) foreground color -- spmenu -npb, --normal-item-priority-background color - Set the normal item (high priority) background color -- spmenu -spf, --selected-item-priority-foreground color - Set the selected item (high priority) foreground color -- spmenu -spb, --selected-item-priority-background color - Set the selected item (high priority) background color -- spmenu -pfg, --prompt-foreground color - Set the prompt foreground color -- spmenu -pbg, --prompt-background color - Set the prompt background color -- spmenu -ifg, --input-foreground color - Set input foreground color -- spmenu -ibg, --input-background color - Set input background color -- spmenu -mnbg, --menu-background color - Set the menu background color -- spmenu -nhf, --normal-highlight-foreground color - Set the normal highlight foreground color -- spmenu -nhb, --normal-highlight-background color - Set the normal highlight background color -- spmenu -shf, --selected-highlight-foreground color - Set the selected highlight foreground color -- spmenu -shb, --selected-highlight-background color - Set the selected highlight background color -- spmenu -nfg, --number-foreground color - Set the foreground color for the match count -- spmenu -nbg, --number-background color - Set the background color for the match count -- spmenu -mfg, --mode-foreground color - Set the foreground color for the mode indicator -- spmenu -mbg, --mode-background color - Set the background color for the mode indicator -- spmenu -laf, --left-arrow-foreground color - Set the left arrow foreground color -- spmenu -raf, --right-arrow-foreground color - Set the right arrow foreground color -- spmenu -lab, --left-arrow-background color - Set the left arrow background color -- spmenu -rab, --right-arrow-background color - Set the right arrow background color -- spmenu -cc, --caret-foreground color - Set the caret color -- spmenu -bc, --border-background color - Set the border color -- spmenu -sgr0, --sgr0 color - Set the SGR 0 color -- spmenu -sgr1, --sgr1 color - Set the SGR 1 color -- spmenu -sgr2, --sgr2 color - Set the SGR 2 color -- spmenu -sgr3, --sgr3 color - Set the SGR 3 color -- spmenu -sgr4, --sgr4 color - Set the SGR 4 color -- spmenu -sgr5, --sgr5 color - Set the SGR 5 color -- spmenu -sgr6, --sgr6 color - Set the SGR 6 color -- spmenu -sgr7, --sgr7 color - Set the SGR 7 color -- spmenu -sgr8, --sgr8 color - Set the SGR 8 color -- spmenu -sgr9, --sgr9 color - Set the SGR 9 color -- spmenu -sgr10, --sgr10 color - Set the SGR 10 color -- spmenu -sgr11, --sgr11 color - Set the SGR 11 color -- spmenu -sgr12, --sgr12 color - Set the SGR 12 color -- spmenu -sgr13, --sgr13 color - Set the SGR 13 color -- spmenu -sgr14, --sgr14 color - Set the SGR 14 color -- spmenu -sgr15, --sgr15 color - Set the SGR 15 color +`-g, --columns grid ` +: Set the number of grids to grid -There are also extra arguments recognized for dmenu compatibility. These are: +`-gc, --generate-cache ` +: Generate image cache -- spmenu -S - Don't sort matches -- spmenu -i - Use case-insensitive matching -- spmenu -nb color - Set the normal background color -- spmenu -nf color - Set the normal foreground color -- spmenu -sb color - Set the selected background color -- spmenu -sf color - Set the selected foreground color +`-ngc, --no-generate-cache ` +: Don't generate image cache + +`-rw, --relative-width ` +: Enable relative input width + +`-nrw, --no-relative-width ` +: Disable relative input width + +`-f, --fast ` +: Grabs keyboard before reading stdin + +`-F, --fuzzy ` +: Enable fuzzy matching + +`-NF, --no-fuzzy ` +: Disable fuzzy matching + +`-P, --password ` +: Hide characters + +`-Ps, --password-symbol symbol ` +: Set the password symbol to symbol + +`-p, --prompt text ` +: Set spmenu prompt text to text + +`-ip, --indent ` +: Indent items to prompt width + +`-nip, --no-indent ` +: Don't indent items to prompt width + +`-a, --alpha ` +: Enable alpha + +`-na, --no-alpha ` +: Disable alpha + +`-tp, --allow-typing ` +: Allow the user to type + +`-nt, --no-allow-typing ` +: Don't allow typing, the user must select an option + +`-x, --x-position x offset ` +: Offset spmenu x position by x offset + +`-y, --y-position y offset ` +: Offset spmenu y position by y offset + +`-n, --preselect line ` +: Preselect line in the list of items + +`-z, --width width ` +: Width of the spmenu window + +`-nmt, --normal-mode-text text ` +: Set normal mode text to text + +`-imt, --insert-mode-text text ` +: Set insert mode text to text + +`-bw, --border-width width ` +: Set width of the border to width . 0 will disable the border + +`-so, --sort ` +: Sort matches + +`-nso, --no-sort ` +: Don't sort matches + +`-pri, --priority pri1,pri2,pri3 ` +: Specify a list of items that take priority + +`-s, --case-sensitive ` +: Use case-sensitive matching + +`-ns, --case-insensitive ` +: Use case-insensitive matching + +`-nm, --normal ` +: Start spmenu in normal mode + +`-im, --insert ` +: Start spmenu in insert mode + +`-t, --top ` +: Position spmenu at the top of the screen + +`-b, --bottom ` +: Position spmenu at the bottom of the screen + +`-c, --center ` +: Position spmenu at the center of the screen + +`-hm, --hide-mode ` +: Hide mode indicator + +`-hmc, --hide-match-count ` +: Hide match count + +`-hla, --hide-left-arrow ` +: Hide left arrow + +`-hra, --hide-right-arrow ` +: Hide right arrow + +`-hpr, --hide-prompt ` +: Hide prompt + +`-hc, --hide-cursor ` +: Hide cursor + +`-hhl, --hide-highlighting ` +: Hide highlight + +`-hi, --hide-image ` +: Hide image + +`-sm, --show-mode ` +: Show mode indicator + +`-smc, --show-match-count ` +: Show match count + +`-sla, --show-left-arrow ` +: Show left arrow + +`-sra, --show-right-arrow ` +: Show right arrow + +`-spr, --show-prompt ` +: Show prompt + +`-sc, --show-cursor ` +: Show cursor + +`-shl, --show-highlighting ` +: Show highlight + +`-si, --show-image ` +: Show image + +`-xrdb, --xrdb ` +: Load .Xresources on runtime + +`-nxrdb, --no-xrdb ` +: Don't load .Xresources on runtime + +`-m, --monitor monitor ` +: Specify a monitor to run spmenu on + +`-w, --embed window id ` +: Embed spmenu inside window id + +`-H, --hist-file hist file ` +: Specify a path to save the history to + +`-ig, --image-gaps gaps ` +: Set image gaps to gaps + +`-lp, --vertical-padding padding ` +: Set the vertical padding + +`-hp, --horizontal-padding padding ` +: Set the horizontal padding + +`-la, --left-arrow-symbol symbol ` +: Set the left arrow to symbol + +`-ra, --right-arrow-symbol symbol ` +: Set the right arrow to symbol + +`-is, --image-size size ` +: Image size + +`-it, --image-top ` +: Position the image at the top + +`-ib, --image-bottom ` +: Position the image at the bottom + +`-ic, --image-center ` +: Position the image in the center + +`-itc, --image-topcenter ` +: Position the image in the top center + +`-wm, --managed, --x11-client ` +: Spawn spmenu as a window manager controlled client/window. Useful for testing + +`-nwm, --unmanaged ` +: Don't spawn spmenu as a window manager controlled client/window. Useful for testing + +`-lcfg, --load-config ` +: Load spmenu configuration (~/.spmenu or ~/.config/spmenu/spmenurc) + +`-ncfg, --no-load-config ` +: Don't load spmenu configuration (~/.spmenu or ~/.config/spmenu/spmenurc) + +`-v, --version ` +: Print spmenu version to stdout + +`-fn, --font font` +: Set the spmenu font to font + +`-nif, --normal-item-foreground color ` +: Set the normal item foreground color + +`-nib, --normal-item-background color ` +: Set the normal item background color + +`-sif, --selected-item-foreground color ` +: Set the selected item foreground color + +`-sib, --selected-item-background color ` +: Set the selected item background color + +`-npf, --normal-item-priority-foreground color ` +: Set the normal item (high priority) foreground color + +`-npb, --normal-item-priority-background color ` +: Set the normal item (high priority) background color + +`-spf, --selected-item-priority-foreground color ` +: Set the selected item (high priority) foreground color + +`-spb, --selected-item-priority-background color ` +: Set the selected item (high priority) background color + +`-pfg, --prompt-foreground color ` +: Set the prompt foreground color + +`-pbg, --prompt-background color ` +: Set the prompt background color + +`-ifg, --input-foreground color ` +: Set input foreground color + +`-ibg, --input-background color ` +: Set input background color + +`-mnbg, --menu-background color ` +: Set the menu background color + +`-nhf, --normal-highlight-foreground color ` +: Set the normal highlight foreground color + +`-nhb, --normal-highlight-background color ` +: Set the normal highlight background color + +`-shf, --selected-highlight-foreground color ` +: Set the selected highlight foreground color + +`-shb, --selected-highlight-background color ` +: Set the selected highlight background color + +`-nfg, --number-foreground color ` +: Set the foreground color for the match count + +`-nbg, --number-background color ` +: Set the background color for the match count + +`-mfg, --mode-foreground color ` +: Set the foreground color for the mode indicator + +`-mbg, --mode-background color ` +: Set the background color for the mode indicator + +`-laf, --left-arrow-foreground color ` +: Set the left arrow foreground color + +`-raf, --right-arrow-foreground color ` +: Set the right arrow foreground color + +`-lab, --left-arrow-background color ` +: Set the left arrow background color + +`-rab, --right-arrow-background color ` +: Set the right arrow background color + +`-cc, --caret-foreground color ` +: Set the caret color + +`-bc, --border-background color ` +: Set the border color + +`-sgr0, --sgr0 color ` +: Set the SGR 0 color + +`-sgr1, --sgr1 color ` +: Set the SGR 1 color + +`-sgr2, --sgr2 color ` +: Set the SGR 2 color + +`-sgr3, --sgr3 color ` +: Set the SGR 3 color + +`-sgr4, --sgr4 color ` +: Set the SGR 4 color + +`-sgr5, --sgr5 color ` +: Set the SGR 5 color + +`-sgr6, --sgr6 color ` +: Set the SGR 6 color + +`-sgr7, --sgr7 color ` +: Set the SGR 7 color + +`-sgr8, --sgr8 color ` +: Set the SGR 8 color + +`-sgr9, --sgr9 color ` +: Set the SGR 9 color + +`-sgr10, --sgr10 color ` +: Set the SGR 10 color + +`-sgr11, --sgr11 color ` +: Set the SGR 11 color + +`-sgr12, --sgr12 color ` +: Set the SGR 12 color + +`-sgr13, --sgr13 color ` +: Set the SGR 13 color + +`-sgr14, --sgr14 color ` +: Set the SGR 14 color + +`-sgr15, --sgr15 color ` +: Set the SGR 15 color + +dmenu compatibility can be achieved using these arguments: + +`-S` +: Don't sort matches + +`-i` +: Use case-insensitive matching + +`-nb color` +: Set the normal background color + +`-nf color` +: Set the normal foreground color + +`-sb color` +: Set the selected background color +`-sf color` +: Set the selected foreground color ## Keybinds diff --git a/spmenu.1 b/spmenu.1 index bd17a82..9490a05 100644 --- a/spmenu.1 +++ b/spmenu.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 3.1 +.\" Automatically generated by Pandoc 3.0.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -48,294 +48,378 @@ spmenu. See a list below for a list. .SS Arguments .PP -Miscellanious: -.IP \[bu] 2 -spmenu -l, \[en]lines line - Set line count to stdin -.IP \[bu] 2 -spmenu -mh, \[en]lineheight height - Set spmenu line height to height -.IP \[bu] 2 -spmenu -mw, \[en]min-width width - Set minimum width to width -.IP \[bu] 2 -spmenu -g, \[en]columns grid - Set the number of grids to grid -.IP \[bu] 2 -spmenu -gc, \[en]generate-cache - Generate image cache -.IP \[bu] 2 -spmenu -ngc, \[en]no-generate-cache - Don\[cq]t generate image cache -.IP \[bu] 2 -spmenu -rw, \[en]relative-width - Enable relative input width -.IP \[bu] 2 -spmenu -nrw, \[en]no-relative-width - Disable relative input width -.IP \[bu] 2 -spmenu -f, \[en]fast - Grabs keyboard before reading stdin -.IP \[bu] 2 -spmenu -F, \[en]fuzzy - Enable fuzzy matching -.IP \[bu] 2 -spmenu -NF, \[en]no-fuzzy - Disable fuzzy matching -.IP \[bu] 2 -spmenu -P, \[en]password - Hide characters -.IP \[bu] 2 -spmenu -Ps, \[en]password-symbol symbol - Set the password symbol to -symbol -.IP \[bu] 2 -spmenu -p, \[en]prompt text - Set spmenu prompt text to text -.IP \[bu] 2 -spmenu -ip, \[en]indent - Indent items to prompt width -.IP \[bu] 2 -spmenu -nip, \[en]no-indent - Don\[cq]t indent items to prompt width -.IP \[bu] 2 -spmenu -a, \[en]alpha - Enable alpha -.IP \[bu] 2 -spmenu -na, \[en]no-alpha - Disable alpha -.IP \[bu] 2 -spmenu -tp, \[en]allow-typing - Allow the user to type -.IP \[bu] 2 -spmenu -nt, \[en]no-allow-typing - Don\[cq]t allow typing, the user must -select an option -.IP \[bu] 2 -spmenu -x, \[en]x-position x offset - Offset spmenu x position by x -offset -.IP \[bu] 2 -spmenu -y, \[en]y-position y offset - Offset spmenu y position by y -offset -.IP \[bu] 2 -spmenu -n, \[en]preselect line - Preselect line in the list of items -.IP \[bu] 2 -spmenu -z, \[en]width width - Width of the spmenu window -.IP \[bu] 2 -spmenu -nmt, \[en]normal-mode-text text - Set normal mode text to text -.IP \[bu] 2 -spmenu -imt, \[en]insert-mode-text text - Set insert mode text to text -.IP \[bu] 2 -spmenu -bw, \[en]border-width width - Set width of the border to width . +You may use long, descriptive arguments or the shorter arguments. +.TP +\f[V]-mh, --lineheight height\f[R] +Set spmenu line height to height +.TP +\f[V]-mw, --min-width width\f[R] +Set minimum width to width +.TP +\f[V]-g, --columns grid\f[R] +Set the number of grids to grid +.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]-rw, --relative-width\f[R] +Enable relative input width +.TP +\f[V]-nrw, --no-relative-width\f[R] +Disable relative input width +.TP +\f[V]-f, --fast\f[R] +Grabs keyboard before reading stdin +.TP +\f[V]-F, --fuzzy\f[R] +Enable fuzzy matching +.TP +\f[V]-NF, --no-fuzzy\f[R] +Disable fuzzy matching +.TP +\f[V]-P, --password\f[R] +Hide characters +.TP +\f[V]-Ps, --password-symbol symbol\f[R] +Set the password symbol to symbol +.TP +\f[V]-p, --prompt text\f[R] +Set spmenu prompt 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]-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]-x, --x-position x offset\f[R] +Offset spmenu x position by x offset +.TP +\f[V]-y, --y-position y offset\f[R] +Offset spmenu y position by y offset +.TP +\f[V]-n, --preselect line\f[R] +Preselect 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]-bw, --border-width width\f[R] +Set width of the border to width . 0 will disable the border -.IP \[bu] 2 -spmenu -so, \[en]sort - Sort matches -.IP \[bu] 2 -spmenu -nso, \[en]no-sort - Don\[cq]t sort matches -.IP \[bu] 2 -spmenu -pri, \[en]priority pri1,pri2,pri3 - Specify a list of items that -take priority -.IP \[bu] 2 -spmenu -s, \[en]case-sensitive - Use case-sensitive matching -.IP \[bu] 2 -spmenu -ns, \[en]case-insensitive - Use case-insensitive matching -.IP \[bu] 2 -spmenu -nm, \[en]normal - Start spmenu in normal mode -.IP \[bu] 2 -spmenu -im, \[en]insert - Start spmenu in insert mode -.IP \[bu] 2 -spmenu -t, \[en]top - Position spmenu at the top of the screen -.IP \[bu] 2 -spmenu -b, \[en]bottom - Position spmenu at the bottom of the screen -.IP \[bu] 2 -spmenu -c, \[en]center - Position spmenu at the center of the screen -.IP \[bu] 2 -spmenu -hm, \[en]hide-mode - Hide mode indicator -.IP \[bu] 2 -spmenu -hmc, \[en]hide-match-count - Hide match count -.IP \[bu] 2 -spmenu -hla, \[en]hide-left-arrow - Hide left arrow -.IP \[bu] 2 -spmenu -hra, \[en]hide-right-arrow - Hide right arrow -.IP \[bu] 2 -spmenu -hpr, \[en]hide-prompt - Hide prompt -.IP \[bu] 2 -spmenu -hc, \[en]hide-cursor - Hide cursor -.IP \[bu] 2 -spmenu -hhl, \[en]hide-highlighting - Hide highlight -.IP \[bu] 2 -spmenu -hi, \[en]hide-image - Hide image -.IP \[bu] 2 -spmenu -sm, \[en]show-mode - Show mode indicator -.IP \[bu] 2 -spmenu -smc, \[en]show-match-count - Show match count -.IP \[bu] 2 -spmenu -sla, \[en]show-left-arrow - Show left arrow -.IP \[bu] 2 -spmenu -sra, \[en]show-right-arrow - Show right arrow -.IP \[bu] 2 -spmenu -spr, \[en]show-prompt - Show prompt -.IP \[bu] 2 -spmenu -sc, \[en]show-cursor - Show cursor -.IP \[bu] 2 -spmenu -shl, \[en]show-highlighting - Show highlight -.IP \[bu] 2 -spmenu -si, \[en]show-image - Show image -.IP \[bu] 2 -spmenu -xrdb, \[en]xrdb - Load .Xresources on runtime -.IP \[bu] 2 -spmenu -nxrdb, \[en]no-xrdb - Don\[cq]t load .Xresources on runtime -.IP \[bu] 2 -spmenu -m, \[en]monitor monitor - Specify a monitor to run spmenu on -.IP \[bu] 2 -spmenu -w, \[en]embed window id - Embed spmenu inside window id -.IP \[bu] 2 -spmenu -H, \[en]hist-file hist file - Specify a path to save the history -to -.IP \[bu] 2 -spmenu -ig, \[en]image-gaps gaps - Set image gaps to gaps -.IP \[bu] 2 -spmenu -lp, \[en]vertical-padding padding - Set the vertical padding -.IP \[bu] 2 -spmenu -hp, \[en]horizontal-padding padding - Set the horizontal padding -.IP \[bu] 2 -spmenu -la, \[en]left-arrow-symbol symbol - Set the left arrow to symbol -.IP \[bu] 2 -spmenu -ra, \[en]right-arrow-symbol symbol - Set the right arrow to -symbol -.IP \[bu] 2 -spmenu -is, \[en]image-size size - Image size -.IP \[bu] 2 -spmenu -it, \[en]image-top - Position the image at the top -.IP \[bu] 2 -spmenu -ib, \[en]image-bottom - Position the image at the bottom -.IP \[bu] 2 -spmenu -ic, \[en]image-center - Position the image in the center -.IP \[bu] 2 -spmenu -itc, \[en]image-topcenter - Position the image in the top center -.IP \[bu] 2 -spmenu -wm, \[en]managed, \[en]x11-client - Spawn spmenu as a window -manager controlled client/window. +.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]-hm, --hide-mode\f[R] +Hide mode indicator +.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]-hc, --hide-cursor\f[R] +Hide cursor +.TP +\f[V]-hhl, --hide-highlighting\f[R] +Hide highlight +.TP +\f[V]-hi, --hide-image\f[R] +Hide image +.TP +\f[V]-sm, --show-mode\f[R] +Show mode indicator +.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]-sc, --show-cursor\f[R] +Show cursor +.TP +\f[V]-shl, --show-highlighting\f[R] +Show highlight +.TP +\f[V]-si, --show-image\f[R] +Show image +.TP +\f[V]-xrdb, --xrdb\f[R] +Load .Xresources on runtime +.TP +\f[V]-nxrdb, --no-xrdb\f[R] +Don\[cq]t load .Xresources on runtime +.TP +\f[V]-m, --monitor monitor\f[R] +Specify a monitor to run spmenu on +.TP +\f[V]-w, --embed window id\f[R] +Embed spmenu inside window id +.TP +\f[V]-H, --hist-file hist file\f[R] +Specify a path to save the history to +.TP +\f[V]-ig, --image-gaps gaps\f[R] +Set image gaps to gaps +.TP +\f[V]-lp, --vertical-padding padding\f[R] +Set the vertical padding +.TP +\f[V]-hp, --horizontal-padding padding\f[R] +Set the horizontal 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]-wm, --managed, --x11-client\f[R] +Spawn spmenu as a window manager controlled client/window. Useful for testing -.IP \[bu] 2 -spmenu -nwm, \[en]unmanaged - Don\[cq]t spawn spmenu as a window manager -controlled client/window. +.TP +\f[V]-nwm, --unmanaged\f[R] +Don\[cq]t spawn spmenu as a window manager controlled client/window. Useful for testing -.IP \[bu] 2 -spmenu -lcfg, \[en]load-config - Load spmenu configuration -(\[ti]/.spmenu or \[ti]/.config/spmenu/spmenurc) -.IP \[bu] 2 -spmenu -ncfg, \[en]no-load-config - Don\[cq]t load spmenu configuration -(\[ti]/.spmenu or \[ti]/.config/spmenu/spmenurc) -.IP \[bu] 2 -spmenu -v, \[en]version - Print spmenu version to stdout +.TP +\f[V]-lcfg, --load-config\f[R] +Load spmenu configuration (\[ti]/.spmenu or +\[ti]/.config/spmenu/spmenurc) +.TP +\f[V]-ncfg, --no-load-config\f[R] +Don\[cq]t load spmenu configuration (\[ti]/.spmenu or +\[ti]/.config/spmenu/spmenurc) +.TP +\f[V]-v, --version\f[R] +Print spmenu version to stdout +.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]-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]-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]-cc, --caret-foreground color\f[R] +Set the caret 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 -Appearance: -.IP \[bu] 2 -spmenu -fn, \[en]font font - Set the spmenu font to font -.IP \[bu] 2 -spmenu -nif, \[en]normal-item-foreground color - Set the normal item -foreground color -.IP \[bu] 2 -spmenu -nib, \[en]normal-item-background color - Set the normal item -background color -.IP \[bu] 2 -spmenu -sif, \[en]selected-item-foreground color - Set the selected item -foreground color -.IP \[bu] 2 -spmenu -sib, \[en]selected-item-background color - Set the selected item -background color -.IP \[bu] 2 -spmenu -npf, \[en]normal-item-priority-foreground color - Set the normal -item (high priority) foreground color -.IP \[bu] 2 -spmenu -npb, \[en]normal-item-priority-background color - Set the normal -item (high priority) background color -.IP \[bu] 2 -spmenu -spf, \[en]selected-item-priority-foreground color - Set the -selected item (high priority) foreground color -.IP \[bu] 2 -spmenu -spb, \[en]selected-item-priority-background color - Set the -selected item (high priority) background color -.IP \[bu] 2 -spmenu -pfg, \[en]prompt-foreground color - Set the prompt foreground -color -.IP \[bu] 2 -spmenu -pbg, \[en]prompt-background color - Set the prompt background -color -.IP \[bu] 2 -spmenu -ifg, \[en]input-foreground color - Set input foreground color -.IP \[bu] 2 -spmenu -ibg, \[en]input-background color - Set input background color -.IP \[bu] 2 -spmenu -mnbg, \[en]menu-background color - Set the menu background color -.IP \[bu] 2 -spmenu -nhf, \[en]normal-highlight-foreground color - Set the normal -highlight foreground color -.IP \[bu] 2 -spmenu -nhb, \[en]normal-highlight-background color - Set the normal -highlight background color -.IP \[bu] 2 -spmenu -shf, \[en]selected-highlight-foreground color - Set the selected -highlight foreground color -.IP \[bu] 2 -spmenu -shb, \[en]selected-highlight-background color - Set the selected -highlight background color -.IP \[bu] 2 -spmenu -nfg, \[en]number-foreground color - Set the foreground color for -the match count -.IP \[bu] 2 -spmenu -nbg, \[en]number-background color - Set the background color for -the match count -.IP \[bu] 2 -spmenu -mfg, \[en]mode-foreground color - Set the foreground color for -the mode indicator -.IP \[bu] 2 -spmenu -mbg, \[en]mode-background color - Set the background color for -the mode indicator -.IP \[bu] 2 -spmenu -laf, \[en]left-arrow-foreground color - Set the left arrow -foreground color -.IP \[bu] 2 -spmenu -raf, \[en]right-arrow-foreground color - Set the right arrow -foreground color -.IP \[bu] 2 -spmenu -lab, \[en]left-arrow-background color - Set the left arrow -background color -.IP \[bu] 2 -spmenu -rab, \[en]right-arrow-background color - Set the right arrow -background color -.IP \[bu] 2 -spmenu -cc, \[en]caret-foreground color - Set the caret color -.IP \[bu] 2 -spmenu -bc, \[en]border-background color - Set the border color -.IP \[bu] 2 -spmenu -sgr0, \[en]sgr0 color - Set the SGR 0 color -.IP \[bu] 2 -spmenu -sgr1, \[en]sgr1 color - Set the SGR 1 color -.IP \[bu] 2 -spmenu -sgr2, \[en]sgr2 color - Set the SGR 2 color -.IP \[bu] 2 -spmenu -sgr3, \[en]sgr3 color - Set the SGR 3 color -.IP \[bu] 2 -spmenu -sgr4, \[en]sgr4 color - Set the SGR 4 color -.IP \[bu] 2 -spmenu -sgr5, \[en]sgr5 color - Set the SGR 5 color -.IP \[bu] 2 -spmenu -sgr6, \[en]sgr6 color - Set the SGR 6 color -.IP \[bu] 2 -spmenu -sgr7, \[en]sgr7 color - Set the SGR 7 color -.IP \[bu] 2 -spmenu -sgr8, \[en]sgr8 color - Set the SGR 8 color -.IP \[bu] 2 -spmenu -sgr9, \[en]sgr9 color - Set the SGR 9 color -.IP \[bu] 2 -spmenu -sgr10, \[en]sgr10 color - Set the SGR 10 color -.IP \[bu] 2 -spmenu -sgr11, \[en]sgr11 color - Set the SGR 11 color -.IP \[bu] 2 -spmenu -sgr12, \[en]sgr12 color - Set the SGR 12 color -.IP \[bu] 2 -spmenu -sgr13, \[en]sgr13 color - Set the SGR 13 color -.IP \[bu] 2 -spmenu -sgr14, \[en]sgr14 color - Set the SGR 14 color -.IP \[bu] 2 -spmenu -sgr15, \[en]sgr15 color - Set the SGR 15 color -.PP -There are also extra arguments recognized for dmenu compatibility. -These are: -.IP \[bu] 2 -spmenu -S - Don\[cq]t sort matches -.IP \[bu] 2 -spmenu -i - Use case-insensitive matching -.IP \[bu] 2 -spmenu -nb color - Set the normal background color -.IP \[bu] 2 -spmenu -nf color - Set the normal foreground color -.IP \[bu] 2 -spmenu -sb color - Set the selected background color -.IP \[bu] 2 -spmenu -sf color - Set the selected foreground color +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 \f[V]-sf color\f[R] +Set the selected foreground color .SS Keybinds .PP See \f[V]keybinds.h\f[R] for a list.