ordered switch branches in kpress alphabetically, applied Sanders patch for PgUp...
[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 [ \-font " <name>"]
7 .RB [ \-normbg " <color>"]
8 .RB [ \-normfg " <color>"]
9 .RB [ \-selbg " <color>"]
10 .RB [ \-selfg " <color>"]
11 .RB [ \-t " <seconds>"]
12 .RB [ \-v ]
13 .SH DESCRIPTION
14 .SS Overview
15 dmenu is a generic menu for X, originally designed for
16 .BR dwm (1).
17 It manages huge amounts (up to 10.000 and more) of user defined menu items
18 efficiently.
19 .SS Options
20 .TP
21 .B \-font <name>
22 defines the font.
23 .TP
24 .B \-normbg <color>
25 defines the normal background color (#RGB, #RRGGBB, and color names are supported).
26 .TP
27 .B \-normfg <color>
28 defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
29 .TP
30 .B \-selbg <color>
31 defines the selected background color (#RGB, #RRGGBB, and color names are supported).
32 .TP
33 .B \-selfg <color>
34 defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
35 .TP
36 .B \-t <seconds>
37 defines the seconds to wait for standard input, before exiting (default is 3).
38 .TP
39 .B \-v
40 prints version information to standard output, then exits.
41 .SH USAGE
42 dmenu reads a list of newline-separated items from standard input and creates a
43 menu.  When the user selects an item or enters any text and presses Return, his/her
44 choice is printed to standard output and dmenu terminates.
45 .P
46 dmenu is completely controlled by the keyboard. The following keys are recognized:
47 .TP
48 .B Any printable character
49 Appends the character to the text in the input field.  This works as a filter:
50 only items containing this text will be displayed.
51 .TP
52 .B Left/Right
53 Select the previous/next item.
54 .TP
55 .B PageUp/PageDown
56 Select the first item of the previous/next 'page' of items.
57 .TP
58 .B Home/End
59 Select the first/last item.
60 .TP
61 .B Tab
62 Copy the selected item to the input field.
63 .TP
64 .B Return
65 Confirm selection and quit (print the selected item to standard output). Returns
66 .B 0
67 on termination.
68 .TP
69 .B Shift-Return
70 Confirm selection and quit (print the text in the input field to standard output).
71 Returns
72 .B 0
73 on termination.
74 .TP
75 .B Escape
76 Quit without selecting an item. Returns
77 .B 1
78 on termination.
79 .TP
80 .B Backspace (Control-h)
81 Remove enough characters from the input field to change its filtering effect.
82 .TP
83 .B Control-u
84 Remove all characters from the input field.
85 .SH SEE ALSO
86 .BR dwm (1)