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