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