1
0
dmenu/dmenu.1
2010-07-31 14:56:27 +01:00

106 lines
2.5 KiB
Groff

.TH DMENU 1 dmenu\-VERSION
.SH NAME
dmenu \- dynamic menu
.SH SYNOPSIS
.B dmenu
.RB [ \-b ]
.RB [ \-i ]
.RB [ \-l " <lines>]"
.RB [ \-p " <prompt>]"
.RB [ \-fn " <font>]"
.RB [ \-nb " <color>]"
.RB [ \-nf " <color>]"
.RB [ \-sb " <color>]"
.RB [ \-sf " <color>]"
.RB [ \-v ]
.B dmenu_run
.RB [ \-b ]
.RB [ \-i ]
.RB [ \-l " <lines>]"
.RB [ \-p " <prompt>]"
.RB [ \-fn " <font>]"
.RB [ \-nb " <color>]"
.RB [ \-nf " <color>]"
.RB [ \-sb " <color>]"
.RB [ \-sf " <color>]"
.RB [ \-v ]
.B dmenu_path
.SH DESCRIPTION
.SS Overview
.B dmenu
is a generic menu for X, originally designed for
.BR dwm (1).
It manages huge amounts (10000 and more) of user defined menu items efficiently.
.P
.B dmenu_run
is a dmenu script which lists programs in the user's PATH and executes
the selected item.
.P
.B dmenu_path
is a script used by
.I dmenu_run
to find and cache a list of programs.
.SS Options
.TP
.B \-b
dmenu appears at the bottom of the screen.
.TP
.B \-i
dmenu matches menu entries case insensitively.
.TP
.B \-l <lines>
dmenu lists items vertically, with the given number of lines.
.TP
.B \-p <prompt>
sets the prompt to be displayed to the left of the input area.
.TP
.B \-fn <font>
sets the font.
.TP
.B \-nb <color>
sets the background color (#RGB, #RRGGBB, and color names are supported).
.TP
.B \-nf <color>
sets the foreground color (#RGB, #RRGGBB, and color names are supported).
.TP
.B \-sb <color>
sets the background color of selected items (#RGB, #RRGGBB, and color names are
supported).
.TP
.B \-sf <color>
sets the foreground color of selected items (#RGB, #RRGGBB, and color names are
supported).
.TP
.B \-v
prints version information to standard output, then exits.
.SH USAGE
dmenu reads a list of newline-separated items from standard input and creates a
menu. When the user selects an item or enters any text and presses Return,
their choice is printed to standard output and dmenu terminates.
.P
dmenu is completely controlled by the keyboard. Besides standard Unix line
editing and item selection (Up/Down/Left/Right, PageUp/PageDown, Home/End), the
following keys are recognized:
.TP
.B Tab (Control\-i)
Copy the selected item to the input field.
.TP
.B Return (Control\-j)
Confirm selection. Prints the selected item to standard output and exits,
returning success.
.TP
.B Shift\-Return (Control\-Shift\-j)
Confirm input. Prints the input text to standard output and exits, returning
success.
.TP
.B Escape (Control\-c)
Quit without selecting an item, returning failure.
.TP
.B Control\-y
Paste the current X selection into the input field.
.SH SEE ALSO
.BR dwm (1),
.BR wmii (1).