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 RESOURCES
16 
17 Most of the appearance of the menu is defined through the \fBX
18 Resource Database\fR.
19 
20 Application specific resources:
21 .Bl -tag -width Ds
22 .It MyMenu.font
23 The font name, only bitmap font are supported. By default is set to
24 "fixed". If compiled with Xft(3) support this will be passed to xft.
25 .It MyMenu.layout
26 The layout of the menu. The possible values are "horizontal" and
27 "vertical", with the default being "horizontal". Every other value
28 than "horizontal" is treated like "vertical", but this is kinda an
29 implementation detail and not something to be relied on, since in the
30 future other layout could be added as well.
31 .It Mymenu.prompt
32 A string that is rendered before the user input. Default to "$ ".
33 .It MyMenu.width
34 The width of the menu. If a numeric value is given (e.g. 400) is
35 interpreted as pixel, if it ends with a percentage symbol `%'
36 (e.g. 40%) the relative percentage will be computed (relative to the
37 monitor width).
38 .It MyMenu.height
39 The height of the menu. Like MyMenu.width if a numeric value is given
40 is interpreted as pixel, if it ends with a percentage symbol `%' the
41 relative percentage will be computed (relative to the monitor height).
42 .It MyMenu.x
43 The X coordinate of the topmost left corner of the window. Much like
44 MyMenu.height and MyMenu.width both a pixel dimension and percentage
45 could be supplied. In addition to it, the special value "middle" could
46 be used: in that case the window will be centered on the x axes.
47 .It MyMenu.y
48 The Y coordinate of the topmost left corner of the window. Like the X
49 coordinate, pixel dimension, percentage dimension and the special
50 value "middle" could be supplied.
51 .It MyMenu.prompt.background
52 The background of the prompt.
53 .It MyMenu.prompt.foreground
54 The text color (foreground) of the prompt.
55 .It MyMenu.completion.background
56 The background of the completions.
57 .It MyMenu.completion.foreground
58 The text color of the completions.
59 .It MyMenu.completion_highlighted.background
60 The background of the selected completion.
61 .It MyMenu.completion_highlighted.foreground
62 The foreground of the selected completion.
63 .El
64 
65 .Sh KEYS
66 .Bl -tag -width indent-two
67 .It Esc
68 Close the menu without selecting any entry
69 .It Enter
70 Close the menu and print to stdout what the user typed
71 .It C-m
72 The same as Enter
73 .It Tab
74 Expand the prompt to the next possible completion
75 .It Shift Tab
76 Expand the prompt to the previous possible completion
77 .It Backspace
78 Delete the last character
79 .It C-h
80 The same as Backspace
81 .It C-w
82 Delete the last word
83 .It C-u
84 Delete the whole line
85 .El
86 
87 .Sh BUGS
88 .Bl -bullet
89 .It
90 If, instead of a numeric value, a not-valid number that terminates
91 with the % sign is supplied, then the default value for that field
92 will be treated as a percentage. Since this is a misuse of the
93 resources this behavior isn't strictly considered a bug.
94 .El
95 
96 .Sh EXIT STATUS
97 
98 0 when the user select an entry, 1 when the user press Esc and
99 EX_UNAVAILABLE if the connection to X fails.
100 
101 .Sh SEE ALSO
102 .Xr dmenu 1
103 .Xr sysexits 3
104 
105 .Sh AUTHORS
106 .An Omar Polo <omar.polo@europecom.net>
107