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