1 f5e234d6 2018-05-18 omar.polo .Dd $Mdocdate$
2 f5e234d6 2018-05-18 omar.polo .Dt MYMENU 1
4 f5e234d6 2018-05-18 omar.polo .Sh NAME
5 f5e234d6 2018-05-18 omar.polo .Nm mymenu
6 f5e234d6 2018-05-18 omar.polo .Nd simple menu for XOrg
7 ae801529 2018-07-13 omar.polo .Sh SYNOPSIS
9 ae801529 2018-07-13 omar.polo .Bk -words
10 57d3c979 2018-10-17 omar.polo .Op Fl Aahmv
11 54fabaa4 2018-09-16 omar.polo .Op Fl B Ar colors
12 57d3c979 2018-10-17 omar.polo .Op Fl b Ar size
13 54fabaa4 2018-09-16 omar.polo .Op Fl C Ar color
14 54fabaa4 2018-09-16 omar.polo .Op Fl c Ar color
15 54fabaa4 2018-09-16 omar.polo .Op Fl d Ar separator
16 54fabaa4 2018-09-16 omar.polo .Op Fl e Ar window
17 54fabaa4 2018-09-16 omar.polo .Op Fl f Ar font
18 57d3c979 2018-10-17 omar.polo .Op Fl G Ar color
19 57d3c979 2018-10-17 omar.polo .Op Fl g Ar size
20 844addbb 2018-07-15 omar.polo .Op Fl H Ar height
21 57d3c979 2018-10-17 omar.polo .Op Fl I Ar color
22 57d3c979 2018-10-17 omar.polo .Op Fl i Ar size
23 57d3c979 2018-10-17 omar.polo .Op Fl J Ar color
24 57d3c979 2018-10-17 omar.polo .Op Fl j Ar size
25 ae801529 2018-07-13 omar.polo .Op Fl l Ar layout
26 54fabaa4 2018-09-16 omar.polo .Op Fl P Ar padding
27 54fabaa4 2018-09-16 omar.polo .Op Fl p Ar prompt
28 ae801529 2018-07-13 omar.polo .Op Fl S Ar color
29 54fabaa4 2018-09-16 omar.polo .Op Fl s Ar color
30 57d3c979 2018-10-17 omar.polo .Op Fl T Ar color
31 57d3c979 2018-10-17 omar.polo .Op Fl t Ar color
32 54fabaa4 2018-09-16 omar.polo .Op Fl W Ar width
33 54fabaa4 2018-09-16 omar.polo .Op Fl x Ar coord
34 54fabaa4 2018-09-16 omar.polo .Op Fl y Ar coord
36 f5e234d6 2018-05-18 omar.polo .Sh DESCRIPTION
39 f5e234d6 2018-05-18 omar.polo utility a simple graphical menu for XOrg. It read the items from
40 f5e234d6 2018-05-18 omar.polo .Ic stdin
41 f5e234d6 2018-05-18 omar.polo and print the user selection to
42 f5e234d6 2018-05-18 omar.polo .Ic stdout
43 f5e234d6 2018-05-18 omar.polo on exit.
45 ae801529 2018-07-13 omar.polo The following options are available and take the maximum precedence
46 ae801529 2018-07-13 omar.polo over the (respective) ones defined in the
47 ae801529 2018-07-13 omar.polo .Sy X Resource Database
48 ae801529 2018-07-13 omar.polo .Bl -tag -width indent-two
49 3518f203 2018-07-21 omar.polo .It Fl A
50 3518f203 2018-07-21 omar.polo The user must chose one of the option (or none) and is not able to
51 3518f203 2018-07-21 omar.polo arbitrary enter text
52 54fabaa4 2018-09-16 omar.polo .It Fl a
53 54fabaa4 2018-09-16 omar.polo The first completion (if any) is always selected. This is like dmenu.
54 ae801529 2018-07-13 omar.polo .It Fl B Ar colors
55 ae801529 2018-07-13 omar.polo Override the borders color. Parsed as MyMenu.border.color.
56 54fabaa4 2018-09-16 omar.polo .It Fl b Ar borders
57 54fabaa4 2018-09-16 omar.polo Override the borders size. Parsed as MyMenu.border.size.
58 ae801529 2018-07-13 omar.polo .It Fl C Ar color
59 3518f203 2018-07-21 omar.polo Override the completion background color. See
60 3518f203 2018-07-21 omar.polo MyMenu.completion.background.
61 54fabaa4 2018-09-16 omar.polo .It Fl c Ar color
62 54fabaa4 2018-09-16 omar.polo Override the completion foreground color. See
63 54fabaa4 2018-09-16 omar.polo MyMenu.completion.foreground.
64 54fabaa4 2018-09-16 omar.polo .It Fl d Ar separator
65 57d3c979 2018-10-17 omar.polo Define a string to be used as a separator (mnemonic: delimiter). Only
66 57d3c979 2018-10-17 omar.polo the text after the separator will be rendered, but the original string
67 57d3c979 2018-10-17 omar.polo will be returned. Useful to embed custom data on every entry. See the
68 57d3c979 2018-10-17 omar.polo mpd example for hints on how this can be useful.
69 54fabaa4 2018-09-16 omar.polo .It Fl e Ar windowid
70 54fabaa4 2018-09-16 omar.polo Embed into the given window id.
71 57d3c979 2018-10-17 omar.polo .It Fl f Ar font
72 57d3c979 2018-10-17 omar.polo Override the font. See MyMenu.font.
73 57d3c979 2018-10-17 omar.polo .It Fl G Ar color
74 57d3c979 2018-10-17 omar.polo Override the border colors of the prompt. See
75 57d3c979 2018-10-17 omar.polo MyMenu.prompt.border.color.
76 57d3c979 2018-10-17 omar.polo .It Fl g Ar size
77 57d3c979 2018-10-17 omar.polo Override the border size of the prompt. See
78 57d3c979 2018-10-17 omar.polo MyMenu.prompt.border.size.
79 54fabaa4 2018-09-16 omar.polo .It Fl H Ar val
80 54fabaa4 2018-09-16 omar.polo Override the height. Parsed as MyMenu.height.
81 54fabaa4 2018-09-16 omar.polo .It Fl h
82 54fabaa4 2018-09-16 omar.polo Print a small usage message to stderr.
83 57d3c979 2018-10-17 omar.polo .It Fl I Ar color
84 57d3c979 2018-10-17 omar.polo Override the border colors of the completion. See
85 57d3c979 2018-10-17 omar.polo MyMenu.completion.border.color.
86 57d3c979 2018-10-17 omar.polo .It Fl i Ar size
87 57d3c979 2018-10-17 omar.polo Override the border size of the completion. See
88 57d3c979 2018-10-17 omar.polo MyMenu.completion.border.size.
89 57d3c979 2018-10-17 omar.polo .It Fl J Ar color
90 57d3c979 2018-10-17 omar.polo Override the border colors of the completion. See
91 57d3c979 2018-10-17 omar.polo MyMenu.completion_highlighted.border.color.
92 57d3c979 2018-10-17 omar.polo .It Fl j Ar size
93 57d3c979 2018-10-17 omar.polo Override the border size of the completion. See
94 57d3c979 2018-10-17 omar.polo MyMenu.completion_highlighted.border.size.
95 54fabaa4 2018-09-16 omar.polo .It Fl l Ar layout
96 54fabaa4 2018-09-16 omar.polo Override the layout. Parsed as MyMenu.layout.
97 54fabaa4 2018-09-16 omar.polo .It Fl m
98 54fabaa4 2018-09-16 omar.polo The user can select multiple entry via C-m. Please consult
99 845963e5 2018-09-16 omar.polo .Sx KEYS
100 845963e5 2018-09-16 omar.polo for more info.
101 54fabaa4 2018-09-16 omar.polo .It Fl P Ar padding
102 7f9e4fec 2018-10-17 omar.polo Override the padding. See the MyMenu.prompt.padding resource.
103 54fabaa4 2018-09-16 omar.polo .It Fl p Ar prompt
104 54fabaa4 2018-09-16 omar.polo Override the prompt
105 ae801529 2018-07-13 omar.polo .It Fl S Ar color
106 3518f203 2018-07-21 omar.polo Override the highlighted completion background color. See
107 3518f203 2018-07-21 omar.polo MyMenu.completion_highlighted.background.
108 54fabaa4 2018-09-16 omar.polo .It Fl s Ar color
109 54fabaa4 2018-09-16 omar.polo Override the highlighted completion foreground color. See
110 54fabaa4 2018-09-16 omar.polo MyMenu.completion_highlighted.foreground.
111 54fabaa4 2018-09-16 omar.polo .It Fl T Ar color
112 54fabaa4 2018-09-16 omar.polo Override the prompt background color. See MyMenu.prompt.background.
113 54fabaa4 2018-09-16 omar.polo .It Fl t Ar color
114 54fabaa4 2018-09-16 omar.polo Override the prompt foreground color. See MyMenu.prompt.foreground.
115 54fabaa4 2018-09-16 omar.polo .It Fl v
116 54fabaa4 2018-09-16 omar.polo Print version and exit.
117 54fabaa4 2018-09-16 omar.polo .It Fl W Ar val
118 54fabaa4 2018-09-16 omar.polo Override the width. Parsed as MyMenu.width.
119 54fabaa4 2018-09-16 omar.polo .It Fl x Ar val
120 54fabaa4 2018-09-16 omar.polo Override the positioning on the X axis, parsed as the resource MyMenu.x
121 54fabaa4 2018-09-16 omar.polo .It Fl y Ar val
122 54fabaa4 2018-09-16 omar.polo Override the positioning on the Y axis, parsed as the resource MyMenu.y
124 f5e234d6 2018-05-18 omar.polo .Sh RESOURCES
125 f5e234d6 2018-05-18 omar.polo .Bl -tag -width Ds
126 f5e234d6 2018-05-18 omar.polo .It MyMenu.font
127 9e94fcbe 2018-05-22 omar.polo The font name to use. By default is set to "fixed" if compiled without
128 9e94fcbe 2018-05-22 omar.polo Xft(3) support, "monospace" otherwise. Without Xft(3) only bitmap font
129 9e94fcbe 2018-05-22 omar.polo are supported.
130 36a15a9f 2018-05-19 omar.polo .It MyMenu.layout
131 36a15a9f 2018-05-19 omar.polo The layout of the menu. The possible values are "horizontal" and
132 36a15a9f 2018-05-19 omar.polo "vertical", with the default being "horizontal". Every other value
133 36a15a9f 2018-05-19 omar.polo than "horizontal" is treated like "vertical", but this is kinda an
134 36a15a9f 2018-05-19 omar.polo implementation detail and not something to be relied on, since in the
135 8758854a 2018-05-20 omar.polo future other layout could be added as well.
136 57d3c979 2018-10-17 omar.polo .It MyMenu.prompt
137 8758854a 2018-05-20 omar.polo A string that is rendered before the user input. Default to "$ ".
138 57d3c979 2018-10-17 omar.polo .It MyMenu.prompt.border.size
139 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.border.size, but affects only the prompt. Default
141 57d3c979 2018-10-17 omar.polo .It MyMenu.prompt.border.color
142 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.border.color, but affects only the prompt. Default
143 57d3c979 2018-10-17 omar.polo to #000 (black).
144 57d3c979 2018-10-17 omar.polo .It MyMenu.prompt.padding
145 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.border.size. The padding is the space between the
146 57d3c979 2018-10-17 omar.polo end of the borderd and the start of the text, in any direction (top,
147 57d3c979 2018-10-17 omar.polo bottom, left, right). Default to 10.
148 f5e234d6 2018-05-18 omar.polo .It MyMenu.width
149 f5e234d6 2018-05-18 omar.polo The width of the menu. If a numeric value is given (e.g. 400) is
150 f5e234d6 2018-05-18 omar.polo interpreted as pixel, if it ends with a percentage symbol `%'
151 f5e234d6 2018-05-18 omar.polo (e.g. 40%) the relative percentage will be computed (relative to the
152 8758854a 2018-05-20 omar.polo monitor width).
153 f5e234d6 2018-05-18 omar.polo .It MyMenu.height
154 f5e234d6 2018-05-18 omar.polo The height of the menu. Like MyMenu.width if a numeric value is given
155 f5e234d6 2018-05-18 omar.polo is interpreted as pixel, if it ends with a percentage symbol `%' the
156 8758854a 2018-05-20 omar.polo relative percentage will be computed (relative to the monitor height).
157 f5e234d6 2018-05-18 omar.polo .It MyMenu.x
158 f5e234d6 2018-05-18 omar.polo The X coordinate of the topmost left corner of the window. Much like
159 f5e234d6 2018-05-18 omar.polo MyMenu.height and MyMenu.width both a pixel dimension and percentage
160 8e122ff1 2018-07-13 omar.polo could be supplied. In addition to it, some special value can be used.
161 8e122ff1 2018-07-13 omar.polo .Bl -tag
162 8e122ff1 2018-07-13 omar.polo .It start
163 8e122ff1 2018-07-13 omar.polo Alias for 0;
164 8e122ff1 2018-07-13 omar.polo .It middle
165 8e122ff1 2018-07-13 omar.polo Compute the correct value to make sure that mymenu will be
166 8e122ff1 2018-07-13 omar.polo horizontally centered;
167 8e122ff1 2018-07-13 omar.polo .It end
168 8e122ff1 2018-07-13 omar.polo Compute the correct value to make sure that mymenu will be right
169 8e122ff1 2018-07-13 omar.polo aligned.
171 f5e234d6 2018-05-18 omar.polo .It MyMenu.y
172 f5e234d6 2018-05-18 omar.polo The Y coordinate of the topmost left corner of the window. Like the X
173 e5186d6b 2018-05-26 omar.polo coordinate a pixel dimension, percentage dimension or the special
174 8e122ff1 2018-07-13 omar.polo value "start", "middle", "end" could be supplied.
175 500ca6c1 2018-07-08 omar.polo .It MyMenu.border.size
176 500ca6c1 2018-07-08 omar.polo A list of number separated by spaces to specify the border of the
177 500ca6c1 2018-07-08 omar.polo window. The field is parsed like some CSS properties (i.e. padding),
178 500ca6c1 2018-07-08 omar.polo that is: if only one value is provided then it'll be used for all
179 500ca6c1 2018-07-08 omar.polo borders; if two value are given than the first will be used for the
180 500ca6c1 2018-07-08 omar.polo top and bottom border and the former for the left and right border;
181 500ca6c1 2018-07-08 omar.polo with three value the first is used for the top border, the second for
182 500ca6c1 2018-07-08 omar.polo the left and right border and the third for the bottom border. If four
183 500ca6c1 2018-07-08 omar.polo value are given, they'll be applied to the respective border
184 500ca6c1 2018-07-08 omar.polo clockwise. Other values will be ignored. The default value is 0.
186 57d3c979 2018-10-17 omar.polo This particular option accepts a percentage (e.g. 10%) relative to the
187 4b09b4b1 2018-10-17 omar.polo screen width.
188 500ca6c1 2018-07-08 omar.polo .It MyMenu.border.color
189 500ca6c1 2018-07-08 omar.polo A list of colors for the borders. This field is parsed like the
190 500ca6c1 2018-07-08 omar.polo MyMenu.border.size. The default value is black.
191 f5e234d6 2018-05-18 omar.polo .It MyMenu.prompt.background
192 8758854a 2018-05-20 omar.polo The background of the prompt.
193 f5e234d6 2018-05-18 omar.polo .It MyMenu.prompt.foreground
194 8758854a 2018-05-20 omar.polo The text color (foreground) of the prompt.
195 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion.background
196 8758854a 2018-05-20 omar.polo The background of the completions.
197 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion.foreground
198 8758854a 2018-05-20 omar.polo The text color of the completions.
199 57d3c979 2018-10-17 omar.polo .It MyMenu.completion.border.size
200 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.border.size, but affects only the
201 57d3c979 2018-10-17 omar.polo completion. Default to 0.
202 57d3c979 2018-10-17 omar.polo .It MyMenu.completion.border.color
203 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.border.color, but affects only the
204 57d3c979 2018-10-17 omar.polo completion. Default to #000 (black).
205 57d3c979 2018-10-17 omar.polo .It MyMenu.completion.padding
206 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.prompt.padding. Default to 10.
207 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion_highlighted.background
208 8758854a 2018-05-20 omar.polo The background of the selected completion.
209 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion_highlighted.foreground
210 8758854a 2018-05-20 omar.polo The foreground of the selected completion.
211 57d3c979 2018-10-17 omar.polo .It MyMenu.completion_highlighted.border.size
212 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.border.size, but affects only the completion
213 57d3c979 2018-10-17 omar.polo highlighted. Default to 0.
214 57d3c979 2018-10-17 omar.polo .It MyMenu.completion_highlighted.border.color
215 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.border.color, but affects only the completion
216 57d3c979 2018-10-17 omar.polo highlighted. Default to #000 (black).
217 57d3c979 2018-10-17 omar.polo .It MyMenu.completion_highlighted.padding
218 57d3c979 2018-10-17 omar.polo Parsed like MyMenu.prompt.padding. Default to 10.
220 54fabaa4 2018-09-16 omar.polo .Sh COLORS
221 54fabaa4 2018-09-16 omar.polo MyMenu accept colors only in the form of:
222 54fabaa4 2018-09-16 omar.polo .Bl -bullet
226 54fabaa4 2018-09-16 omar.polo #rrggbb
228 54fabaa4 2018-09-16 omar.polo #aarrggbb
231 54fabaa4 2018-09-16 omar.polo The opacity is assumed 0xff (no transparency) if not provided.
232 f5e234d6 2018-05-18 omar.polo .Sh KEYS
233 bee0837c 2018-07-01 omar.polo This is the list of keybinding recognized by
234 bee0837c 2018-07-01 omar.polo .Li Nm Ns .
235 bee0837c 2018-07-01 omar.polo In the following examples, C-c means Control-c.
236 f5e234d6 2018-05-18 omar.polo .Bl -tag -width indent-two
237 f5e234d6 2018-05-18 omar.polo .It Esc
238 f5e234d6 2018-05-18 omar.polo Close the menu without selecting any entry
239 bee0837c 2018-07-01 omar.polo .It C-c
240 bee0837c 2018-07-01 omar.polo The same as Esc
241 f5e234d6 2018-05-18 omar.polo .It Enter
242 f5e234d6 2018-05-18 omar.polo Close the menu and print to stdout what the user typed
243 347d23da 2018-05-19 omar.polo .It C-m
244 0dee1b65 2018-08-13 omar.polo Confirm but keep looping (if enabled), otherwise complete only
245 f5e234d6 2018-05-18 omar.polo .It Tab
246 f5e234d6 2018-05-18 omar.polo Expand the prompt to the next possible completion
247 f5e234d6 2018-05-18 omar.polo .It Shift Tab
248 f5e234d6 2018-05-18 omar.polo Expand the prompt to the previous possible completion
249 8ecd98cc 2018-05-25 omar.polo .It C-n
250 8ecd98cc 2018-05-25 omar.polo The same as Tab
251 8ecd98cc 2018-05-25 omar.polo .It C-p
252 8ecd98cc 2018-05-25 omar.polo The same as Shift-Tab
253 f5e234d6 2018-05-18 omar.polo .It Backspace
254 f5e234d6 2018-05-18 omar.polo Delete the last character
255 347d23da 2018-05-19 omar.polo .It C-h
256 347d23da 2018-05-19 omar.polo The same as Backspace
257 347d23da 2018-05-19 omar.polo .It C-w
258 347d23da 2018-05-19 omar.polo Delete the last word
259 347d23da 2018-05-19 omar.polo .It C-u
260 347d23da 2018-05-19 omar.polo Delete the whole line
261 6254fed8 2018-07-06 omar.polo .It C-i
262 6254fed8 2018-07-06 omar.polo Toggle the ``first selected'' style. Sometimes, especially with the -a
263 6254fed8 2018-07-06 omar.polo option, could be handy to disable that behaviour. Let's say that
264 6254fed8 2018-07-06 omar.polo you've typed ``fire'' and the first completion is ``firefox'' but you
265 6254fed8 2018-07-06 omar.polo really want to choose ``fire''. While you can type some spaces, this
266 6254fed8 2018-07-06 omar.polo keybinding is a more elegant way to change, at runtime, the behaviour
267 6254fed8 2018-07-06 omar.polo of the first completion.
269 3518f203 2018-07-21 omar.polo .Sh EXIT STATUS
270 3518f203 2018-07-21 omar.polo 0 when the user select an entry, 1 when the user press Esc, EX_USAGE
271 3518f203 2018-07-21 omar.polo if used with wrong flags and EX_UNAVAILABLE if the connection to X
272 3518f203 2018-07-21 omar.polo fails.
273 3518f203 2018-07-21 omar.polo .Sh EXAMPLES
274 3518f203 2018-07-21 omar.polo .Bl -bullet -bullet
276 3518f203 2018-07-21 omar.polo Create a simple menu with a couple of entry
277 3518f203 2018-07-21 omar.polo .Bd -literal -offset indent
278 3518f203 2018-07-21 omar.polo cat <<EOF | $SHELL -c "$(mymenu -p "Exec: ")"
279 3518f203 2018-07-21 omar.polo firefox
281 3518f203 2018-07-21 omar.polo xcalc -stipple
287 3518f203 2018-07-21 omar.polo Select and play a song from the current mpd playlist
288 3518f203 2018-07-21 omar.polo .Bd -literal -offset indent
289 630eb368 2018-09-19 omar.polo fmt="%position% %artist% - %title%"
290 630eb368 2018-09-19 omar.polo if song=$(mpc playlist -f "$fmt" | mymenu -p "Song: " -A -d " "); then
291 630eb368 2018-09-19 omar.polo mpc play $(echo $song | sed "s/ .*$//")
296 3518f203 2018-07-21 omar.polo .Sh SEE ALSO
297 3518f203 2018-07-21 omar.polo .Xr dmenu 1
298 3518f203 2018-07-21 omar.polo .Xr sysexits 3
300 3518f203 2018-07-21 omar.polo .Sh AUTHORS
301 3518f203 2018-07-21 omar.polo .An Omar Polo <omar.polo@europecom.net>
303 0dee1b65 2018-08-13 omar.polo .Sh CAVEATS
304 f5e234d6 2018-05-18 omar.polo .Bl -bullet
306 f5e234d6 2018-05-18 omar.polo If, instead of a numeric value, a not-valid number that terminates
307 f5e234d6 2018-05-18 omar.polo with the % sign is supplied, then the default value for that field
308 f5e234d6 2018-05-18 omar.polo will be treated as a percentage. Since this is a misuse of the
309 f5e234d6 2018-05-18 omar.polo resources this behavior isn't strictly considered a bug.
311 ae801529 2018-07-13 omar.polo Keep in mind that sometimes the order of the options matter. First are
312 ae801529 2018-07-13 omar.polo parsed (if any) the xrdb options, then the command line flags
313 ae801529 2018-07-13 omar.polo .Sy in the provided order!
314 ae801529 2018-07-13 omar.polo That meas that if you're providing first the x coordinate, let's say
315 ae801529 2018-07-13 omar.polo "middle", and
316 ae801529 2018-07-13 omar.polo .Sy after that
317 ae801529 2018-07-13 omar.polo you are overriding the width, the window
318 ae801529 2018-07-13 omar.polo .Sy will not be
319 ae801529 2018-07-13 omar.polo centered.
321 ae801529 2018-07-13 omar.polo As a general rule of thumb, if you're overriding the width and/or the
322 ae801529 2018-07-13 omar.polo height of the window, remember to override the x and y coordinates as
