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 f5e234d6 2018-05-18 omar.polo .Sh DESCRIPTION
10 f5e234d6 2018-05-18 omar.polo utility a simple graphical menu for XOrg. It read the items from
11 f5e234d6 2018-05-18 omar.polo .Ic stdin
12 f5e234d6 2018-05-18 omar.polo and print the user selection to
13 f5e234d6 2018-05-18 omar.polo .Ic stdout
14 f5e234d6 2018-05-18 omar.polo on exit.
15 8d9debb1 2018-06-07 omar.polo .Sh OPTIONS
16 8d9debb1 2018-06-07 omar.polo .Bl -tag -width Ds
17 8d9debb1 2018-06-07 omar.polo .It Fl a
18 8d9debb1 2018-06-07 omar.polo The first completion (if any) is always selected. This is like dmenu
20 f5e234d6 2018-05-18 omar.polo .Sh RESOURCES
22 8d9debb1 2018-06-07 omar.polo The appearance of the menu is defined through the \fBX Resource
23 8d9debb1 2018-06-07 omar.polo Database\fR.
24 f5e234d6 2018-05-18 omar.polo .Bl -tag -width Ds
25 f5e234d6 2018-05-18 omar.polo .It MyMenu.font
26 9e94fcbe 2018-05-22 omar.polo The font name to use. By default is set to "fixed" if compiled without
27 9e94fcbe 2018-05-22 omar.polo Xft(3) support, "monospace" otherwise. Without Xft(3) only bitmap font
28 9e94fcbe 2018-05-22 omar.polo are supported.
29 36a15a9f 2018-05-19 omar.polo .It MyMenu.layout
30 36a15a9f 2018-05-19 omar.polo The layout of the menu. The possible values are "horizontal" and
31 36a15a9f 2018-05-19 omar.polo "vertical", with the default being "horizontal". Every other value
32 36a15a9f 2018-05-19 omar.polo than "horizontal" is treated like "vertical", but this is kinda an
33 36a15a9f 2018-05-19 omar.polo implementation detail and not something to be relied on, since in the
34 8758854a 2018-05-20 omar.polo future other layout could be added as well.
35 8758854a 2018-05-20 omar.polo .It Mymenu.prompt
36 8758854a 2018-05-20 omar.polo A string that is rendered before the user input. Default to "$ ".
37 f5e234d6 2018-05-18 omar.polo .It MyMenu.width
38 f5e234d6 2018-05-18 omar.polo The width of the menu. If a numeric value is given (e.g. 400) is
39 f5e234d6 2018-05-18 omar.polo interpreted as pixel, if it ends with a percentage symbol `%'
40 f5e234d6 2018-05-18 omar.polo (e.g. 40%) the relative percentage will be computed (relative to the
41 8758854a 2018-05-20 omar.polo monitor width).
42 f5e234d6 2018-05-18 omar.polo .It MyMenu.height
43 f5e234d6 2018-05-18 omar.polo The height of the menu. Like MyMenu.width if a numeric value is given
44 f5e234d6 2018-05-18 omar.polo is interpreted as pixel, if it ends with a percentage symbol `%' the
45 8758854a 2018-05-20 omar.polo relative percentage will be computed (relative to the monitor height).
46 f5e234d6 2018-05-18 omar.polo .It MyMenu.x
47 f5e234d6 2018-05-18 omar.polo The X coordinate of the topmost left corner of the window. Much like
48 f5e234d6 2018-05-18 omar.polo MyMenu.height and MyMenu.width both a pixel dimension and percentage
49 f5e234d6 2018-05-18 omar.polo could be supplied. In addition to it, the special value "middle" could
50 f5e234d6 2018-05-18 omar.polo be used: in that case the window will be centered on the x axes.
51 f5e234d6 2018-05-18 omar.polo .It MyMenu.y
52 f5e234d6 2018-05-18 omar.polo The Y coordinate of the topmost left corner of the window. Like the X
53 e5186d6b 2018-05-26 omar.polo coordinate a pixel dimension, percentage dimension or the special
54 f5e234d6 2018-05-18 omar.polo value "middle" could be supplied.
55 e5186d6b 2018-05-26 omar.polo .It MyMenu.padding
56 e5186d6b 2018-05-26 omar.polo Change the padding. In the horizontal layout the padding is the space
57 e5186d6b 2018-05-26 omar.polo between the rectangle of the completion and the text as well as the
58 e5186d6b 2018-05-26 omar.polo space between the prompt and the first completion. In the horizontal
59 e5186d6b 2018-05-26 omar.polo layout the padding is the horizontal spacing between the window edge
60 e5186d6b 2018-05-26 omar.polo and the text as well as the space up and down the text within the
61 e5186d6b 2018-05-26 omar.polo completion. The default value is 10.
62 f5e234d6 2018-05-18 omar.polo .It MyMenu.prompt.background
63 8758854a 2018-05-20 omar.polo The background of the prompt.
64 f5e234d6 2018-05-18 omar.polo .It MyMenu.prompt.foreground
65 8758854a 2018-05-20 omar.polo The text color (foreground) of the prompt.
66 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion.background
67 8758854a 2018-05-20 omar.polo The background of the completions.
68 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion.foreground
69 8758854a 2018-05-20 omar.polo The text color of the completions.
70 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion_highlighted.background
71 8758854a 2018-05-20 omar.polo The background of the selected completion.
72 f5e234d6 2018-05-18 omar.polo .It MyMenu.completion_highlighted.foreground
73 8758854a 2018-05-20 omar.polo The foreground of the selected completion.
76 f5e234d6 2018-05-18 omar.polo .Sh KEYS
77 f5e234d6 2018-05-18 omar.polo .Bl -tag -width indent-two
78 f5e234d6 2018-05-18 omar.polo .It Esc
79 f5e234d6 2018-05-18 omar.polo Close the menu without selecting any entry
80 f5e234d6 2018-05-18 omar.polo .It Enter
81 f5e234d6 2018-05-18 omar.polo Close the menu and print to stdout what the user typed
82 347d23da 2018-05-19 omar.polo .It C-m
83 347d23da 2018-05-19 omar.polo The same as Enter
84 f5e234d6 2018-05-18 omar.polo .It Tab
85 f5e234d6 2018-05-18 omar.polo Expand the prompt to the next possible completion
86 f5e234d6 2018-05-18 omar.polo .It Shift Tab
87 f5e234d6 2018-05-18 omar.polo Expand the prompt to the previous possible completion
88 8ecd98cc 2018-05-25 omar.polo .It C-n
89 8ecd98cc 2018-05-25 omar.polo The same as Tab
90 8ecd98cc 2018-05-25 omar.polo .It C-p
91 8ecd98cc 2018-05-25 omar.polo The same as Shift-Tab
92 f5e234d6 2018-05-18 omar.polo .It Backspace
93 f5e234d6 2018-05-18 omar.polo Delete the last character
94 347d23da 2018-05-19 omar.polo .It C-h
95 347d23da 2018-05-19 omar.polo The same as Backspace
96 347d23da 2018-05-19 omar.polo .It C-w
97 347d23da 2018-05-19 omar.polo Delete the last word
98 347d23da 2018-05-19 omar.polo .It C-u
99 347d23da 2018-05-19 omar.polo Delete the whole line
102 f5e234d6 2018-05-18 omar.polo .Sh BUGS
103 f5e234d6 2018-05-18 omar.polo .Bl -bullet
105 f5e234d6 2018-05-18 omar.polo If, instead of a numeric value, a not-valid number that terminates
106 f5e234d6 2018-05-18 omar.polo with the % sign is supplied, then the default value for that field
107 f5e234d6 2018-05-18 omar.polo will be treated as a percentage. Since this is a misuse of the
108 f5e234d6 2018-05-18 omar.polo resources this behavior isn't strictly considered a bug.
110 9e94fcbe 2018-05-22 omar.polo C-w (delete last word) does not work well with multi-byte string. The
111 9e94fcbe 2018-05-22 omar.polo whole UTF-8 support is still kinda naïve and should be improved.
114 f5e234d6 2018-05-18 omar.polo .Sh EXIT STATUS
116 f5e234d6 2018-05-18 omar.polo 0 when the user select an entry, 1 when the user press Esc and
117 f5e234d6 2018-05-18 omar.polo EX_UNAVAILABLE if the connection to X fails.
119 f5e234d6 2018-05-18 omar.polo .Sh SEE ALSO
120 f5e234d6 2018-05-18 omar.polo .Xr dmenu 1
121 f5e234d6 2018-05-18 omar.polo .Xr sysexits 3
123 f5e234d6 2018-05-18 omar.polo .Sh AUTHORS
124 f5e234d6 2018-05-18 omar.polo .An Omar Polo <omar.polo@europecom.net>
