merge default -> lsx
[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 dmenu script used by dwm which lists programs in the user's $PATH and
35 executes the selected item.
36 .SH OPTIONS
37 .TP
38 .B \-b
39 dmenu appears at the bottom of the screen.
40 .TP
41 .B \-f
42 dmenu grabs the keyboard before reading stdin.  This is faster, but will lock up
43 X until stdin reaches end\-of\-file.
44 .TP
45 .B \-i
46 dmenu matches menu items case insensitively.
47 .TP
48 .BI \-l " lines"
49 dmenu lists items vertically, with the given number of lines.
50 .TP
51 .BI \-p " prompt"
52 defines the prompt to be displayed to the left of the input field.
53 .TP
54 .BI \-fn " font"
55 defines the font or font set used.
56 .TP
57 .BI \-nb " color"
58 defines the normal background color.
59 .IR #RGB ,
60 .IR #RRGGBB ,
61 and X color names are supported.
62 .TP
63 .BI \-nf " color"
64 defines the normal foreground color.
65 .TP
66 .BI \-sb " color"
67 defines the selected background color.
68 .TP
69 .BI \-sf " color"
70 defines the selected foreground color.
71 .TP
72 .B \-v
73 prints version information to stdout, then exits.
74 .SH USAGE
75 dmenu is completely controlled by the keyboard.  Besides standard Unix line
76 editing and item selection (arrow keys, page up/down, home and end), the
77 following keys are recognized:
78 .TP
79 .B Tab (Ctrl\-i)
80 Copy the selected item to the input field.
81 .TP
82 .B Return (Ctrl\-j)
83 Confirm selection.  Prints the selected item to stdout and exits, returning
84 success.
85 .TP
86 .B Shift\-Return (Ctrl\-Shift\-j)
87 Confirm input.  Prints the input text to stdout and exits, returning success.
88 .TP
89 .B Escape (Ctrl\-c)
90 Exit without selecting an item, returning failure.
91 .TP
92 .B Ctrl\-y
93 Paste the current X selection into the input field.
94 .SH SEE ALSO
95 .IR dwm (1),
96 .IR lsx (1)