1 0d0d65c9 2018-06-14 omar.polo MYMENU(1) - General Commands Manual
5 0d0d65c9 2018-06-14 omar.polo **mymenu** - simple menu for XOrg
7 ae801529 2018-07-13 omar.polo # SYNOPSIS
9 ae801529 2018-07-13 omar.polo **mymenu**
10 3518f203 2018-07-21 omar.polo \[**-hvaA**]
11 ae801529 2018-07-13 omar.polo \[**-p** *prompt*]
12 ae801529 2018-07-13 omar.polo \[**-x** *coord*]
13 ae801529 2018-07-13 omar.polo \[**-y** *coord*]
14 844addbb 2018-07-15 omar.polo \[**-W** *width*]
15 844addbb 2018-07-15 omar.polo \[**-H** *height*]
16 ae801529 2018-07-13 omar.polo \[**-P** *padding*]
17 ae801529 2018-07-13 omar.polo \[**-l** *layout*]
18 ae801529 2018-07-13 omar.polo \[**-f** *font*]
19 ae801529 2018-07-13 omar.polo \[**-b** *borders*]
20 844addbb 2018-07-15 omar.polo \[**-B** *colors*]
21 ae801529 2018-07-13 omar.polo \[**-t** *color*]
22 ae801529 2018-07-13 omar.polo \[**-T** *color*]
23 ae801529 2018-07-13 omar.polo \[**-c** *color*]
24 ae801529 2018-07-13 omar.polo \[**-C** *color*]
25 ae801529 2018-07-13 omar.polo \[**-s** *color*]
26 ae801529 2018-07-13 omar.polo \[**-S** *color*]
27 844addbb 2018-07-15 omar.polo \[**-w** *window*]
28 3518f203 2018-07-21 omar.polo \[**-d** *separator*]
30 0d0d65c9 2018-06-14 omar.polo # DESCRIPTION
33 0d0d65c9 2018-06-14 omar.polo **mymenu**
34 0d0d65c9 2018-06-14 omar.polo utility a simple graphical menu for XOrg. It read the items from
35 0d0d65c9 2018-06-14 omar.polo **stdin**
36 0d0d65c9 2018-06-14 omar.polo and print the user selection to
37 0d0d65c9 2018-06-14 omar.polo **stdout**
38 0d0d65c9 2018-06-14 omar.polo on exit.
40 ae801529 2018-07-13 omar.polo The following options are available and take the maximum precedence
41 ae801529 2018-07-13 omar.polo over the (respective) ones defined in the
42 ae801529 2018-07-13 omar.polo **X Resource Database**
46 0d0d65c9 2018-06-14 omar.polo > Print a small usage message to stderr.
50 0d0d65c9 2018-06-14 omar.polo > Print version and exit.
54 ae801529 2018-07-13 omar.polo > The first completion (if any) is always selected. This is like dmenu.
58 3518f203 2018-07-21 omar.polo > The user must chose one of the option (or none) and is not able to
59 3518f203 2018-07-21 omar.polo > arbitrary enter text
61 ae801529 2018-07-13 omar.polo **-p** *prompt*
63 ae801529 2018-07-13 omar.polo > Override the prompt
65 ae801529 2018-07-13 omar.polo **-x** *val*
67 ae801529 2018-07-13 omar.polo > Override the positioning on the X axis, parsed as the resource MyMenu.x
69 ae801529 2018-07-13 omar.polo **-y** *val*
71 ae801529 2018-07-13 omar.polo > Override the positioning on the Y axis, parsed as the resource MyMenu.y
73 ae801529 2018-07-13 omar.polo **-P** *padding*
75 ae801529 2018-07-13 omar.polo > Override the padding. See the MyMenu.padding resource.
77 ae801529 2018-07-13 omar.polo **-l** *layout*
79 ae801529 2018-07-13 omar.polo > Override the layout. Parsed as MyMenu.layout.
81 ae801529 2018-07-13 omar.polo **-f** *font*
83 ae801529 2018-07-13 omar.polo > Override the font. See MyMenu.font.
85 ae801529 2018-07-13 omar.polo **-w** *val*
87 ae801529 2018-07-13 omar.polo > Override the width. Parsed as MyMenu.width.
89 ae801529 2018-07-13 omar.polo **-h** *val*
91 ae801529 2018-07-13 omar.polo > Override the height. Parsed as MyMenu.height.
93 ae801529 2018-07-13 omar.polo **-b** *borders*
95 ae801529 2018-07-13 omar.polo > Override the borders size. Parsed as MyMenu.border.size.
97 ae801529 2018-07-13 omar.polo **-B** *colors*
99 ae801529 2018-07-13 omar.polo > Override the borders color. Parsed as MyMenu.border.color.
101 ae801529 2018-07-13 omar.polo **-t** *color*
103 ae801529 2018-07-13 omar.polo > Override the prompt foreground color. See MyMenu.prompt.foreground.
105 ae801529 2018-07-13 omar.polo **-T** *color*
107 ae801529 2018-07-13 omar.polo > Override the prompt background color. See MyMenu.prompt.background.
109 ae801529 2018-07-13 omar.polo **-c** *color*
111 3518f203 2018-07-21 omar.polo > Override the completion foreground color. See
112 3518f203 2018-07-21 omar.polo > MyMenu.completion.foreground.
114 ae801529 2018-07-13 omar.polo **-C** *color*
116 3518f203 2018-07-21 omar.polo > Override the completion background color. See
117 3518f203 2018-07-21 omar.polo > MyMenu.completion.background.
119 ae801529 2018-07-13 omar.polo **-s** *color*
121 3518f203 2018-07-21 omar.polo > Override the highlighted completion foreground color. See
122 3518f203 2018-07-21 omar.polo > MyMenu.completion\_highlighted.foreground.
124 ae801529 2018-07-13 omar.polo **-S** *color*
126 3518f203 2018-07-21 omar.polo > Override the highlighted completion background color. See
127 3518f203 2018-07-21 omar.polo > MyMenu.completion\_highlighted.background.
129 844addbb 2018-07-15 omar.polo **-w** *window*
131 844addbb 2018-07-15 omar.polo > Embed into the given window id.
133 3518f203 2018-07-21 omar.polo **-d** *sep*
135 3518f203 2018-07-21 omar.polo > Show to the user only the text after the specified separator. If a
136 3518f203 2018-07-21 omar.polo > line does not contain the given separator, the whole line will be
137 3518f203 2018-07-21 omar.polo > showed to the user.
139 ae801529 2018-07-13 omar.polo # RESOURCES
141 0d0d65c9 2018-06-14 omar.polo MyMenu.font
143 0d0d65c9 2018-06-14 omar.polo > The font name to use. By default is set to "fixed" if compiled without
144 0d0d65c9 2018-06-14 omar.polo > Xft(3) support, "monospace" otherwise. Without Xft(3) only bitmap font
145 0d0d65c9 2018-06-14 omar.polo > are supported.
147 0d0d65c9 2018-06-14 omar.polo MyMenu.layout
149 0d0d65c9 2018-06-14 omar.polo > The layout of the menu. The possible values are "horizontal" and
150 0d0d65c9 2018-06-14 omar.polo > "vertical", with the default being "horizontal". Every other value
151 0d0d65c9 2018-06-14 omar.polo > than "horizontal" is treated like "vertical", but this is kinda an
152 0d0d65c9 2018-06-14 omar.polo > implementation detail and not something to be relied on, since in the
153 0d0d65c9 2018-06-14 omar.polo > future other layout could be added as well.
155 0d0d65c9 2018-06-14 omar.polo Mymenu.prompt
157 0d0d65c9 2018-06-14 omar.polo > A string that is rendered before the user input. Default to "$ ".
159 0d0d65c9 2018-06-14 omar.polo MyMenu.width
161 0d0d65c9 2018-06-14 omar.polo > The width of the menu. If a numeric value is given (e.g. 400) is
162 0d0d65c9 2018-06-14 omar.polo > interpreted as pixel, if it ends with a percentage symbol \`%'
163 0d0d65c9 2018-06-14 omar.polo > (e.g. 40%) the relative percentage will be computed (relative to the
164 0d0d65c9 2018-06-14 omar.polo > monitor width).
166 0d0d65c9 2018-06-14 omar.polo MyMenu.height
168 0d0d65c9 2018-06-14 omar.polo > The height of the menu. Like MyMenu.width if a numeric value is given
169 0d0d65c9 2018-06-14 omar.polo > is interpreted as pixel, if it ends with a percentage symbol \`%' the
170 0d0d65c9 2018-06-14 omar.polo > relative percentage will be computed (relative to the monitor height).
172 0d0d65c9 2018-06-14 omar.polo MyMenu.x
174 0d0d65c9 2018-06-14 omar.polo > The X coordinate of the topmost left corner of the window. Much like
175 0d0d65c9 2018-06-14 omar.polo > MyMenu.height and MyMenu.width both a pixel dimension and percentage
176 ae801529 2018-07-13 omar.polo > could be supplied. In addition to it, some special value can be used.
178 ae801529 2018-07-13 omar.polo > start
180 ae801529 2018-07-13 omar.polo > > Alias for 0;
182 ae801529 2018-07-13 omar.polo > middle
184 ae801529 2018-07-13 omar.polo > > Compute the correct value to make sure that mymenu will be
185 ae801529 2018-07-13 omar.polo > > horizontally centered;
189 ae801529 2018-07-13 omar.polo > > Compute the correct value to make sure that mymenu will be right
190 ae801529 2018-07-13 omar.polo > > aligned.
192 0d0d65c9 2018-06-14 omar.polo MyMenu.y
194 0d0d65c9 2018-06-14 omar.polo > The Y coordinate of the topmost left corner of the window. Like the X
195 0d0d65c9 2018-06-14 omar.polo > coordinate a pixel dimension, percentage dimension or the special
196 ae801529 2018-07-13 omar.polo > value "start", "middle", "end" could be supplied.
198 0d0d65c9 2018-06-14 omar.polo MyMenu.padding
200 0d0d65c9 2018-06-14 omar.polo > Change the padding. In the horizontal layout the padding is the space
201 0d0d65c9 2018-06-14 omar.polo > between the rectangle of the completion and the text as well as the
202 0d0d65c9 2018-06-14 omar.polo > space between the prompt and the first completion. In the horizontal
203 0d0d65c9 2018-06-14 omar.polo > layout the padding is the horizontal spacing between the window edge
204 0d0d65c9 2018-06-14 omar.polo > and the text as well as the space up and down the text within the
205 0d0d65c9 2018-06-14 omar.polo > completion. The default value is 10.
207 500ca6c1 2018-07-08 omar.polo MyMenu.border.size
209 500ca6c1 2018-07-08 omar.polo > A list of number separated by spaces to specify the border of the
210 500ca6c1 2018-07-08 omar.polo > window. The field is parsed like some CSS properties (i.e. padding),
211 500ca6c1 2018-07-08 omar.polo > that is: if only one value is provided then it'll be used for all
212 500ca6c1 2018-07-08 omar.polo > borders; if two value are given than the first will be used for the
213 500ca6c1 2018-07-08 omar.polo > top and bottom border and the former for the left and right border;
214 500ca6c1 2018-07-08 omar.polo > with three value the first is used for the top border, the second for
215 500ca6c1 2018-07-08 omar.polo > the left and right border and the third for the bottom border. If four
216 500ca6c1 2018-07-08 omar.polo > value are given, they'll be applied to the respective border
217 500ca6c1 2018-07-08 omar.polo > clockwise. Other values will be ignored. The default value is 0.
219 500ca6c1 2018-07-08 omar.polo MyMenu.border.color
221 500ca6c1 2018-07-08 omar.polo > A list of colors for the borders. This field is parsed like the
222 500ca6c1 2018-07-08 omar.polo > MyMenu.border.size. The default value is black.
224 0d0d65c9 2018-06-14 omar.polo MyMenu.prompt.background
226 0d0d65c9 2018-06-14 omar.polo > The background of the prompt.
228 0d0d65c9 2018-06-14 omar.polo MyMenu.prompt.foreground
230 0d0d65c9 2018-06-14 omar.polo > The text color (foreground) of the prompt.
232 0d0d65c9 2018-06-14 omar.polo MyMenu.completion.background
234 0d0d65c9 2018-06-14 omar.polo > The background of the completions.
236 0d0d65c9 2018-06-14 omar.polo MyMenu.completion.foreground
238 0d0d65c9 2018-06-14 omar.polo > The text color of the completions.
240 0d0d65c9 2018-06-14 omar.polo MyMenu.completion\_highlighted.background
242 0d0d65c9 2018-06-14 omar.polo > The background of the selected completion.
244 0d0d65c9 2018-06-14 omar.polo MyMenu.completion\_highlighted.foreground
246 0d0d65c9 2018-06-14 omar.polo > The foreground of the selected completion.
248 0d0d65c9 2018-06-14 omar.polo # KEYS
250 bee0837c 2018-07-01 omar.polo This is the list of keybinding recognized by
251 bee0837c 2018-07-01 omar.polo **mymenu**.
252 bee0837c 2018-07-01 omar.polo In the following examples, C-c means Control-c.
256 0d0d65c9 2018-06-14 omar.polo > Close the menu without selecting any entry
260 bee0837c 2018-07-01 omar.polo > The same as Esc
264 0d0d65c9 2018-06-14 omar.polo > Close the menu and print to stdout what the user typed
268 0d0d65c9 2018-06-14 omar.polo > The same as Enter
272 0d0d65c9 2018-06-14 omar.polo > Expand the prompt to the next possible completion
274 0d0d65c9 2018-06-14 omar.polo Shift Tab
276 0d0d65c9 2018-06-14 omar.polo > Expand the prompt to the previous possible completion
280 0d0d65c9 2018-06-14 omar.polo > The same as Tab
284 0d0d65c9 2018-06-14 omar.polo > The same as Shift-Tab
286 0d0d65c9 2018-06-14 omar.polo Backspace
288 0d0d65c9 2018-06-14 omar.polo > Delete the last character
292 0d0d65c9 2018-06-14 omar.polo > The same as Backspace
296 0d0d65c9 2018-06-14 omar.polo > Delete the last word
300 0d0d65c9 2018-06-14 omar.polo > Delete the whole line
304 6254fed8 2018-07-06 omar.polo > Toggle the \`\`first selected'' style. Sometimes, especially with the -a
305 6254fed8 2018-07-06 omar.polo > option, could be handy to disable that behaviour. Let's say that
306 6254fed8 2018-07-06 omar.polo > you've typed \`\`fire'' and the first completion is \`\`firefox'' but you
307 6254fed8 2018-07-06 omar.polo > really want to choose \`\`fire''. While you can type some spaces, this
308 6254fed8 2018-07-06 omar.polo > keybinding is a more elegant way to change, at runtime, the behaviour
309 6254fed8 2018-07-06 omar.polo > of the first completion.
311 3518f203 2018-07-21 omar.polo # EXIT STATUS
313 3518f203 2018-07-21 omar.polo 0 when the user select an entry, 1 when the user press Esc, EX\_USAGE
314 3518f203 2018-07-21 omar.polo if used with wrong flags and EX\_UNAVAILABLE if the connection to X
315 3518f203 2018-07-21 omar.polo fails.
317 3518f203 2018-07-21 omar.polo # EXAMPLES
319 3518f203 2018-07-21 omar.polo * Create a simple menu with a couple of entry
321 3518f203 2018-07-21 omar.polo cat <<EOF | $SHELL -c "$(mymenu -p "Exec: ")"
322 3518f203 2018-07-21 omar.polo firefox
324 3518f203 2018-07-21 omar.polo xcalc -stipple
329 3518f203 2018-07-21 omar.polo * Select and play a song from the current mpd playlist
331 3518f203 2018-07-21 omar.polo filter="%position%) %artist% - %title%"
332 3518f203 2018-07-21 omar.polo if song=$(mpc playlist -f "$filter" | mymenu -p "Song: " -A -d ") "); then
333 3518f203 2018-07-21 omar.polo mpc play $(echo $song | sed "s/).*$//")
336 3518f203 2018-07-21 omar.polo # SEE ALSO
338 3518f203 2018-07-21 omar.polo dmenu(1)
339 3518f203 2018-07-21 omar.polo sysexits(3)
341 3518f203 2018-07-21 omar.polo # AUTHORS
343 3518f203 2018-07-21 omar.polo Omar Polo <omar.polo@europecom.net>
345 0d0d65c9 2018-06-14 omar.polo # BUGS
347 0d0d65c9 2018-06-14 omar.polo * If, instead of a numeric value, a not-valid number that terminates
348 0d0d65c9 2018-06-14 omar.polo with the % sign is supplied, then the default value for that field
349 0d0d65c9 2018-06-14 omar.polo will be treated as a percentage. Since this is a misuse of the
350 0d0d65c9 2018-06-14 omar.polo resources this behavior isn't strictly considered a bug.
352 ae801529 2018-07-13 omar.polo * Keep in mind that sometimes the order of the options matter. First are
353 ae801529 2018-07-13 omar.polo parsed (if any) the xrdb options, then the command line flags
354 ae801529 2018-07-13 omar.polo **in the provided order!**
355 ae801529 2018-07-13 omar.polo That meas that if you're providing first the x coordinate, let's say
356 ae801529 2018-07-13 omar.polo "middle", and
357 ae801529 2018-07-13 omar.polo **after that**
358 ae801529 2018-07-13 omar.polo you are overriding the width, the window
359 ae801529 2018-07-13 omar.polo **will not be**
360 ae801529 2018-07-13 omar.polo centered.
362 ae801529 2018-07-13 omar.polo As a general rule of thumb, if you're overriding the width and/or the
363 ae801529 2018-07-13 omar.polo height of the window, remember to override the x and y coordinates as
366 3518f203 2018-07-21 omar.polo OpenBSD 6.3 - July 21, 2018
