]> git.armaanb.net Git - dmenu.git/blob - dmenu.1
Remove config.def.h
[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 .RB [ \-nhb
24 .IR color ]
25 .RB [ \-nhf
26 .IR color ]
27 .RB [ \-shb
28 .IR color ]
29 .RB [ \-shf
30 .IR color ]
31 .RB [ \-w
32 .IR windowid ]
33 .P
34 .BR dmenu_run " ..."
35 .SH DESCRIPTION
36 .B dmenu
37 is a dynamic menu for X, which reads a list of newline\-separated items from
38 stdin.  When the user selects an item and presses Return, their choice is printed
39 to stdout and dmenu terminates.  Entering text will narrow the items to those
40 matching the tokens in the input.
41 .P
42 .B dmenu_run
43 is a script used by
44 .IR dwm (1)
45 which lists programs in the user's $PATH and runs the result in their $SHELL.
46 .SH OPTIONS
47 .TP
48 .B \-b
49 dmenu appears at the bottom of the screen.
50 .TP
51 .B \-f
52 dmenu grabs the keyboard before reading stdin if not reading from a tty. This
53 is faster, but will lock up X until stdin reaches end\-of\-file.
54 .TP
55 .B \-i
56 dmenu matches menu items case insensitively.
57 .TP
58 .BI \-l " lines"
59 dmenu lists items vertically, with the given number of lines.
60 .TP
61 .BI \-m " monitor"
62 dmenu is displayed on the monitor number supplied. Monitor numbers are starting
63 from 0.
64 .TP
65 .BI \-p " prompt"
66 defines the prompt to be displayed to the left of the input field.
67 .TP
68 .BI \-fn " font"
69 defines the font or font set used.
70 .TP
71 .BI \-nb " color"
72 defines the normal background color.
73 .IR #RGB ,
74 .IR #RRGGBB ,
75 and X color names are supported.
76 .TP
77 .BI \-nf " color"
78 defines the normal foreground color.
79 .TP
80 .BI \-sb " color"
81 defines the selected background color.
82 .TP
83 .BI \-sf " color"
84 defines the selected foreground color.
85 .TP
86 .BI \-nhb " color"
87 defines the normal highlight background color.
88 .TP
89 .BI \-nhf " color"
90 defines the normal highlight foreground color.
91 .TP
92 .BI \-shb " color"
93 defines the selected highlight background color.
94 .TP
95 .BI \-shf " color"
96 defines the selected highlight foreground color.
97 .TP
98 .B \-v
99 prints version information to stdout, then exits.
100 .TP
101 .BI \-w " windowid"
102 embed into windowid.
103 .SH USAGE
104 dmenu is completely controlled by the keyboard.  Items are selected using the
105 arrow keys, page up, page down, home, and end.
106 .TP
107 .B Tab
108 Copy the selected item to the input field.
109 .TP
110 .B Return
111 Confirm selection.  Prints the selected item to stdout and exits, returning
112 success.
113 .TP
114 .B Ctrl-Return
115 Confirm selection.  Prints the selected item to stdout and continues.
116 .TP
117 .B Shift\-Return
118 Confirm input.  Prints the input text to stdout and exits, returning success.
119 .TP
120 .B Escape
121 Exit without selecting an item, returning failure.
122 .TP
123 .B Ctrl-Left
124 Move cursor to the start of the current word
125 .TP
126 .B Ctrl-Right
127 Move cursor to the end of the current word
128 .TP
129 .B C\-a
130 Home
131 .TP
132 .B C\-b
133 Left
134 .TP
135 .B C\-c
136 Escape
137 .TP
138 .B C\-d
139 Delete
140 .TP
141 .B C\-e
142 End
143 .TP
144 .B C\-f
145 Right
146 .TP
147 .B C\-g
148 Escape
149 .TP
150 .B C\-h
151 Backspace
152 .TP
153 .B C\-i
154 Tab
155 .TP
156 .B C\-j
157 Return
158 .TP
159 .B C\-J
160 Shift-Return
161 .TP
162 .B C\-k
163 Delete line right
164 .TP
165 .B C\-m
166 Return
167 .TP
168 .B C\-M
169 Shift-Return
170 .TP
171 .B C\-n
172 Down
173 .TP
174 .B C\-p
175 Up
176 .TP
177 .B C\-u
178 Delete line left
179 .TP
180 .B C\-w
181 Delete word left
182 .TP
183 .B C\-y
184 Paste from primary X selection
185 .TP
186 .B C\-Y
187 Paste from X clipboard
188 .TP
189 .B M\-b
190 Move cursor to the start of the current word
191 .TP
192 .B M\-f
193 Move cursor to the end of the current word
194 .TP
195 .B M\-g
196 Home
197 .TP
198 .B M\-G
199 End
200 .TP
201 .B M\-h
202 Up
203 .TP
204 .B M\-j
205 Page down
206 .TP
207 .B M\-k
208 Page up
209 .TP
210 .B M\-l
211 Down
212 .SH SEE ALSO
213 .IR dwm (1),
214 .IR stest (1)