Blame


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