made dmenu.1 also concise
[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 [ \-v ]
7 .SH DESCRIPTION
8 .SS Overview
9 dmenu is a generic menu for X, originally designed for
10 .BR dwm (1).
11 It manages huge amounts (up to 10.000 and more) of user defined menu items
12 efficiently.
13 .SS Options
14 .TP
15 .B \-v
16 prints version information to standard output, then exits.
17 .SH USAGE
18 dmenu reads a list of newline-separated items from standard input and creates a
19 menu.  When the user selects an item or enters any text and presses Return, his
20 choice is printed to standard output and dmenu terminates.
21 .P
22 dmenu is completely controlled by the keyboard. The following keys are recognized:
23 .TP
24 .B Any printable character
25 Appends the character to the text in the input field.  This works as a filter:
26 only items containing this text will be displayed.
27 .TP
28 .B Left/Right
29 Select the previous/next item.
30 .TP
31 .B Tab
32 Copy the selected item to the input field.
33 .TP
34 .B Return
35 Confirm selection and quit (print the selected item to standard output).
36 .TP
37 .B Shift-Return
38 Confirm selection and quit (print the text in the input field to standard output).
39 .TP
40 .B Escape
41 Quit without selecting an item.
42 .TP
43 .B Backspace (Control-h)
44 Remove enough characters from the input field to change its filtering effect.
45 .TP
46 .B Control-u
47 Remove all characters from the input field.
48 .P
49 dwm returns
50 .B 0
51 if
52 .B Return
53 is pressed and
54 .B 1
55 if
56 .B Escape
57 is pressed on termination.
58 .SH CUSTOMIZATION
59 dmenu is customized by creating a custom config.h and (re)compiling the source
60 code. This keeps it fast, secure and simple.
61 .SH SEE ALSO
62 .BR dwm (1)