re-applied Peter Hartlich's and Jukkas dmenu-related patches, for odd reasons they...
[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 [ \-x " <x>"]
8 .RB [ \-y " <y>"]
9 .RB [ \-w " <width>"]
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 \-x
26 defines the x coordinate dmenu appears at (0 by default).
27 .TP
28 .B \-y
29 defines the y coordinate dmenu appears at (0 by default). If it is negative,
30 dmenu will appear with the bottom at the given positive coordinate. If it is
31 -0, dmenu appears at the screen bottom.
32 .TP
33 .B \-w
34 defines the width of the dmenu window (screen width by default).
35 .TP
36 .B \-i
37 makes dmenu match menu entries case insensitively.
38 .TP
39 .B \-fn <font>
40 defines the font.
41 .TP
42 .B \-nb <color>
43 defines the normal background color (#RGB, #RRGGBB, and color names are supported).
44 .TP
45 .B \-nf <color>
46 defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
47 .TP
48 .B \-p <prompt>
49 defines a prompt to be displayed before the input area.
50 .TP
51 .B \-sb <color>
52 defines the selected background color (#RGB, #RRGGBB, and color names are supported).
53 .TP
54 .B \-sf <color>
55 defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
56 .TP
57 .B \-v
58 prints version information to standard output, then exits.
59 .SH USAGE
60 dmenu reads a list of newline-separated items from standard input and creates a
61 menu.  When the user selects an item or enters any text and presses Return, his/her
62 choice is printed to standard output and dmenu terminates.
63 .P
64 dmenu is completely controlled by the keyboard. The following keys are recognized:
65 .TP
66 .B Any printable character
67 Appends the character to the text in the input field.  This works as a filter:
68 only items containing this text will be displayed.
69 .TP
70 .B Left/Right (Mod1\-h/Mod1\-l)
71 Select the previous/next item.
72 .TP
73 .B PageUp/PageDown (Mod1\-k/Mod1\-j)
74 Select the first item of the previous/next 'page' of items.
75 .TP
76 .B Home/End (Mod1\-g/Mod1\-G)
77 Select the first/last item.
78 .TP
79 .B Tab (Control\-i)
80 Copy the selected item to the input field.
81 .TP
82 .B Return (Control\-j)
83 Confirm selection and quit (print the selected item to standard output). Returns
84 .B 0
85 on termination.
86 .TP
87 .B Shift\-Return (Control\-Shift\-j)
88 Confirm selection and quit (print the text in the input field to standard output).
89 Returns
90 .B 0
91 on termination.
92 .TP
93 .B Escape (Control\-bracketleft)
94 Quit without selecting an item. Returns
95 .B 1
96 on termination.
97 .TP
98 .B Backspace (Control\-h)
99 Remove a character from the input field.
100 .TP
101 .B Control\-u
102 Remove all characters from the input field.
103 .TP
104 .B Control\-w
105 Remove all characters of current word from the input field.
106 .SH SEE ALSO
107 .BR dwm (1),
108 .BR wmii (1) .