]> git.armaanb.net Git - dmenu.git/blob - dmenu.1
Switch to a light theme
[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 [ \-bfivP ]
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 .B \-P
59 dmenu will not directly display the keyboard input, but instead replace it with dots. All data from stdin will be ignored.
60 .TP
61 .BI \-l " lines"
62 dmenu lists items vertically, with the given number of lines.
63 .TP
64 .BI \-m " monitor"
65 dmenu is displayed on the monitor number supplied. Monitor numbers are starting
66 from 0.
67 .TP
68 .BI \-p " prompt"
69 defines the prompt to be displayed to the left of the input field.
70 .TP
71 .BI \-fn " font"
72 defines the font or font set used.
73 .TP
74 .BI \-nb " color"
75 defines the normal background color.
76 .IR #RGB ,
77 .IR #RRGGBB ,
78 and X color names are supported.
79 .TP
80 .BI \-nf " color"
81 defines the normal foreground color.
82 .TP
83 .BI \-sb " color"
84 defines the selected background color.
85 .TP
86 .BI \-sf " color"
87 defines the selected foreground color.
88 .TP
89 .BI \-nhb " color"
90 defines the normal highlight background color.
91 .TP
92 .BI \-nhf " color"
93 defines the normal highlight foreground color.
94 .TP
95 .BI \-shb " color"
96 defines the selected highlight background color.
97 .TP
98 .BI \-shf " color"
99 defines the selected highlight foreground color.
100 .TP
101 .B \-v
102 prints version information to stdout, then exits.
103 .TP
104 .BI \-w " windowid"
105 embed into windowid.
106 .SH USAGE
107 dmenu is completely controlled by the keyboard.  Items are selected using the
108 arrow keys, page up, page down, home, and end.
109 .TP
110 .B Tab
111 Copy the selected item to the input field.
112 .TP
113 .B Return
114 Confirm selection.  Prints the selected item to stdout and exits, returning
115 success.
116 .TP
117 .B Ctrl-Return
118 Confirm selection.  Prints the selected item to stdout and continues.
119 .TP
120 .B Shift\-Return
121 Confirm input.  Prints the input text to stdout and exits, returning success.
122 .TP
123 .B Escape
124 Exit without selecting an item, returning failure.
125 .TP
126 .B Ctrl-Left
127 Move cursor to the start of the current word
128 .TP
129 .B Ctrl-Right
130 Move cursor to the end of the current word
131 .TP
132 .B C\-a
133 Home
134 .TP
135 .B C\-b
136 Left
137 .TP
138 .B C\-c
139 Escape
140 .TP
141 .B C\-d
142 Delete
143 .TP
144 .B C\-e
145 End
146 .TP
147 .B C\-f
148 Right
149 .TP
150 .B C\-g
151 Escape
152 .TP
153 .B C\-h
154 Backspace
155 .TP
156 .B C\-i
157 Tab
158 .TP
159 .B C\-j
160 Return
161 .TP
162 .B C\-J
163 Shift-Return
164 .TP
165 .B C\-k
166 Delete line right
167 .TP
168 .B C\-m
169 Return
170 .TP
171 .B C\-M
172 Shift-Return
173 .TP
174 .B C\-n
175 Down
176 .TP
177 .B C\-p
178 Up
179 .TP
180 .B C\-u
181 Delete line left
182 .TP
183 .B C\-w
184 Delete word left
185 .TP
186 .B C\-y
187 Paste from primary X selection
188 .TP
189 .B C\-Y
190 Paste from X clipboard
191 .TP
192 .B M\-b
193 Move cursor to the start of the current word
194 .TP
195 .B M\-f
196 Move cursor to the end of the current word
197 .TP
198 .B M\-g
199 Home
200 .TP
201 .B M\-G
202 End
203 .TP
204 .B M\-h
205 Up
206 .TP
207 .B M\-j
208 Page down
209 .TP
210 .B M\-k
211 Page up
212 .TP
213 .B M\-l
214 Down
215 .SH SEE ALSO
216 .IR dwm (1),
217 .IR stest (1)