sync code-style patch from libsl
[dmenu.git] / dmenu.1
blob323f93cf88eee5bd4878cf78cf40d9677277916c
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 ]
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.
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 if not reading from a tty. This
45 is faster, but will lock up 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.
103 .B Ctrl-Left
104 Move cursor to the start of the current word
106 .B Ctrl-Right
107 Move cursor to the end of the current word
109 .B C\-a
110 Home
112 .B C\-b
113 Left
115 .B C\-c
116 Escape
118 .B C\-d
119 Delete
121 .B C\-e
124 .B C\-f
125 Right
127 .B C\-g
128 Escape
130 .B C\-h
131 Backspace
133 .B C\-i
136 .B C\-j
137 Return
139 .B C\-J
140 Shift-Return
142 .B C\-k
143 Delete line right
145 .B C\-m
146 Return
148 .B C\-M
149 Shift-Return
151 .B C\-n
152 Down
154 .B C\-p
157 .B C\-u
158 Delete line left
160 .B C\-w
161 Delete word left
163 .B C\-y
164 Paste from primary X selection
166 .B C\-Y
167 Paste from X clipboard
169 .B M\-b
170 Move cursor to the start of the current word
172 .B M\-f
173 Move cursor to the end of the current word
175 .B M\-g
176 Home
178 .B M\-G
181 .B M\-h
184 .B M\-j
185 Page down
187 .B M\-k
188 Page up
190 .B M\-l
191 Down
192 .SH SEE ALSO
193 .IR dwm (1),
194 .IR stest (1)