update 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 [ \-b ]
7 .RB [ \-f ]
8 .RB [ \-i ]
9 .RB [ \-l
10 .IR lines ]
11 .RB [ \-p
12 .IR prompt ]
13 .RB [ \-fn
14 .IR font ]
15 .RB [ \-nb
16 .IR color ]
17 .RB [ \-nf
18 .IR color ]
19 .RB [ \-sb
20 .IR color ]
21 .RB [ \-sf
22 .IR color ]
23 .RB [ \-v ]
24 .P
25 .BR dmenu_run " ..."
26 .SH DESCRIPTION
27 .B dmenu
28 is a dynamic menu for X, which reads a list of newline\-separated items from
29 stdin.  When the user selects an item and presses Return, their choice is printed
30 to stdout and dmenu terminates.  Entering text will narrow the items to those
31 matching the tokens in the input.
32 .P
33 .B dmenu_run
34 is a script used by
35 .IR dwm (1)
36 which lists programs in the user's $PATH and executes the selected item.
37 .SH OPTIONS
38 .TP
39 .B \-b
40 dmenu appears at the bottom of the screen.
41 .TP
42 .B \-f
43 dmenu grabs the keyboard before reading stdin.  This is faster, but will lock up
44 X until stdin reaches end\-of\-file.
45 .TP
46 .B \-i
47 dmenu matches menu items case insensitively.
48 .TP
49 .BI \-l " lines"
50 dmenu lists items vertically, with the given number of lines.
51 .TP
52 .BI \-p " prompt"
53 defines the prompt to be displayed to the left of the input field.
54 .TP
55 .BI \-fn " font"
56 defines the font or font set used.
57 .TP
58 .BI \-nb " color"
59 defines the normal background color.
60 .IR #RGB ,
61 .IR #RRGGBB ,
62 and X color names are supported.
63 .TP
64 .BI \-nf " color"
65 defines the normal foreground color.
66 .TP
67 .BI \-sb " color"
68 defines the selected background color.
69 .TP
70 .BI \-sf " color"
71 defines the selected foreground color.
72 .TP
73 .B \-v
74 prints version information to stdout, then exits.
75 .SH USAGE
76 dmenu is completely controlled by the keyboard.  Besides standard Unix line
77 editing and item selection (arrow keys, page up/down, home and end), the
78 following keys are recognized:
79 .TP
80 .B Tab (Ctrl\-i)
81 Copy the selected item to the input field.
82 .TP
83 .B Return (Ctrl\-j)
84 Confirm selection.  Prints the selected item to stdout and exits, returning
85 success.
86 .TP
87 .B Shift\-Return (Ctrl\-Shift\-j)
88 Confirm input.  Prints the input text to stdout and exits, returning success.
89 .TP
90 .B Escape (Ctrl\-c)
91 Exit without selecting an item, returning failure.
92 .TP
93 .B Ctrl\-y
94 Paste the primary X selection into the input field.
95 .TP
96 .B Ctrl-Shift-y
97 Paste the X clipboard into the input field.
98 .SH SEE ALSO
99 .IR dwm (1),
100 .IR lsx (1)