1 MYMENU(1) - General Commands Manual
5 **mymenu** - simple menu for XOrg
11 \[**-p** *prompt*]
12 \[**-x** *coord*]
13 \[**-y** *coord*]
14 \[**-W** *width*]
15 \[**-H** *height*]
16 \[**-P** *padding*]
17 \[**-l** *layout*]
19 \[**-b** *borders*]
20 \[**-B** *colors*]
21 \[**-t** *color*]
22 \[**-T** *color*]
23 \[**-c** *color*]
24 \[**-C** *color*]
25 \[**-s** *color*]
26 \[**-S** *color*]
27 \[**-e** *window*]
28 \[**-d** *separator*]
34 utility a simple graphical menu for XOrg. It read the items from
36 and print the user selection to
40 The following options are available and take the maximum precedence
41 over the (respective) ones defined in the
42 **X Resource Database**
46 > Print a small usage message to stderr.
50 > Print version and exit.
54 > The first completion (if any) is always selected. This is like dmenu.
58 > The user must chose one of the option (or none) and is not able to
59 > arbitrary enter text
63 > The user can select multiple entry via C-m. Please consult
73 > Override the positioning on the X axis, parsed as the resource MyMenu.x
77 > Override the positioning on the Y axis, parsed as the resource MyMenu.y
81 > Override the padding. See the MyMenu.padding resource.
85 > Override the layout. Parsed as MyMenu.layout.
89 > Override the font. See MyMenu.font.
93 > Override the width. Parsed as MyMenu.width.
97 > Override the height. Parsed as MyMenu.height.
101 > Override the borders size. Parsed as MyMenu.border.size.
105 > Override the borders color. Parsed as MyMenu.border.color.
109 > Override the prompt foreground color. See MyMenu.prompt.foreground.
113 > Override the prompt background color. See MyMenu.prompt.background.
117 > Override the completion foreground color. See
118 > MyMenu.completion.foreground.
122 > Override the completion background color. See
123 > MyMenu.completion.background.
127 > Override the highlighted completion foreground color. See
128 > MyMenu.completion\_highlighted.foreground.
132 > Override the highlighted completion background color. See
133 > MyMenu.completion\_highlighted.background.
137 > Embed into the given window id.
141 > Optionally show only the text after the given separator. Defaults
142 > to the whole line if the separator is not present.
148 > The font name to use. By default is set to "fixed" if compiled without
149 > Xft(3) support, "monospace" otherwise. Without Xft(3) only bitmap font
154 > The layout of the menu. The possible values are "horizontal" and
155 > "vertical", with the default being "horizontal". Every other value
156 > than "horizontal" is treated like "vertical", but this is kinda an
157 > implementation detail and not something to be relied on, since in the
158 > future other layout could be added as well.
162 > A string that is rendered before the user input. Default to "$ ".
166 > The width of the menu. If a numeric value is given (e.g. 400) is
167 > interpreted as pixel, if it ends with a percentage symbol \`%'
168 > (e.g. 40%) the relative percentage will be computed (relative to the
173 > The height of the menu. Like MyMenu.width if a numeric value is given
174 > is interpreted as pixel, if it ends with a percentage symbol \`%' the
175 > relative percentage will be computed (relative to the monitor height).
179 > The X coordinate of the topmost left corner of the window. Much like
180 > MyMenu.height and MyMenu.width both a pixel dimension and percentage
181 > could be supplied. In addition to it, some special value can be used.
189 > > Compute the correct value to make sure that mymenu will be
190 > > horizontally centered;
194 > > Compute the correct value to make sure that mymenu will be right
199 > The Y coordinate of the topmost left corner of the window. Like the X
200 > coordinate a pixel dimension, percentage dimension or the special
201 > value "start", "middle", "end" could be supplied.
205 > Change the padding. In the horizontal layout the padding is the space
206 > between the rectangle of the completion and the text as well as the
207 > space between the prompt and the first completion. In the horizontal
208 > layout the padding is the horizontal spacing between the window edge
209 > and the text as well as the space up and down the text within the
210 > completion. The default value is 10.
214 > A list of number separated by spaces to specify the border of the
215 > window. The field is parsed like some CSS properties (i.e. padding),
216 > that is: if only one value is provided then it'll be used for all
217 > borders; if two value are given than the first will be used for the
218 > top and bottom border and the former for the left and right border;
219 > with three value the first is used for the top border, the second for
220 > the left and right border and the third for the bottom border. If four
221 > value are given, they'll be applied to the respective border
222 > clockwise. Other values will be ignored. The default value is 0.
226 > A list of colors for the borders. This field is parsed like the
227 > MyMenu.border.size. The default value is black.
229 MyMenu.prompt.background
231 > The background of the prompt.
233 MyMenu.prompt.foreground
235 > The text color (foreground) of the prompt.
237 MyMenu.completion.background
239 > The background of the completions.
241 MyMenu.completion.foreground
243 > The text color of the completions.
245 MyMenu.completion\_highlighted.background
247 > The background of the selected completion.
249 MyMenu.completion\_highlighted.foreground
251 > The foreground of the selected completion.
255 This is the list of keybinding recognized by
257 In the following examples, C-c means Control-c.
261 > Close the menu without selecting any entry
269 > Close the menu and print to stdout what the user typed
273 > Confirm but keep looping (if enabled), otherwise complete only
277 > Expand the prompt to the next possible completion
281 > Expand the prompt to the previous possible completion
289 > The same as Shift-Tab
293 > Delete the last character
297 > The same as Backspace
301 > Delete the last word
305 > Delete the whole line
309 > Toggle the \`\`first selected'' style. Sometimes, especially with the -a
310 > option, could be handy to disable that behaviour. Let's say that
311 > you've typed \`\`fire'' and the first completion is \`\`firefox'' but you
312 > really want to choose \`\`fire''. While you can type some spaces, this
313 > keybinding is a more elegant way to change, at runtime, the behaviour
314 > of the first completion.
318 0 when the user select an entry, 1 when the user press Esc, EX\_USAGE
319 if used with wrong flags and EX\_UNAVAILABLE if the connection to X
324 * Create a simple menu with a couple of entry
326 cat <<EOF | $SHELL -c "$(mymenu -p "Exec: ")"
334 * Select and play a song from the current mpd playlist
336 filter="%position%) %artist% - %title%"
337 if song=$(mpc playlist -f "$filter" | mymenu -p "Song: " -A -d ") "); then
338 mpc play $(echo $song | sed "s/).*$//")
348 Omar Polo <omar.polo@europecom.net>
352 * If, instead of a numeric value, a not-valid number that terminates
353 with the % sign is supplied, then the default value for that field
354 will be treated as a percentage. Since this is a misuse of the
355 resources this behavior isn't strictly considered a bug.
357 * Keep in mind that sometimes the order of the options matter. First are
358 parsed (if any) the xrdb options, then the command line flags
359 **in the provided order!**
360 That meas that if you're providing first the x coordinate, let's say
363 you are overriding the width, the window
367 As a general rule of thumb, if you're overriding the width and/or the
368 height of the window, remember to override the x and y coordinates as
371 OpenBSD 6.3 - August 13, 2018
