typo fixes
[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 [ \-i ]
7 .RB [ \-b ]
8 .RB [ \-e " <xid>]"
9 .RB [ \-l " <lines>]"
10 .RB [ \-fn " <font>]"
11 .RB [ \-nb " <color>]"
12 .RB [ \-nf " <color>]"
13 .RB [ \-p " <prompt>]"
14 .RB [ \-sb " <color>]"
15 .RB [ \-sf " <color>]"
16 .RB [ \-v ]
17
18 .B dmenu_run
19 [<options...>]
20
21 .B dmenu_path
22 .SH DESCRIPTION
23 .SS Overview
24 dmenu is a generic menu for X, originally designed for
25 .BR dwm (1).
26 It manages huge amounts (up to 10.000 and more) of user defined menu items
27 efficiently.
28
29 dmenu_run is a dmenu script used by dwm which lists executables in the user's PATH
30 and executes the selected item.
31
32 dmenu_path is a script used by dmenu_run to find and cache a list of executables.
33 .SS Options
34 .TP
35 .B \-i
36 makes dmenu match menu entries case insensitively.
37 .TP
38 .B \-b
39 defines that dmenu appears at the bottom.
40 .TP
41 .B \-e <xid>
42 reparents dmenu to the window specified by xid.
43 .TP
44 .B \-l <lines>
45 activates vertical list mode.
46 The given number of lines will be displayed. Window height will be adjusted.
47 .TP
48 .B \-fn <font>
49 defines the font.
50 .TP
51 .B \-nb <color>
52 defines the normal background color (#RGB, #RRGGBB, and color names are supported).
53 .TP
54 .B \-nf <color>
55 defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
56 .TP
57 .B \-p <prompt>
58 defines a prompt to be displayed before the input area.
59 .TP
60 .B \-sb <color>
61 defines the selected background color (#RGB, #RRGGBB, and color names are supported).
62 .TP
63 .B \-sf <color>
64 defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
65 .TP
66 .B \-v
67 prints version information to standard output, then exits.
68 .SH USAGE
69 dmenu reads a list of newline-separated items from standard input and creates a
70 menu.  When the user selects an item or enters any text and presses Return, his/her
71 choice is printed to standard output and dmenu terminates.
72 .P
73 dmenu is completely controlled by the keyboard. Besides standard Unix line editing,
74 and item selection (Up/Down or Left/Right, PageUp/PageDown, Home/End), the following
75 keys are recognized:
76 .TP
77 .B Tab (Control\-i)
78 Copy the selected item to the input field.
79 .TP
80 .B Return (Control\-j)
81 Confirm selection and quit (print the selected item to standard output). Returns
82 .B 0
83 on termination.
84 .TP
85 .B Shift\-Return (Control\-Shift\-j)
86 Confirm input and quit (print the text in the input field to standard output).
87 Returns
88 .B 0
89 on termination.
90 .TP
91 .B Escape (Control\-c)
92 Quit without selecting an item. Returns
93 .B 1
94 on termination.
95 .TP
96 .B Control\-y
97 Pastes the X selection into the input field. This requires
98 .BR sselp (1).
99 .SH SEE ALSO
100 .BR dwm (1),
101 .BR wmii (1).