new dmenu_run
[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, originally designed for
29 .IR dwm (1).
30 It manages huge numbers of user\-defined menu items efficiently.
31 .P
32 dmenu reads a list of newline\-separated items from stdin and creates a menu.
33 When the user selects an item or enters any text and presses Return, their
34 choice is printed to stdout and dmenu terminates.
35 .P
36 .B dmenu_run
37 is a dmenu script used by dwm which lists programs in the user's $PATH and
38 executes the selected item.
39 .SH OPTIONS
40 .TP
41 .B \-b
42 dmenu appears at the bottom of the screen.
43 .TP
44 .B \-f
45 dmenu grabs the keyboard before reading stdin.  This is faster, but may lock up
46 X if stdin is from a terminal.
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 field.
56 .TP
57 .BI \-fn " font"
58 defines the font or font set used.
59 .TP
60 .BI \-nb " color"
61 defines the normal background color.
62 .IR #RGB ,
63 .IR #RRGGBB ,
64 and X 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 stdout, then exits.
77 .SH USAGE
78 dmenu is completely controlled by the keyboard.  Besides standard Unix line
79 editing and item selection (arrow keys, page up/down, home and end), the
80 following keys are recognized:
81 .TP
82 .B Tab (Ctrl\-i)
83 Copy the selected item to the input field.
84 .TP
85 .B Return (Ctrl\-j)
86 Confirm selection.  Prints the selected item to stdout and exits, returning
87 success.
88 .TP
89 .B Shift\-Return (Ctrl\-Shift\-j)
90 Confirm input.  Prints the input text to stdout and exits, returning success.
91 .TP
92 .B Escape (Ctrl\-c)
93 Exit without selecting an item, returning failure.
94 .TP
95 .B Ctrl\-y
96 Paste the current X selection into the input field.
97 .SH SEE ALSO
98 .IR dwm (1)