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