wmenu.1.scd - wmenu - [fork] efficient dynamic menu for wayland
(HTM) git clone https://git.drkhsh.at/wmenu.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
wmenu.1.scd (3054B)
---
1 WMENU(1)
2
3 # NAME
4
5 wmenu - dynamic menu for Wayland
6
7 # SYNOPSIS
8
9 *wmenu* [-biPv] \
10 [-f _font_] \
11 [-l _lines_] \
12 [-w _width_] \
13 [-o _output_] \
14 [-p _prompt_] \
15 [-N _color_] [-n _color_] \
16 [-M _color_] [-m _color_] \
17 [-S _color_] [-s _color_]
18
19 *wmenu-run* ...
20
21 # DESCRIPTION
22
23 *wmenu* is a dynamic menu for Wayland, which reads a list of newline-separated
24 items from stdin. When the user selects an item and presses Return, their choice
25 is printed to stdout and wmenu terminates. Entering text will narrow the items
26 to those matching the tokens in the input.
27
28 *wmenu-run* is a special invocation of wmenu which lists programs in the user's
29 $PATH and runs the result.
30
31 # OPTIONS
32
33 *-b*
34 wmenu appears at the bottom of the screen.
35
36 *-i*
37 wmenu matches menu items case insensitively.
38
39 *-P*
40 wmenu will not directly display the keyboard input, but instead replace it
41 with asterisks.
42
43 *-v*
44 prints version information to stdout, then exits.
45
46 *-f* _font_
47 defines the font used. For more information, see
48 https://docs.gtk.org/Pango/type_func.FontDescription.from_string.html
49
50 *-l* _lines_
51 wmenu lists items vertically, with the given number of lines.
52
53 *-w* _width_
54 the width of the window will be constrained to this value.
55
56 *-o* _output_
57 wmenu is displayed on the output with the given name.
58
59 *-p* _prompt_
60 defines the prompt to be displayed to the left of the input field.
61
62 *-N* _RRGGBB[AA]_
63 defines the normal background color.
64
65 *-n* _RRGGBB[AA]_
66 defines the normal foreground color.
67
68 *-M* _RRGGBB[AA]_
69 defines the prompt background color.
70
71 *-m* _RRGGBB[AA]_
72 defines the prompt foreground color.
73
74 *-S* _RRGGBB[AA]_
75 defines the selection background color.
76
77 *-s* _RRGGBB[AA]_
78 defines the selection foreground color.
79
80 # USAGE
81
82 wmenu is completely controlled by the keyboard. Items are selected using the
83 arrow keys, page up, page down, home, and end.
84
85 *Tab*
86 Copy the selected item to the input field.
87
88 *Return*
89 Confirm selection. Prints the selected item to stdout and exits, returning
90 success.
91
92 *Ctrl-Return*
93 Confirm selection. Prints the selected item to stdout and continues.
94
95 *Shift-Return*
96 Confirm input. Prints the input text to stdout and exits, returning success.
97
98 *Escape*
99 Exit without selecting an item, returning failure.
100
101 *Ctrl-Left*
102 Move cursor to the start of the current word.
103
104 *Ctrl-Right*
105 Move cursor to the end of the current word.
106
107 |[ *C-a*
108 :< Home
109
110 |[ *C-b*
111 :< Left
112
113 |[ *C-c*
114 :< Escape
115
116 |[ *C-d*
117 :< Delete
118
119 |[ *C-e*
120 :< End
121
122 |[ *C-f*
123 :< Right
124
125 |[ *C-g*
126 :< Escape
127
128 |[ *C-[*
129 :< Escape
130
131 |[ *C-h*
132 :< Backspace
133
134 |[ *C-i*
135 :< Tab
136
137 |[ *C-j*
138 :< Return
139
140 |[ *C-J*
141 :< Shift-Return
142
143 |[ *C-k*
144 :< Delete line right
145
146 |[ *C-m*
147 :< Return
148
149 |[ *C-M*
150 :< Shift-Return
151
152 |[ *C-n*
153 :< Down
154
155 |[ *C-p*
156 :< Up
157
158 |[ *C-u*
159 :< Delete line left
160
161 |[ *C-w*
162 :< Delete word left
163
164 |[ *C-Y*
165 :< Paste from Wayland clipboard
166
167 |[ *M-b*
168 :< Move cursor to the start of the current word
169
170 |[ *M-f*
171 :< Move cursor to the end of the current word
172
173 |[ *M-g*
174 :< Home
175
176 |[ *M-G*
177 :< End
178
179 |[ *M-h*
180 :< Up
181
182 |[ *M-j*
183 :< Page down
184
185 |[ *M-k*
186 :< Page up
187
188 |[ *M-l*
189 :< Down
190