6 .Nd simple menu for XOrg
31 utility a simple graphical menu for XOrg. It read the items from
33 and print the user selection to
37 The following options are available and take the maximum precedence
38 over the (respective) ones defined in the
39 .Sy X Resource Database
40 .Bl -tag -width indent-two
42 Print a small usage message to stderr.
44 Print version and exit.
46 The first completion (if any) is always selected. This is like dmenu.
50 Override the positioning on the X axis, parsed as the resource MyMenu.x
52 Override the positioning on the Y axis, parsed as the resource MyMenu.y
54 Override the padding. See the MyMenu.padding resource.
56 Override the layout. Parsed as MyMenu.layout.
58 Override the font. See MyMenu.font.
60 Override the width. Parsed as MyMenu.width.
62 Override the height. Parsed as MyMenu.height.
64 Override the borders size. Parsed as MyMenu.border.size.
66 Override the borders color. Parsed as MyMenu.border.color.
68 Override the prompt foreground color. See MyMenu.prompt.foreground.
70 Override the prompt background color. See MyMenu.prompt.background.
72 Override the completion foreground color. See MyMenu.completion.foreground.
74 Override the completion background color. See MyMenu.completion.background.
76 Override the highlighted completion foreground color. See MyMenu.completion_highlighted.foreground.
78 Override the highlighted completion background color. See MyMenu.completion_highlighted.background.
83 The font name to use. By default is set to "fixed" if compiled without
84 Xft(3) support, "monospace" otherwise. Without Xft(3) only bitmap font
87 The layout of the menu. The possible values are "horizontal" and
88 "vertical", with the default being "horizontal". Every other value
89 than "horizontal" is treated like "vertical", but this is kinda an
90 implementation detail and not something to be relied on, since in the
91 future other layout could be added as well.
93 A string that is rendered before the user input. Default to "$ ".
95 The width of the menu. If a numeric value is given (e.g. 400) is
96 interpreted as pixel, if it ends with a percentage symbol `%'
97 (e.g. 40%) the relative percentage will be computed (relative to the
100 The height of the menu. Like MyMenu.width if a numeric value is given
101 is interpreted as pixel, if it ends with a percentage symbol `%' the
102 relative percentage will be computed (relative to the monitor height).
104 The X coordinate of the topmost left corner of the window. Much like
105 MyMenu.height and MyMenu.width both a pixel dimension and percentage
106 could be supplied. In addition to it, some special value can be used.
111 Compute the correct value to make sure that mymenu will be
112 horizontally centered;
114 Compute the correct value to make sure that mymenu will be right
118 The Y coordinate of the topmost left corner of the window. Like the X
119 coordinate a pixel dimension, percentage dimension or the special
120 value "start", "middle", "end" could be supplied.
122 Change the padding. In the horizontal layout the padding is the space
123 between the rectangle of the completion and the text as well as the
124 space between the prompt and the first completion. In the horizontal
125 layout the padding is the horizontal spacing between the window edge
126 and the text as well as the space up and down the text within the
127 completion. The default value is 10.
128 .It MyMenu.border.size
129 A list of number separated by spaces to specify the border of the
130 window. The field is parsed like some CSS properties (i.e. padding),
131 that is: if only one value is provided then it'll be used for all
132 borders; if two value are given than the first will be used for the
133 top and bottom border and the former for the left and right border;
134 with three value the first is used for the top border, the second for
135 the left and right border and the third for the bottom border. If four
136 value are given, they'll be applied to the respective border
137 clockwise. Other values will be ignored. The default value is 0.
138 .It MyMenu.border.color
139 A list of colors for the borders. This field is parsed like the
140 MyMenu.border.size. The default value is black.
141 .It MyMenu.prompt.background
142 The background of the prompt.
143 .It MyMenu.prompt.foreground
144 The text color (foreground) of the prompt.
145 .It MyMenu.completion.background
146 The background of the completions.
147 .It MyMenu.completion.foreground
148 The text color of the completions.
149 .It MyMenu.completion_highlighted.background
150 The background of the selected completion.
151 .It MyMenu.completion_highlighted.foreground
152 The foreground of the selected completion.
156 This is the list of keybinding recognized by
158 In the following examples, C-c means Control-c.
159 .Bl -tag -width indent-two
161 Close the menu without selecting any entry
165 Close the menu and print to stdout what the user typed
169 Expand the prompt to the next possible completion
171 Expand the prompt to the previous possible completion
175 The same as Shift-Tab
177 Delete the last character
179 The same as Backspace
183 Delete the whole line
185 Toggle the ``first selected'' style. Sometimes, especially with the -a
186 option, could be handy to disable that behaviour. Let's say that
187 you've typed ``fire'' and the first completion is ``firefox'' but you
188 really want to choose ``fire''. While you can type some spaces, this
189 keybinding is a more elegant way to change, at runtime, the behaviour
190 of the first completion.
196 If, instead of a numeric value, a not-valid number that terminates
197 with the % sign is supplied, then the default value for that field
198 will be treated as a percentage. Since this is a misuse of the
199 resources this behavior isn't strictly considered a bug.
201 C-w (delete last word) does not work well with multi-byte string. The
202 whole UTF-8 support is still kinda naïve and should be improved.
204 Keep in mind that sometimes the order of the options matter. First are
205 parsed (if any) the xrdb options, then the command line flags
206 .Sy in the provided order!
207 That meas that if you're providing first the x coordinate, let's say
210 you are overriding the width, the window
214 As a general rule of thumb, if you're overriding the width and/or the
215 height of the window, remember to override the x and y coordinates as
221 0 when the user select an entry, 1 when the user press Esc, EX_USAGE
222 if used with wrong flags and EX_UNAVAILABLE if the connection to X
230 .An Omar Polo <omar.polo@europecom.net>
