updated manpage, added paste, cleaned up, new libdraw
[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 [ \-b ]
7 .RB [ \-i ]
8 .RB [ \-l " <lines>]"
9 .RB [ \-p " <prompt>]"
10 .RB [ \-fn " <font>]"
11 .RB [ \-nb " <color>]"
12 .RB [ \-nf " <color>]"
13 .RB [ \-sb " <color>]"
14 .RB [ \-sf " <color>]"
15 .RB [ \-v ]
16
17 .B dmenu_run
18 .RB [ \-b ]
19 .RB [ \-i ]
20 .RB [ \-l " <lines>]"
21 .RB [ \-p " <prompt>]"
22 .RB [ \-fn " <font>]"
23 .RB [ \-nb " <color>]"
24 .RB [ \-nf " <color>]"
25 .RB [ \-sb " <color>]"
26 .RB [ \-sf " <color>]"
27 .RB [ \-v ]
28
29 .B dmenu_path
30 .SH DESCRIPTION
31 .SS Overview
32 .B dmenu
33 is a generic menu for X, originally designed for
34 .BR dwm (1).
35 It manages huge amounts (10000 and more) of user defined menu items efficiently.
36 .P
37 .B dmenu_run
38 is a dmenu script which lists programs in the user's PATH and executes
39 the selected item.
40 .P
41 .B dmenu_path
42 is a script used by
43 .I dmenu_run
44 to find and cache a list of programs.
45 .SS Options
46 .TP
47 .B \-b
48 dmenu appears at the bottom of the screen.
49 .TP
50 .B \-i
51 dmenu matches menu entries case insensitively.
52 .TP
53 .B \-l <lines>
54 dmenu lists items vertically, with the given number of lines.
55 .TP
56 .B \-p <prompt>
57 sets the prompt to be displayed to the left of the input area.
58 .TP
59 .B \-fn <font>
60 sets the font.
61 .TP
62 .B \-nb <color>
63 sets the background color (#RGB, #RRGGBB, and color names are supported).
64 .TP
65 .B \-nf <color>
66 sets the foreground color (#RGB, #RRGGBB, and color names are supported).
67 .TP
68 .B \-sb <color>
69 sets the background color of selected items (#RGB, #RRGGBB, and color names are
70 supported).
71 .TP
72 .B \-sf <color>
73 sets the foreground color of selected items (#RGB, #RRGGBB, and color names are
74 supported).
75 .TP
76 .B \-v
77 prints version information to standard output, then exits.
78 .SH USAGE
79 dmenu reads a list of newline-separated items from standard input and creates a
80 menu.  When the user selects an item or enters any text and presses Return,
81 their choice is printed to standard output and dmenu terminates.
82 .P
83 dmenu is completely controlled by the keyboard.  Besides standard Unix line
84 editing and item selection (Up/Down/Left/Right, PageUp/PageDown, Home/End), the
85 following keys are recognized:
86 .TP
87 .B Tab (Control\-i)
88 Copy the selected item to the input field.
89 .TP
90 .B Return (Control\-j)
91 Confirm selection.  Prints the selected item to standard output and exits,
92 returning success.
93 .TP
94 .B Shift\-Return (Control\-Shift\-j)
95 Confirm input.  Prints the input text to standard output and exits, returning
96 success.
97 .TP
98 .B Escape (Control\-c)
99 Quit without selecting an item, returning failure.
100 .TP
101 .B Control\-y
102 Paste the current X selection into the input field.
103 .SH SEE ALSO
104 .BR dwm (1),
105 .BR wmii (1).