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