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