updated manpage
[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 [ \-i ]
7 .RB [ \-b ]
8 .RB [ \-e " <xid>]"
9 .RB [ \-l " <lines>]"
10 .RB [ \-fn " <font>]"
11 .RB [ \-nb " <color>]"
12 .RB [ \-nf " <color>]"
13 .RB [ \-p " <prompt>]"
14 .RB [ \-sb " <color>]"
15 .RB [ \-sf " <color>]"
16 .RB [ \-v ]
17 .SH DESCRIPTION
18 .SS Overview
19 dmenu is a generic menu for X, originally designed for
20 .BR dwm (1).
21 It manages huge amounts (up to 10.000 and more) of user defined menu items
22 efficiently.
23 .SS Options
24 .TP
25 .B \-i
26 makes dmenu match menu entries case insensitively.
27 .TP
28 .B \-b
29 defines that dmenu appears at the bottom.
30 .TP
31 .B \-e <xid>
32 reparents dmenu to the window specified by xid.
33 .TP
34 .B \-l <lines>
35 activates vertical list mode.
36 The given number of lines will be displayed. Window height will get adjusted.
37 .TP
38 .B \-fn <font>
39 defines the font.
40 .TP
41 .B \-nb <color>
42 defines the normal background color (#RGB, #RRGGBB, and color names are supported).
43 .TP
44 .B \-nf <color>
45 defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
46 .TP
47 .B \-p <prompt>
48 defines a prompt to be displayed before the input area.
49 .TP
50 .B \-sb <color>
51 defines the selected background color (#RGB, #RRGGBB, and color names are supported).
52 .TP
53 .B \-sf <color>
54 defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
55 .TP
56 .B \-v
57 prints version information to standard output, then exits.
58 .SH USAGE
59 dmenu reads a list of newline-separated items from standard input and creates a
60 menu.  When the user selects an item or enters any text and presses Return, his/her
61 choice is printed to standard output and dmenu terminates.
62 .P
63 dmenu is completely controlled by the keyboard. The following keys are recognized:
64 .TP
65 .B Any printable character
66 Appends the character to the text in the input field.  This works as a filter:
67 only items containing this text will be displayed.
68 .TP
69 .B Left/Right (Up/Down) (Mod1\-h/Mod1\-l)
70 Select the previous/next item.
71 .TP
72 .B PageUp/PageDown (Mod1\-k/Mod1\-j)
73 Select the first item of the previous/next 'page' of items.
74 .TP
75 .B Home/End (Mod1\-g/Mod1\-G)
76 Select the first/last item.
77 .TP
78 .B Tab (Control\-i)
79 Copy the selected item to the input field.
80 .TP
81 .B Return (Control\-j)
82 Confirm selection and quit (print the selected item to standard output). Returns
83 .B 0
84 on termination.
85 .TP
86 .B Shift\-Return (Control\-Shift\-j)
87 Confirm selection and quit (print the text in the input field to standard output).
88 Returns
89 .B 0
90 on termination.
91 .TP
92 .B Escape (Control\-bracketleft)
93 Quit without selecting an item. Returns
94 .B 1
95 on termination.
96 .TP
97 .B Backspace (Control\-h)
98 Remove a character from the input field.
99 .TP
100 .B Control\-u
101 Remove all characters from the input field.
102 .TP
103 .B Control\-w
104 Remove all characters of current word from the input field.
105 .SH SEE ALSO
106 .BR dwm (1),
107 .BR wmii (1) .