diff options
Diffstat (limited to 'docs/wmenu.1.scd')
-rw-r--r-- | docs/wmenu.1.scd | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/wmenu.1.scd b/docs/wmenu.1.scd new file mode 100644 index 0000000..2d6138d --- /dev/null +++ b/docs/wmenu.1.scd @@ -0,0 +1,86 @@ +wmenu(1) + +# NAME + +wmenu - dynamic menu for Wayland + +# SYNOPSIS + +*wmenu* [-biv] \ + [-f _font_] \ + [-l _lines_] \ + [-o _output_] \ + [-p _prompt_] \ + [-N _color_] [-n _color_] \ + [-M _color_] [-m _color_] \ + [-S _color_] [-s _color_] + +# DESCRIPTION + +wmenu is a dynamic menu for Wayland, which reads a list of newline-separated +items from stdin. When the user selects an item and presses Return, their choice +is printed to stdout and wmenu terminates. Entering text will narrow the items +to those matching the tokens in the input. + +# OPTIONS + +*-b* + wmenu appears at the bottom of the screen. + +*-i* + wmenu matches menu items case insensitively. + +*-v* + prints version information to stdout, then exits. + +*-f* _font_ + defines the font used. For more information, see + https://docs.gtk.org/Pango/type_func.FontDescription.from_string.html + +*-l* _lines_ + wmenu lists items vertically, with the given number of lines. + +*-o* _output_ + wmenu is displayed on the output with the given name. + +*-p* _prompt_ + defines the prompt to be displayed to the left of the input field. + +*-N* _RRGGBB[AA]_ + defines the normal background color. + +*-n* _RRGGBB[AA]_ + defines the normal foreground color. + +*-M* _RRGGBB[AA]_ + defines the prompt background color. + +*-m* _RRGGBB[AA]_ + defines the prompt foreground color. + +*-S* _RRGGBB[AA]_ + defines the selection background color. + +*-s* _RRGGBB[AA]_ + defines the selection foreground color. + +# USAGE + +wmenu is completely controlled by the keyboard. Items are selected using the +arrow keys, page up, page down, home, and end. + +*Tab* + Copy the selected item to the input field. + +*Return* + Confirm selection. Prints the selected item to stdout and exits, returning + success. + +*Ctrl-Return* + Confirm selection. Prints the selected item to stdout and continues. + +*Shift-Return* + Confirm input. Prints the input text to stdout and exits, returning success. + +*Escape* + Exit without selecting an item, returning failure. |