add embedding support with -w option
[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 \-f
44 dmenu grabs the keyboard before reading stdin.  This is faster, but will lock up
45 X until stdin reaches end\-of\-file.
46 .TP
47 .B \-i
48 dmenu matches menu items case insensitively.
49 .TP
50 .BI \-l " lines"
51 dmenu lists items vertically, with the given number of lines.
52 .TP
53 .BI \-m " monitor"
54 dmenu is displayed on the monitor number supplied. Monitor numbers are starting
55 from 0.
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 .TP
81 .BI \-w " windowid"
82 embed into windowid.
83 .SH USAGE
84 dmenu is completely controlled by the keyboard.  Items are selected using the
85 arrow keys, page up, page down, home, and end.
86 .TP
87 .B Tab
88 Copy the selected item to the input field.
89 .TP
90 .B Return
91 Confirm selection.  Prints the selected item to stdout and exits, returning
92 success.
93 .TP
94 .B Ctrl-Return
95 Confirm selection.  Prints the selected item to stdout and continues.
96 .TP
97 .B Shift\-Return
98 Confirm input.  Prints the input text to stdout and exits, returning success.
99 .TP
100 .B Escape
101 Exit without selecting an item, returning failure.
102 .TP
103 C\-a
104 Home
105 .TP
106 C\-b
107 Left
108 .TP
109 C\-c
110 Escape
111 .TP
112 C\-d
113 Delete
114 .TP
115 C\-e
116 End
117 .TP
118 C\-f
119 Right
120 .TP
121 C\-g
122 Escape
123 .TP
124 C\-h
125 Backspace
126 .TP
127 C\-i
128 Tab
129 .TP
130 C\-j
131 Return
132 .TP
133 C\-J
134 Shift-Return
135 .TP
136 C\-k
137 Delete line right
138 .TP
139 C\-m
140 Return
141 .TP
142 C\-M
143 Shift-Return
144 .TP
145 C\-n
146 Down
147 .TP
148 C\-p
149 Up
150 .TP
151 C\-u
152 Delete line left
153 .TP
154 C\-w
155 Delete word left
156 .TP
157 C\-y
158 Paste from primary X selection
159 .TP
160 C\-Y
161 Paste from X clipboard
162 .TP
163 M\-g
164 Home
165 .TP
166 M\-G
167 End
168 .TP
169 M\-h
170 Up
171 .TP
172 M\-j
173 Page down
174 .TP
175 M\-k
176 Page up
177 .TP
178 M\-l
179 Down
180 .SH SEE ALSO
181 .IR dwm (1),
182 .IR stest (1)