5a83c7dc |
1 | .TH XMENU 1 |
08f16589 |
2 | .SH NAME |
3 | xmenu \- menu utility for X |
4 | .SH SYNOPSIS |
5 | .B xmenu |
78fb523f |
6 | .RB [ \-irw ] |
05cfe1a0 |
7 | .RB [ -p |
8 | .IR position ] |
3bec05ea |
9 | .RI [ title ] |
08f16589 |
10 | .SH DESCRIPTION |
11 | .B xmenu |
12 | is a menu for X, |
13 | it reads a list of newline-separated items from stdin, |
14 | shows a menu for the user to select one of the items, |
15 | and outputs the item selected to stdout. |
16 | .PP |
3bec05ea |
17 | The options are as follows: |
18 | .TP |
71b4db92 |
19 | .B -i |
20 | Disable icons. |
7832d2cf |
21 | This makes xmenu loading faster when not using icons. |
71b4db92 |
22 | .TP |
05cfe1a0 |
23 | .BI -p " position" |
24 | Set the position to spawn xmenu. |
25 | Without this option, xmenu spawns next to the cursor. |
26 | .I position |
27 | is a string of the form |
237da982 |
28 | .BR INTxINT[:MONITOR] , |
05cfe1a0 |
29 | where the first INT is the x position and the second INT is the y position. |
237da982 |
30 | The monitor part between brackets is optional. |
31 | .B MONITOR |
32 | can be a number from 0 to the number of monitors minus 1; |
33 | or it can be a string like |
34 | .B current |
35 | or |
36 | .BR cursor . |
37 | If present, the monitor specifies that the position is relative to the upper left corner |
38 | of that monitor. |
39 | If |
40 | .B monitor |
41 | is |
42 | .B current |
43 | or |
44 | .BR cursor , |
45 | the monitor to be used is that where the cursor is in. |
46 | For example, |
47 | .B -p 0x0:cursor |
48 | specifies that |
49 | .B xmenu |
50 | must spawn at the position 0x0 of the monitor where the cursor is in. |
51 | And |
52 | .B -p 100x500:0 |
53 | specifies that |
54 | .B xmenu |
55 | must spawn at the position 100x500 of the monitor 0. |
05cfe1a0 |
56 | .TP |
1146fd81 |
57 | .B -r |
58 | If this option is set, the right mouse button is disabled; |
59 | so pressing it will not trigger any menu item. |
60 | .TP |
3bec05ea |
61 | .B -w |
62 | Asks the window manager to draw a border around the menus. |
71b4db92 |
63 | This option may be buggy in some window managers, |
64 | specially tiled ones that do not respect window hints. |
3bec05ea |
65 | .PP |
08f16589 |
66 | Each item read from stdin has the following format: |
67 | .IP |
68 | .EX |
33376f54 |
69 | ITEM := [TABS] [[IMAGE TABS] LABEL [TABS OUTPUT]] NEWLINE |
08f16589 |
70 | .EE |
71 | .PP |
6b5123e7 |
72 | That means that each item is composed by |
33376f54 |
73 | tabs, followed by an optional image specification, followed by tabs |
74 | followed by a label, followed by more tabs, followed by an output, |
6b5123e7 |
75 | and ended by a newline. Brackets group optional elements. |
08f16589 |
76 | .IP |
77 | The initial tabs indicate the menu hierarchy: |
78 | items indented with a tab is shown in a submenu of the preceding item not indented. |
6b5123e7 |
79 | An item without initial tabs is a top-level item. |
08f16589 |
80 | .IP |
33376f54 |
81 | The image is a string of the form "IMG:/path/to/image.png". |
82 | It specifies a image to be shown as icon at the left of the entry. |
83 | .IP |
08f16589 |
84 | The label is the string that will be shown as a item in the menu. |
85 | An item without label is considered a separator and is drawn as a thin line in the menu |
86 | separating the item above from the item below. |
87 | .IP |
6b5123e7 |
88 | The output is the string that will be output after selecting the item. |
89 | If an item does not have an output, its label is used as its output. |
08f16589 |
90 | .IP |
91 | The newline terminates the item specification. |
3bec05ea |
92 | .PP |
93 | If the argument |
94 | .I title |
95 | is given, the title of the menu window is set to it. |
858338d9 |
96 | .SH USAGE |
97 | .B xmenu |
98 | is controlled by the mouse, |
99 | but can also be controlled by the keyboard. |
100 | Items can be selected using the arrow keys, |
101 | Tab (with and without Shift), |
45115feb |
102 | Home, End, |
2b0484b1 |
103 | Enter and Esc, and 1-9 keys. |
78fb523f |
104 | Items can also be selected by typing the first several characters in it. |
858338d9 |
105 | .TP |
45115feb |
106 | .BR Home |
107 | Select the first item in the menu. |
108 | .TP |
109 | .BR End |
110 | Select the last item in the menu. |
111 | .TP |
28f784a7 |
112 | .BR Down |
113 | Cycle through the items in the regular direction. |
114 | .TP |
115 | .BR Tab |
858338d9 |
116 | Cycle through the items in the regular direction. |
78fb523f |
117 | When the type\-to\-select feature is active, cycle through matching items instead. |
28f784a7 |
118 | .TP |
119 | .BR Up |
120 | Cycle through the items in the reverse direction. |
858338d9 |
121 | .TP |
28f784a7 |
122 | .BR Shift-Tab |
858338d9 |
123 | Cycle through the items in the reverse direction. |
78fb523f |
124 | When the type\-to\-select feature is active, cycle through matching items instead. |
858338d9 |
125 | .TP |
126 | .BR Right ", " Enter |
127 | Select the highlighted item. |
128 | .TP |
129 | .B Left |
130 | Go to the menu above. |
131 | .TP |
132 | .B Esc |
133 | Go to the menu above or exit xmenu. |
45115feb |
134 | .PP |
78fb523f |
135 | .B xmenu |
136 | features the type\-to\-select selecting style, |
137 | where typing a string will select the first item matching it. |
138 | .PP |
45115feb |
139 | Additional key bindings can be set at compile time by changing the |
140 | .B config.h |
141 | file. |
f644b8bc |
142 | .SH RESOURCES |
143 | .B |
144 | xmenu |
145 | understands the following X resources. |
146 | .TP |
147 | .B xmenu.font |
148 | The font in which the labels should be drawn. |
cdeaefaa |
149 | Multiple fonts can be added as fallback fonts; |
150 | they must be separated by a comma. |
f644b8bc |
151 | .TP |
152 | .B xmenu.background |
5a83c7dc |
153 | The background color of non-selected items in the menu. |
f644b8bc |
154 | .TP |
155 | .B xmenu.foreground |
5a83c7dc |
156 | The color of the label text of non-selected items in the menu. |
f644b8bc |
157 | .TP |
158 | .B xmenu.selbackground |
5a83c7dc |
159 | The background color of selected items in the menu. |
f644b8bc |
160 | .TP |
161 | .B xmenu.selforeground |
5a83c7dc |
162 | The color of the label text of selected items in the menu. |
f644b8bc |
163 | .TP |
164 | .B xmenu.border |
165 | The color of the border around the menu. |
166 | .TP |
167 | .B xmenu.separator |
5a83c7dc |
168 | The color of the separator between items in the menu. |
f644b8bc |
169 | .TP |
92e7609b |
170 | .B xmenu.gap |
171 | The gap, in pixels, between the menus. |
172 | .TP |
f644b8bc |
173 | .B xmenu.width |
174 | The minimum width, in pixels, of the items in the menu. |
175 | .TP |
685ca30d |
176 | .B xmenu.height |
177 | The size in pixels of the height of a single menu item. |
f644b8bc |
178 | .TP |
fd530f3f |
179 | .B xmenu.borderWidth |
f644b8bc |
180 | The size in pixels of the border around the menu. |
181 | .TP |
fd530f3f |
182 | .B xmenu.separatorWidth |
f644b8bc |
183 | The size in pixels of the item separator. |
27c03246 |
184 | .TP |
185 | .B xmenu.alignment |
186 | If set to |
187 | .BR "\(dqleft\(dq" , |
188 | .BR "\(dqcenter\(dq" , |
189 | or |
190 | .BR "\(dqright\(dq" , |
191 | text is aligned to the left, center, or right of the menu, respectively. |
192 | By default, text is aligned to the left. |
f644b8bc |
193 | |
08f16589 |
194 | .SH EXAMPLES |
d584fba6 |
195 | The following script illustrates the use of |
08f16589 |
196 | .BR xmenu . |
c49dad28 |
197 | The output is redirected to |
198 | .IR sh (1), |
199 | creating a command to be run by the shell. |
08f16589 |
200 | .IP |
201 | .EX |
202 | #!/bin/sh |
203 | |
6b5123e7 |
204 | cat <<EOF | xmenu | sh & |
08f16589 |
205 | Applications |
33376f54 |
206 | IMG:./web.png Web Browser firefox |
d584fba6 |
207 | IMG:./gimp.png Image editor gimp |
33376f54 |
208 | Terminal (xterm) xterm |
209 | Terminal (urxvt) urxvt |
210 | Terminal (st) st |
08f16589 |
211 | |
33376f54 |
212 | Shutdown poweroff |
213 | Reboot reboot |
08f16589 |
214 | EOF |
215 | .EE |
216 | .PP |
217 | For example, by selecting \(lqApplications\(rq, a new menu will appear. |
d584fba6 |
218 | Selecting \(lqWeb Browser\(rq in the new menu opens firefox. |
08f16589 |
219 | .SH SEE ALSO |
220 | .IR dmenu (1), |
221 | .IR 9menu (1), |
222 | .IR thingmenu (1) |