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