dmenu.1: group single options
[dmenu.git] / dmenu.1
1 .TH DMENU 1 dmenu\-VERSION
2 .SH NAME
3 dmenu \- dynamic menu
4 .SH SYNOPSIS
5 .B dmenu
6 .RB [ \-bfiv ]
7 .RB [ \-l
8 .IR lines ]
9 .RB [ \-m
10 .IR monitor ]
11 .RB [ \-p
12 .IR prompt ]
13 .RB [ \-fn
14 .IR font ]
15 .RB [ \-nb
16 .IR color ]
17 .RB [ \-nf
18 .IR color ]
19 .RB [ \-sb
20 .IR color ]
21 .RB [ \-sf
22 .IR color ]
23 .P
24 .BR dmenu_run " ..."
25 .SH DESCRIPTION
26 .B dmenu
27 is a dynamic menu for X, which reads a list of newline\-separated items from
28 stdin.  When the user selects an item and presses Return, their choice is printed
29 to stdout and dmenu terminates.  Entering text will narrow the items to those
30 matching the tokens in the input.
31 .P
32 .B dmenu_run
33 is a script used by
34 .IR dwm (1)
35 which lists programs in the user's $PATH and runs the result in their $SHELL.
36 .SH OPTIONS
37 .TP
38 .B \-b
39 dmenu appears at the bottom of the screen.
40 .TP
41 .B \-f
42 dmenu grabs the keyboard before reading stdin.  This is faster, but will lock up
43 X until stdin reaches end\-of\-file.
44 .TP
45 .B \-i
46 dmenu matches menu items case insensitively.
47 .TP
48 .BI \-l " lines"
49 dmenu lists items vertically, with the given number of lines.
50 .TP
51 .BI \-m " monitor"
52 dmenu is displayed on the monitor number supplied. Monitor numbers are starting
53 from 0.
54 .TP
55 .BI \-p " prompt"
56 defines the prompt to be displayed to the left of the input field.
57 .TP
58 .BI \-fn " font"
59 defines the font or font set used.
60 .TP
61 .BI \-nb " color"
62 defines the normal background color.
63 .IR #RGB ,
64 .IR #RRGGBB ,
65 and X color names are supported.
66 .TP
67 .BI \-nf " color"
68 defines the normal foreground color.
69 .TP
70 .BI \-sb " color"
71 defines the selected background color.
72 .TP
73 .BI \-sf " color"
74 defines the selected foreground color.
75 .TP
76 .B \-v
77 prints version information to stdout, then exits.
78 .SH USAGE
79 dmenu is completely controlled by the keyboard.  Items are selected using the
80 arrow keys, page up, page down, home, and end.
81 .TP
82 .B Tab
83 Copy the selected item to the input field.
84 .TP
85 .B Return
86 Confirm selection.  Prints the selected item to stdout and exits, returning
87 success.
88 .TP
89 .B Ctrl-Return
90 Confirm selection.  Prints the selected item to stdout and continues.
91 .TP
92 .B Shift\-Return
93 Confirm input.  Prints the input text to stdout and exits, returning success.
94 .TP
95 .B Escape
96 Exit without selecting an item, returning failure.
97 .TP
98 C\-a
99 Home
100 .TP
101 C\-b
102 Left
103 .TP
104 C\-c
105 Escape
106 .TP
107 C\-d
108 Delete
109 .TP
110 C\-e
111 End
112 .TP
113 C\-f
114 Right
115 .TP
116 C\-g
117 Escape
118 .TP
119 C\-h
120 Backspace
121 .TP
122 C\-i
123 Tab
124 .TP
125 C\-j
126 Return
127 .TP
128 C\-J
129 Shift-Return
130 .TP
131 C\-k
132 Delete line right
133 .TP
134 C\-m
135 Return
136 .TP
137 C\-M
138 Shift-Return
139 .TP
140 C\-n
141 Down
142 .TP
143 C\-p
144 Up
145 .TP
146 C\-u
147 Delete line left
148 .TP
149 C\-w
150 Delete word left
151 .TP
152 C\-y
153 Paste from primary X selection
154 .TP
155 C\-Y
156 Paste from X clipboard
157 .TP
158 M\-g
159 Home
160 .TP
161 M\-G
162 End
163 .TP
164 M\-h
165 Up
166 .TP
167 M\-j
168 Page down
169 .TP
170 M\-k
171 Page up
172 .TP
173 M\-l
174 Down
175 .SH SEE ALSO
176 .IR dwm (1),
177 .IR stest (1)