1 .Dd $Mdocdate$
2 .Dt MYMENU 1
3 .Os
4 .Sh NAME
5 .Nm mymenu
6 .Nd simple menu for XOrg
7 .Sh DESCRIPTION
8 The
9 .Nm
10 utility a simple graphical menu for XOrg. It read the items from
11 .Ic stdin
12 and print the user selection to
13 .Ic stdout
14 on exit.
15 .Sh OPTIONS
16 .Bl -tag -width Ds
17 .It Fl a
18 The first completion (if any) is always selected. This is like dmenu.
19 .It Fl h
20 Print a small usage message to stderr.
21 .It Fl v
22 Print version and exit.
23 .El
24 .Sh RESOURCES
25 
26 The appearance of the menu is defined through the \fBX Resource
27 Database\fR.
28 .Bl -tag -width Ds
29 .It MyMenu.font
30 The font name to use. By default is set to "fixed" if compiled without
31 Xft(3) support, "monospace" otherwise. Without Xft(3) only bitmap font
32 are supported.
33 .It MyMenu.layout
34 The layout of the menu. The possible values are "horizontal" and
35 "vertical", with the default being "horizontal". Every other value
36 than "horizontal" is treated like "vertical", but this is kinda an
37 implementation detail and not something to be relied on, since in the
38 future other layout could be added as well.
39 .It Mymenu.prompt
40 A string that is rendered before the user input. Default to "$ ".
41 .It MyMenu.width
42 The width of the menu. If a numeric value is given (e.g. 400) is
43 interpreted as pixel, if it ends with a percentage symbol `%'
44 (e.g. 40%) the relative percentage will be computed (relative to the
45 monitor width).
46 .It MyMenu.height
47 The height of the menu. Like MyMenu.width if a numeric value is given
48 is interpreted as pixel, if it ends with a percentage symbol `%' the
49 relative percentage will be computed (relative to the monitor height).
50 .It MyMenu.x
51 The X coordinate of the topmost left corner of the window. Much like
52 MyMenu.height and MyMenu.width both a pixel dimension and percentage
53 could be supplied. In addition to it, the special value "middle" could
54 be used: in that case the window will be centered on the x axes.
55 .It MyMenu.y
56 The Y coordinate of the topmost left corner of the window. Like the X
57 coordinate a pixel dimension, percentage dimension or the special
58 value "middle" could be supplied.
59 .It MyMenu.padding
60 Change the padding. In the horizontal layout the padding is the space
61 between the rectangle of the completion and the text as well as the
62 space between the prompt and the first completion. In the horizontal
63 layout the padding is the horizontal spacing between the window edge
64 and the text as well as the space up and down the text within the
65 completion. The default value is 10.
66 .It MyMenu.border.size
67 A list of number separated by spaces to specify the border of the
68 window. The field is parsed like some CSS properties (i.e. padding),
69 that is: if only one value is provided then it'll be used for all
70 borders; if two value are given than the first will be used for the
71 top and bottom border and the former for the left and right border;
72 with three value the first is used for the top border, the second for
73 the left and right border and the third for the bottom border. If four
74 value are given, they'll be applied to the respective border
75 clockwise. Other values will be ignored. The default value is 0.
76 .It MyMenu.border.color
77 A list of colors for the borders. This field is parsed like the
78 MyMenu.border.size. The default value is black.
79 .It MyMenu.prompt.background
80 The background of the prompt.
81 .It MyMenu.prompt.foreground
82 The text color (foreground) of the prompt.
83 .It MyMenu.completion.background
84 The background of the completions.
85 .It MyMenu.completion.foreground
86 The text color of the completions.
87 .It MyMenu.completion_highlighted.background
88 The background of the selected completion.
89 .It MyMenu.completion_highlighted.foreground
90 The foreground of the selected completion.
91 .El
92 
93 .Sh KEYS
94 This is the list of keybinding recognized by
95 .Li Nm Ns .
96 In the following examples, C-c means Control-c.
97 .Bl -tag -width indent-two
98 .It Esc
99 Close the menu without selecting any entry
100 .It C-c
101 The same as Esc
102 .It Enter
103 Close the menu and print to stdout what the user typed
104 .It C-m
105 The same as Enter
106 .It Tab
107 Expand the prompt to the next possible completion
108 .It Shift Tab
109 Expand the prompt to the previous possible completion
110 .It C-n
111 The same as Tab
112 .It C-p
113 The same as Shift-Tab
114 .It Backspace
115 Delete the last character
116 .It C-h
117 The same as Backspace
118 .It C-w
119 Delete the last word
120 .It C-u
121 Delete the whole line
122 .It C-i
123 Toggle the ``first selected'' style. Sometimes, especially with the -a
124 option, could be handy to disable that behaviour. Let's say that
125 you've typed ``fire'' and the first completion is ``firefox'' but you
126 really want to choose ``fire''. While you can type some spaces, this
127 keybinding is a more elegant way to change, at runtime, the behaviour
128 of the first completion.
129 .El
130 
131 .Sh BUGS
132 .Bl -bullet
133 .It
134 If, instead of a numeric value, a not-valid number that terminates
135 with the % sign is supplied, then the default value for that field
136 will be treated as a percentage. Since this is a misuse of the
137 resources this behavior isn't strictly considered a bug.
138 .It
139 C-w (delete last word) does not work well with multi-byte string. The
140 whole UTF-8 support is still kinda naïve and should be improved.
141 .El
142 
143 .Sh EXIT STATUS
144 
145 0 when the user select an entry, 1 when the user press Esc, EX_USAGE
146 if used with wrong flags and EX_UNAVAILABLE if the connection to X
147 fails.
148 
149 .Sh SEE ALSO
150 .Xr dmenu 1
151 .Xr sysexits 3
152 
153 .Sh AUTHORS
154 .An Omar Polo <omar.polo@europecom.net>
155