1 MYMENU(1) - General Commands Manual
2 
3 # NAME
4 
5 **mymenu** - simple menu for XOrg
6 
7 # SYNOPSIS
8 
9 **mymenu**
10 \[**-hva**]
11 \[**-p** *prompt*]
12 \[**-x** *coord*]
13 \[**-y** *coord*]
14 \[**-w** *width*]
15 \[**-h** *height*]
16 \[**-P** *padding*]
17 \[**-l** *layout*]
18 \[**-f** *font*]
19 \[**-b** *borders*]
20 \[**-B** *color*]
21 \[**-t** *color*]
22 \[**-T** *color*]
23 \[**-c** *color*]
24 \[**-C** *color*]
25 \[**-s** *color*]
26 \[**-S** *color*]
27 
28 # DESCRIPTION
29 
30 The
31 **mymenu**
32 utility a simple graphical menu for XOrg. It read the items from
33 **stdin**
34 and print the user selection to
35 **stdout**
36 on exit.
37 
38 The following options are available and take the maximum precedence
39 over the (respective) ones defined in the
40 **X Resource Database**
41 
42 **-h**
43 
44 > Print a small usage message to stderr.
45 
46 **-v**
47 
48 > Print version and exit.
49 
50 **-a**
51 
52 > The first completion (if any) is always selected. This is like dmenu.
53 
54 **-p** *prompt*
55 
56 > Override the prompt
57 
58 **-x** *val*
59 
60 > Override the positioning on the X axis, parsed as the resource MyMenu.x
61 
62 **-y** *val*
63 
64 > Override the positioning on the Y axis, parsed as the resource MyMenu.y
65 
66 **-P** *padding*
67 
68 > Override the padding. See the MyMenu.padding resource.
69 
70 **-l** *layout*
71 
72 > Override the layout. Parsed as MyMenu.layout.
73 
74 **-f** *font*
75 
76 > Override the font. See MyMenu.font.
77 
78 **-w** *val*
79 
80 > Override the width. Parsed as MyMenu.width.
81 
82 **-h** *val*
83 
84 > Override the height. Parsed as MyMenu.height.
85 
86 **-b** *borders*
87 
88 > Override the borders size. Parsed as MyMenu.border.size.
89 
90 **-B** *colors*
91 
92 > Override the borders color. Parsed as MyMenu.border.color.
93 
94 **-t** *color*
95 
96 > Override the prompt foreground color. See MyMenu.prompt.foreground.
97 
98 **-T** *color*
99 
100 > Override the prompt background color. See MyMenu.prompt.background.
101 
102 **-c** *color*
103 
104 > Override the completion foreground color. See MyMenu.completion.foreground.
105 
106 **-C** *color*
107 
108 > Override the completion background color. See MyMenu.completion.background.
109 
110 **-s** *color*
111 
112 > Override the highlighted completion foreground color. See MyMenu.completion\_highlighted.foreground.
113 
114 **-S** *color*
115 
116 > Override the highlighted completion background color. See MyMenu.completion\_highlighted.background.
117 
118 # RESOURCES
119 
120 MyMenu.font
121 
122 > The font name to use. By default is set to "fixed" if compiled without
123 > Xft(3) support, "monospace" otherwise. Without Xft(3) only bitmap font
124 > are supported.
125 
126 MyMenu.layout
127 
128 > The layout of the menu. The possible values are "horizontal" and
129 > "vertical", with the default being "horizontal". Every other value
130 > than "horizontal" is treated like "vertical", but this is kinda an
131 > implementation detail and not something to be relied on, since in the
132 > future other layout could be added as well.
133 
134 Mymenu.prompt
135 
136 > A string that is rendered before the user input. Default to "$ ".
137 
138 MyMenu.width
139 
140 > The width of the menu. If a numeric value is given (e.g. 400) is
141 > interpreted as pixel, if it ends with a percentage symbol \`%'
142 > (e.g. 40%) the relative percentage will be computed (relative to the
143 > monitor width).
144 
145 MyMenu.height
146 
147 > The height of the menu. Like MyMenu.width if a numeric value is given
148 > is interpreted as pixel, if it ends with a percentage symbol \`%' the
149 > relative percentage will be computed (relative to the monitor height).
150 
151 MyMenu.x
152 
153 > The X coordinate of the topmost left corner of the window. Much like
154 > MyMenu.height and MyMenu.width both a pixel dimension and percentage
155 > could be supplied. In addition to it, some special value can be used.
156 
157 > start
158 
159 > > Alias for 0;
160 
161 > middle
162 
163 > > Compute the correct value to make sure that mymenu will be
164 > > horizontally centered;
165 
166 > end
167 
168 > > Compute the correct value to make sure that mymenu will be right
169 > > aligned.
170 
171 MyMenu.y
172 
173 > The Y coordinate of the topmost left corner of the window. Like the X
174 > coordinate a pixel dimension, percentage dimension or the special
175 > value "start", "middle", "end" could be supplied.
176 
177 MyMenu.padding
178 
179 > Change the padding. In the horizontal layout the padding is the space
180 > between the rectangle of the completion and the text as well as the
181 > space between the prompt and the first completion. In the horizontal
182 > layout the padding is the horizontal spacing between the window edge
183 > and the text as well as the space up and down the text within the
184 > completion. The default value is 10.
185 
186 MyMenu.border.size
187 
188 > A list of number separated by spaces to specify the border of the
189 > window. The field is parsed like some CSS properties (i.e. padding),
190 > that is: if only one value is provided then it'll be used for all
191 > borders; if two value are given than the first will be used for the
192 > top and bottom border and the former for the left and right border;
193 > with three value the first is used for the top border, the second for
194 > the left and right border and the third for the bottom border. If four
195 > value are given, they'll be applied to the respective border
196 > clockwise. Other values will be ignored. The default value is 0.
197 
198 MyMenu.border.color
199 
200 > A list of colors for the borders. This field is parsed like the
201 > MyMenu.border.size. The default value is black.
202 
203 MyMenu.prompt.background
204 
205 > The background of the prompt.
206 
207 MyMenu.prompt.foreground
208 
209 > The text color (foreground) of the prompt.
210 
211 MyMenu.completion.background
212 
213 > The background of the completions.
214 
215 MyMenu.completion.foreground
216 
217 > The text color of the completions.
218 
219 MyMenu.completion\_highlighted.background
220 
221 > The background of the selected completion.
222 
223 MyMenu.completion\_highlighted.foreground
224 
225 > The foreground of the selected completion.
226 
227 # KEYS
228 
229 This is the list of keybinding recognized by
230 **mymenu**.
231 In the following examples, C-c means Control-c.
232 
233 Esc
234 
235 > Close the menu without selecting any entry
236 
237 C-c
238 
239 > The same as Esc
240 
241 Enter
242 
243 > Close the menu and print to stdout what the user typed
244 
245 C-m
246 
247 > The same as Enter
248 
249 Tab
250 
251 > Expand the prompt to the next possible completion
252 
253 Shift Tab
254 
255 > Expand the prompt to the previous possible completion
256 
257 C-n
258 
259 > The same as Tab
260 
261 C-p
262 
263 > The same as Shift-Tab
264 
265 Backspace
266 
267 > Delete the last character
268 
269 C-h
270 
271 > The same as Backspace
272 
273 C-w
274 
275 > Delete the last word
276 
277 C-u
278 
279 > Delete the whole line
280 
281 C-i
282 
283 > Toggle the \`\`first selected'' style. Sometimes, especially with the -a
284 > option, could be handy to disable that behaviour. Let's say that
285 > you've typed \`\`fire'' and the first completion is \`\`firefox'' but you
286 > really want to choose \`\`fire''. While you can type some spaces, this
287 > keybinding is a more elegant way to change, at runtime, the behaviour
288 > of the first completion.
289 
290 # BUGS
291 
292 *	If, instead of a numeric value, a not-valid number that terminates
293 	with the % sign is supplied, then the default value for that field
294 	will be treated as a percentage. Since this is a misuse of the
295 	resources this behavior isn't strictly considered a bug.
296 
297 *	C-w (delete last word) does not work well with multi-byte string. The
298 	whole UTF-8 support is still kinda naïve and should be improved.
299 
300 *	Keep in mind that sometimes the order of the options matter. First are
301 	parsed (if any) the xrdb options, then the command line flags
302 	**in the provided order!**
303 	That meas that if you're providing first the x coordinate, let's say
304 	"middle", and
305 	**after that**
306 	you are overriding the width, the window
307 	**will not be**
308 	centered.
309 
310 	As a general rule of thumb, if you're overriding the width and/or the
311 	height of the window, remember to override the x and y coordinates as
312 	well.
313 
314 # EXIT STATUS
315 
316 0 when the user select an entry, 1 when the user press Esc, EX\_USAGE
317 if used with wrong flags and EX\_UNAVAILABLE if the connection to X
318 fails.
319 
320 # SEE ALSO
321 
322 dmenu(1)
323 sysexits(3)
324 
325 # AUTHORS
326 
327 Omar Polo <omar.polo@europecom.net>
328 
329 OpenBSD 6.3 - July 13, 2018