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