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