spmenu/docs/spmenu.conf
2023-04-29 22:53:00 +02:00

688 lines
25 KiB
Plaintext

/* spmenu default configuration file
*
* Copy to ~/.config/spmenu/spmenu.conf to use.
* Note that you can @include other config files if you want
*
* Arguments will always override options in this configuration file.
*
* Example: @include "config.conf"
*/
spmenu = {
/* General window options */
window = ( { position = 2; // Menu position (0: Bottom, 1: Top, 2: Center)
border = 0; // Window border size (px)
margin-vertical = 0; // Inner vertical padding (px)
margin-horizontal = 0; // Inner horizontal padding (px)
padding-vertical = 0; // Outer vertical padding (px)
padding-horizontal = 0; // Outer horizontal padding (px)
x = 0; // X position offset (px)
y = 0; // Y position offset (px)
width = 0; // Width when X and/or Y offset is set, 0 is the default (px)
monitor = -1; // Monitor to spawn spmenu on, (-1, 0, 1, ...)
managed = 0; // Allow your window manager to manage spmenu as a window (0/1)
alpha = 1; // Enable alpha/transparency (0/1)
} );
/* X11 properties */
properties = ( { class = "spmenu"; // _WM_CLASS property, for compatibility you may want to set it to 'dmenu'. (text)
dock = 1; // Set _NET_WM_WINDOW_TYPE_DOCK (0/1)
} );
/* Text */
text = ( { font = "Noto Sans Mono 8"; // Font to use for all text (text)
padding = 0; // Horizontal padding around the text (px)
leftarrow = "<"; // Left arrow text (text)
rightarrow = ">"; // Right arrow text (text)
password = "*"; // Password character (text)
prompt = ""; // Prompt text (text)
input = ""; // Input text (text)
capslockon = "Caps Lock"; // Caps Lock On text (text)
capslockoff = ""; // Caps Lock Off text (text)
} );
/* Colors */
color = ( { itemnormfg = "#bbbbbb"; // Normal item foreground color (#RRGGBB)
itemnormbg = "#222222"; // Normal item background color (#RRGGBB)
itemselfg = "#eeeeee"; // Selected item foreground color (#RRGGBB)
itemselbg = "#35638A"; // Selected item background color (#RRGGBB)
itemnormprifg = "#bbbbbb"; // Normal priority item foreground color (#RRGGBB)
itemnormpribg = "#222222"; // Normal priority item background color (#RRGGBB)
itemselprifg = "#eeeeee"; // Selected priority item foreground color (#RRGGBB)
itemselpribg = "#35638A"; // Selected priority item background color (#RRGGBB)
inputfg = "#eeeeee"; // Input foreground color (#RRGGBB)
inputbg = "#222222"; // Input background color (#RRGGBB)
menu = "#222222"; // Menu color (#RRGGBB)
promptfg = "#eeeeee"; // Prompt foreground color (#RRGGBB)
promptbg = "#35526b"; // Prompt background color (#RRGGBB)
larrowfg = "#bbbbbb"; // Left arrow foreground color (#RRGGBB)
larrowbg = "#222222"; // Left arrow background color (#RRGGBB)
rarrowfg = "#bbbbbb"; // Right arrow foreground color (#RRGGBB)
rarrowbg = "#222222"; // Right arrow background color (#RRGGBB)
hlnormfg = "#ffffff"; // Normal highlight foreground color (#RRGGBB)
hlnormbg = "#000000"; // Normal highlight background color (#RRGGBB)
hlselfg = "#ffffff"; // Selected highlight foreground color (#RRGGBB)
hlselbg = "#000000"; // Selected highlight background color (#RRGGBB)
numfg = "#ffffff"; // Match count foreground color (#RRGGBB)
numbg = "#2d3856"; // Match count background color (#RRGGBB)
modefg = "#ffffff"; // Mode indicator foreground color (#RRGGBB)
modebg = "#35638A"; // Mode indicator background color (#RRGGBB)
capsfg = "#ffffff"; // Caps lock indicator foreground color (#RRGGBB)
capsbg = "#45638A"; // Caps lock indicator background color (#RRGGBB)
border = "#35638A"; // Border color (#RRGGBB)
caretfg = "#ffffff"; // Caret (cursor) foreground color (#RRGGBB)
caretbg = "#222222"; // Caret (cursor) background color (#RRGGBB)
sgr0 = "#000000"; // SGR 0 color (#RRGGBB)
sgr1 = "#7f0000"; // SGR 1 color (#RRGGBB)
sgr2 = "#007f00"; // SGR 2 color (#RRGGBB)
sgr3 = "#7f7f00"; // SGR 3 color (#RRGGBB)
sgr4 = "#00007f"; // SGR 4 color (#RRGGBB)
sgr5 = "#7f007f"; // SGR 5 color (#RRGGBB)
sgr6 = "#007f7f"; // SGR 6 color (#RRGGBB)
sgr7 = "#cccccc"; // SGR 7 color (#RRGGBB)
sgr8 = "#333333"; // SGR 8 color (#RRGGBB)
sgr9 = "#ff0000"; // SGR 9 color (#RRGGBB)
sgr10 = "#00ff00"; // SGR 10 color (#RRGGBB)
sgr11 = "#ffff00"; // SGR 11 color (#RRGGBB)
sgr12 = "#0000ff"; // SGR 12 color (#RRGGBB)
sgr13 = "#ff00ff"; // SGR 13 color (#RRGGBB)
sgr14 = "#00ffff"; // SGR 14 color (#RRGGBB)
sgr15 = "#ffffff"; // SGR 15 color (#RRGGBB)
coloritems = 1; // Color the selected item (0/1)
sgr = 1; // Interpret SGR sequences (0/1)
} );
/* Alpha */
alpha = ( { itemnormfg = 255; // Normal item foreground alpha (0-255)
itemnormbg = 200; // Normal item background alpha (0-255)
itemselfg = 255; // Selected item foreground alpha (0-255)
itemselbg = 200; // Selected item background alpha (0-255)
itemnormprifg = 255; // Normal priority item foreground alpha (0-255)
itemnormpribg = 200; // Normal priority item background alpha (0-255)
itemselprifg = 255; // Selected priority item foreground alpha (0-255)
itemselpribg = 200; // Selected priority item background alpha (0-255)
inputfg = 255; // Input foreground alpha (0-255)
inputbg = 200; // Input background alpha (0-255)
menu = 200; // Menu alpha (0-255)
promptfg = 255; // Prompt foreground alpha (0-255)
promptbg = 200; // Prompt background alpha (0-255)
larrowfg = 255; // Left arrow foreground alpha (0-255)
larrowbg = 200; // Left arrow background alpha (0-255)
rarrowfg = 255; // Right arrow foreground alpha (0-255)
rarrowbg = 200; // Right arrow background alpha (0-255)
hlnormfg = 255; // Normal highlight foreground alpha (0-255)
hlnormbg = 200; // Normal highlight background alpha (0-255)
hlselfg = 255; // Selected highlight foreground alpha (0-255)
hlselbg = 200; // Selected highlight background alpha (0-255)
numfg = 255; // Match count foreground alpha (0-255)
numbg = 200; // Match count background alpha (0-255)
border = 255; // Border alpha (0-255)
caretfg = 255; // Caret (cursor) foreground alpha (0-255)
caretbg = 200; // Caret (cursor) background alpha (0-255)
modefg = 255; // Mode indicator foreground alpha (0-255)
modebg = 200; // Mode indicator background alpha (0-255)
capsfg = 255; // Caps Lock indicator foreground alpha (0-255)
capsbg = 200; // Caps Lock indicator background alpha (0-255)
} );
/* Powerline options */
powerline = ( { promptstyle = 0; // Prompt powerline style (0: >, 1: \)
matchcountstyle = 0; // Match count powerline style (0: <, 1: /)
modestyle = 0; // Mode indicator powerline style (0: <, 1: /)
capsstyle = 0; // Caps lock indicator powerline style (0: <, 1: /)
prompt = 1; // Enable prompt powerline (0/1)
matchcount = 1; // Enable match count powerline (0/1)
mode = 1; // Enable mode indicator powerline (0/1)
caps = 1; // Enable caps lock indicator powerline (0/1)
} );
/* Hide options */
hide = ( { input = 0; // Hide input (0/1)
larrow = 0; // Hide left arrow (0/1)
rarrow = 0; // Hide right arrow (0/1)
items = 0; // Hide items (0/1)
prompt = 0; // Hide prompt (0/1)
powerline = 0; // Hide powerline (0/1)
caret = 0; // Hide caret (cursor) (0/1)
highlight = 0; // Hide highlighting (0/1)
matchcount = 0; // Hide match count (0/1)
mode = 0; // Hide mode indicator (0/1)
caps = 0; // Hide caps lock indicator (0/1)
image = 0; // Hide images (0/1)
} );
/* Match options */
match = ( { sort = 1; // Sort items (0/1)
casesensitive = 0; // Enable case sensitivity when matching (0/1)
fuzzy = 1; // Enable fuzzy finding (0/1)
preselected = 0; // Preselect an item, 0 is the first item (number)
accuratewidth = 1; // Enable accurate width, could be noticeably slower in some cases (0/1)
delimiters = " "; // Word delimiter, used to delete words (text)
} );
/* Line options */
line = ( { height = 1; // Height of each line (px)
lines = 0; // Number of lines (number)
columns = 10; // Number of columns (number)
indentitems = 1; // Indent items to prompt width (0/1)
} );
/* History options */
history = ( { max = 64; // Max number of entries (number)
duplicate = 0; // Save duplicate entries (0/1)
} );
/* Centered options */
center = ( { width = 1000; // Menu width when centered (px)
} );
/* Image options */
image = ( { width = 200; // Image width (px)
height = 200; // Image height (px)
gaps = 0; // Image gaps (px)
position = 0; // Image position (0: Top, 1: Bottom, 2: Center, 3: Top center)
cache = 1; // Cache images (0/1)
maxcache = 512; // Max image width/height to cache (px)
} );
/* .Xresources/Xrdb options */
xrdb = ( { xresources = 1; // Load .Xresources on startup (0/1)
global = 1; // Read global .Xresources colors, programs like Pywal use this. (*.color0, *.color1, etc.) (0/1)
} );
/* Input options */
input = ( { fast = 1; // Grab keyboard before matching entries (0/1)
type = 1; // Allow typing
password = 0; // Don't read standard input and replace all characters with the password character (0/1)
} );
/* Mode options */
mode = ( { default = 0; // Mode to start spmenu in (0: Normal mode, 1: Insert mode)
normal_text = "Normal"; // Normal mode text (text)
insert_text = "Insert"; // Insert mode text (text)
} );
/* Pango markup options */
pango = ( { item = 1; // Interpret Pango markup for items (0/1)
highlight = 1; // Intepret Pango markup for highlighting (0/1)
prompt = 1; // Interpret Pango markup for the prompt (0/1)
input = 1; // Interpret Pango markup for the input (0/1)
leftarrow = 0; // Interpret Pango markup for the left arrow (0/1)
rightarrow = 0; // Interpret Pango markup for the right arrow (0/1)
numbers = 0; // Interpret Pango markup for the match count (0/1)
mode = 0; // Interpret Pango markup for the mode indicator (0/1)
caps = 0; // Interpret Pango markup for the caps lock indicator (0/1)
password = 0; // Interpret Pango markup for password input (0/1)
} );
/* Mouse bindings
*
* See https://spmenu.speedie.site/index.php/Configurable+keybindings for a list of valid options.
*/
mouse = ( // Left click on input: Clear the input
{ click = "clickinput";
modifier = "None";
button = "Left Click";
function = "clear";
argument = "0";
},
// Left click on prompt: Clear the input
{ click = "clickprompt";
modifier = "None";
button = "Left Click";
function = "clear";
argument = "0";
},
// Left click on the mode indicator: Toggle mode
{ click = "clickmode";
modifier = "None";
button = "Left Click";
function = "switchmode";
argument = "0";
},
// Click on the match count: Toggle viewing history buffer
{ click = "clicknumber";
modifier = "None";
button = "Left Click";
function = "viewhist";
argument = "0";
},
// Left click on an item: Select it
{ click = "clickselitem";
modifier = "None";
button = "Left Click";
function = "None";
argument = "0";
},
{ ignoreglobalmouse = 1; // Ignore hardcoded mouse binds (0/1)
} );
/* Keys
*
* See https://spmenu.speedie.site/index.php/Configurable+keybindings for a list of valid options.
*/
keys = ( // Enter: Select item
{ mode = -1;
modifier = "None";
key = "Enter";
function = "selectitem";
argument = "+1";
},
// Shift+Enter: Select input
{ mode = -1;
modifier = "Shift";
key = "Enter";
function = "selectitem";
argument = "0";
},
// Tab: Tab complete
{ mode = -1;
modifier = "None";
key = "Tab";
function = "complete";
argument = "0";
},
// Ctrl+v: Paste from clipboard
{ mode = -1;
modifier = "Ctrl";
key = "v";
function = "paste";
argument = "2";
},
// Ctrl+Shift+v: Paste from selection
{ mode = -1;
modifier = "Ctrl+Shift";
key = "v";
function = "paste";
argument = "1";
},
// Backspace: Backspace
{ mode = -1;
modifier = "None";
key = "Backspace";
function = "backspace";
argument = "0";
},
// Ctrl+Backspace: Delete word
{ mode = -1;
modifier = "Ctrl";
key = "Backspace";
function = "deleteword";
argument = "0";
},
// Ctrl+Left: Move caret (cursor) one word to the left
{ mode = -1;
modifier = "Ctrl";
key = "Left";
function = "moveword";
argument = "-1";
},
// Ctrl+Right: Move caret (cursor) one word to the right
{ mode = -1;
modifier = "Ctrl";
key = "Right";
function = "moveword";
argument = "+1";
},
// Left: Move caret (cursor) one character to the left
{ mode = -1;
modifier = "None";
key = "Left";
function = "movecursor";
argument = "-1";
},
// Right: Move caret (cursor) one character to the right
{ mode = -1;
modifier = "None";
key = "Right";
function = "movecursor";
argument = "+1";
},
// Ctrl+Shift+p: Open profile menu
{ mode = -1;
modifier = "Ctrl+Shift";
key = "p";
function = "setprofile";
argument = "0";
},
// Escape: Switch mode
{ mode = 1;
modifier = "None";
key = "Esc";
function = "switchmode";
argument = "0";
},
// i: Switch mode
{ mode = 0;
modifier = "None";
key = "i";
function = "switchmode";
argument = "0";
},
// /: Switch mode
{ mode = 0;
modifier = "None";
key = "/";
function = "switchmode";
argument = "0";
},
// Ctrl+=: Increase image size by 1
{ mode = 0;
modifier = "Ctrl";
key = "=";
function = "setimgsize";
argument = "+1";
},
// Ctrl+-: Decrease image size by 1
{ mode = 0;
modifier = "Ctrl";
key = "-";
function = "setimgsize";
argument = "-1";
},
// -: Increase image size by 10
{ mode = 0;
modifier = "None";
key = "=";
function = "setimgsize";
argument = "+10";
},
// =: Decrease image size by 10
{ mode = 0;
modifier = "None";
key = "-";
function = "setimgsize";
argument = "-10";
},
// Shift+=: Increase image size by 100
{ mode = 0;
modifier = "Shift";
key = "=";
function = "setimgsize";
argument = "+100";
},
// Shift+-: Decrease image size by 100
{ mode = 0;
modifier = "Shift";
key = "-";
function = "setimgsize";
argument = "-100";
},
// Shift+0: Set image size to the default
{ mode = 0;
modifier = "Shift";
key = "0";
function = "defaultimg";
argument = "0";
},
// r: Rotate image
{ mode = 0;
modifier = "None";
key = "r";
function = "rotateimg";
argument = "0";
},
// p: Toggle image position
{ mode = 0;
modifier = "None";
key = "p";
function = "setimgpos";
argument = "+1";
},
// Ctrl+1: Decrease image gaps by 1
{ mode = 0;
modifier = "Ctrl";
key = "1";
function = "setimggaps";
argument = "-1";
},
// Ctrl+2: Increase image gaps by 1
{ mode = 0;
modifier = "Ctrl";
key = "2";
function = "setimggaps";
argument = "+1";
},
// 1: Decrease image gaps by 10
{ mode = 0;
modifier = "None";
key = "1";
function = "setimggaps";
argument = "-10";
},
// 2: Increase image gaps by 10
{ mode = 0;
modifier = "None";
key = "2";
function = "setimggaps";
argument = "+10";
},
// Shift+1: Decrease image gaps by 100
{ mode = 0;
modifier = "Shift";
key = "1";
function = "setimggaps";
argument = "-100";
},
// Shift+2: Increase image gaps by 100
{ mode = 0;
modifier = "Shift";
key = "2";
function = "setimggaps";
argument = "+100";
},
// t: Toggle image
{ mode = 0;
modifier = "None";
key = "t";
function = "toggleimg";
argument = "0";
},
// h: Flip image horizontally
{ mode = 0;
modifier = "None";
key = "h";
function = "flipimg";
argument = "1";
},
// v: Flip image vertically
{ mode = 0;
modifier = "None";
key = "v";
function = "flipimg";
argument = "0";
},
// k: Move up 1 item
{ mode = 0;
modifier = "None";
key = "k";
function = "moveup";
argument = "0";
},
// j: Move down 1 item
{ mode = 0;
modifier = "None";
key = "j";
function = "movedown";
argument = "0";
},
// h: Move left 1 item
{ mode = 0;
modifier = "None";
key = "h";
function = "moveleft";
argument = "0";
},
// l: Move right 1 item
{ mode = 0;
modifier = "None";
key = "l";
function = "moveright";
argument = "0";
},
// Ctrl+u: Move up 5 items
{ mode = 0;
modifier = "Ctrl";
key = "u";
function = "moveup";
argument = "5";
},
// Ctrl+d: Move down 5 items
{ mode = 0;
modifier = "Ctrl";
key = "d";
function = "movedown";
argument = "5";
},
// Ctrl+k: Increase lines by 1
{ mode = 0;
modifier = "Ctrl";
key = "k";
function = "setlines";
argument = "+1";
},
// Ctrl+j: Decrease lines by 1
{ mode = 0;
modifier = "Ctrl";
key = "j";
function = "setlines";
argument = "-1";
},
// Ctrl+Alt+Shift+k: Increase lines by 5
{ mode = 0;
modifier = "Ctrl+Alt+Shift";
key = "k";
function = "setlines";
argument = "+5";
},
// Ctrl+Alt+Shift+j: Decrease lines by 5
{ mode = 0;
modifier = "Ctrl+Alt+Shift";
key = "j";
function = "setlines";
argument = "-5";
},
// Ctrl+l: Increase columns by 1
{ mode = 0;
modifier = "Ctrl";
key = "l";
function = "setcolumns";
argument = "+1";
},
// Ctrl+h: Decrease columns by 1
{ mode = 0;
modifier = "Ctrl";
key = "h";
function = "setcolumns";
argument = "-1";
},
// Ctrl+Alt+Shift+h: Increase columns by 5
{ mode = 0;
modifier = "Ctrl+Alt+Shift";
key = "h";
function = "setcolumns";
argument = "+5";
},
// Ctrl+Alt+Shift+l: Decrease columns by 5
{ mode = 0;
modifier = "Ctrl+Alt+Shift";
key = "l";
function = "setcolumns";
argument = "-5";
},
// Ctrl+u: Toggle highlighting
{ mode = 0;
modifier = "None";
key = "u";
function = "togglehighlight";
argument = "0";
},
// Ctrl+h: Toggle viewing history buffer
{ mode = 0;
modifier = "Ctrl+Shift";
key = "h";
function = "viewhist";
argument = "0";
},
// d: Clear the input
{ mode = 0;
modifier = "None";
key = "d";
function = "clear";
argument = "0";
},
// c: Clear the input and enter insert mode
{ mode = 0;
modifier = "None";
key = "c";
function = "clearins";
argument = "0";
},
// Esc: Exit
{ mode = 0;
modifier = "None";
key = "Esc";
function = "quit";
argument = "0";
},
// Home: Move to the start
{ mode = 0;
modifier = "None";
key = "Home";
function = "movestart";
argument = "0";
},
// End: Move to the end
{ mode = 0;
modifier = "None";
key = "End";
function = "moveend";
argument = "0";
},
// g: Move to the start
{ mode = 0;
modifier = "None";
key = "g";
function = "movestart";
argument = "0";
},
// Shift+g: Move to the end
{ mode = 0;
modifier = "Shift";
key = "g";
function = "moveend";
argument = "0";
},
// Next: Move to the next entry (redo)
{ mode = 0;
modifier = "None";
key = "Next";
function = "movenext";
argument = "0";
},
// Prior: Move to the previous entry (undo)
{ mode = 0;
modifier = "None";
key = "Prior";
function = "moveprev";
argument = "0";
},
// Alt+p: Navigate to the previous entry in the history buffer
{ mode = 0;
modifier = "Alt";
key = "p";
function = "navhistory";
argument = "-1";
},
// Alt+n: Navigate to the next entry in the history buffer
{ mode = 0;
modifier = "Alt";
key = "n";
function = "navhistory";
argument = "+1";
},
{ ignoreglobalkeys = 1; // Ignore hardcoded keybinds (0/1)
} ),
};