dmenu.1

.TH DMENU 1 dmenu\-VERSION
.SH NAME
dmenu \- dynamic menu
.SH SYNOPSIS
.B dmenu
.RB [ \-bcfirstvFP ]
.RB [ \-ix ]
.RB [ \-l
.IR lines ]
.RB [ \-h
.IR height ]
.RB [ \-m
.IR monitor ]
.RB [ \-p
.IR prompt ]
.RB [ \-it
.IR text ]
.RB [ \-d
.IR separator ]
.RB [ \-D
.IR separator ]
.RB [ \-bw
.IR border_width ]
.RB [ \-fn
.IR font ]
.RB [ \-nb
.IR color ]
.RB [ \-nf
.IR color ]
.RB [ \-sb
.IR color ]
.RB [ \-sf
.IR color ]
.RB [ \-nhb
.IR color ]
.RB [ \-nhf
.IR color ]
.RB [ \-shb
.IR color ]
.RB [ \-shf
.IR color ]
.RB [ \-w
.IR windowid ]
.P
.BR dmenu_run " ..."
.SH DESCRIPTION
.B dmenu
is a dynamic menu for X, which reads a list of newline\-separated items from
stdin.  When the user selects an item and presses Return, their choice is printed
to stdout and dmenu terminates.  Entering text will narrow the items to those
matching the tokens in the input.
.P
.B dmenu_run
is a script used by
.IR dwm (1)
which lists programs in the user's $PATH and runs the result in their $SHELL.
.SH OPTIONS
.TP
.B \-t
dmenu appears at the top of the screen.
.TP
.B \-b
dmenu appears at the bottom of the screen.
.TP
.B \-c
dmenu appears centered on the screen.
.TP
.B \-f
dmenu grabs the keyboard before reading stdin if not reading from a tty. This
is faster, but will lock up X until stdin reaches end\-of\-file.
.TP
.B \-i
dmenu matches menu items case insensitively.
.TP
.B \-s
dmenu matches menu items case sensitively.
.TP
.B \-F
disable fuzzy matching.
.TP
.B \-P
dmenu will not directly display the keyboard input, but instead replace it with asterisks. All data from stdin will be ignored.
.TP
.B \-r
disables ctr-return and shift-return. this guarantees that dmenu prints to
stdout only once, and it only prints an item read from stdin.
.TP
.B \-ix
dmenu prints the index of matched text instead of the text itself.
.TP
.BI \-l " lines"
dmenu lists items vertically, with the given number of lines.
.TP
.BI \-h " height"
dmenu uses a menu line of at least 'height' pixels tall, but no less than 8.
.TP
.BI \-m " monitor"
dmenu is displayed on the monitor number supplied. Monitor numbers are starting
from 0.
.TP
.BI \-p " prompt"
defines the prompt to be displayed to the left of the input field.
.TP
.BI \-it " text".
start with initial text input.
.TP
.BI \-d " separator"
separate the input into two halves on the first occurrence of the given charcter.
Display only the first half in dmenu and print the second half to stdout upon selection.
Appending '|' to the separator reverses the display/printing order.
.TP
.BI \-D " separator"
same as \-d but separate based on the last occurrence.
.TP
.BI \-bw " border_width"
defines the tickness of the window border.
.TP
.BI \-fn " font"
defines the font or font set used.
.TP
.BI \-nb " color"
defines the normal background color.
.IR #RGB ,
.IR #RRGGBB ,
and X color names are supported.
.TP
.BI \-nf " color"
defines the normal foreground color.
.TP
.BI \-sb " color"
defines the selected background color.
.TP
.BI \-sf " color"
defines the selected foreground color.
.TP
.BI \-nhb " color"
defines the normal highlight background color.
.TP
.BI \-nhf " color"
defines the normal highlight foreground color.
.TP
.BI \-shb " color"
defines the selected highlight background color.
.TP
.BI \-shf " color"
defines the selected highlight foreground color.
.TP
.B \-v
prints version information to stdout, then exits.
.TP
.BI \-w " windowid"
embed into windowid.
.SH USAGE
dmenu can be controlled by the keyboard or by the mouse. Items are selected using the
arrow keys, page up, page down, home, end or by scrolling with the mouse.
.SS Keyboard commands
.TP
.B Tab
Copy the selected item to the input field.
.TP
.B Return
Confirm selection.  Prints the selected item and the items selection to stdout and exits, returning
success.
.TP
.B Ctrl-Return
Confirm selection.  Add the selected item to the items selection and continues.
.TP
.B Shift\-Return
Confirm input.  Prints the input text to stdout and exits, returning success.
.TP
.B Escape
Exit without selecting an item, returning failure.
.TP
.B Ctrl-Left
Move cursor to the start of the current word
.TP
.B Ctrl-Right
Move cursor to the end of the current word
.TP
.B C\-a
Home
.TP
.B C\-b
Left
.TP
.B C\-c
Escape
.TP
.B C\-d
Delete
.TP
.B C\-e
End
.TP
.B C\-f
Right
.TP
.B C\-g
Escape
.TP
.B C\-h
Backspace
.TP
.B C\-i
Tab
.TP
.B C\-j
Return
.TP
.B C\-J
Shift-Return
.TP
.B C\-k
Delete line right
.TP
.B C\-m
Return
.TP
.B C\-M
Shift-Return
.TP
.B C\-n
Down
.TP
.B C\-p
Up
.TP
.B C\-u
Delete line left
.TP
.B C\-v
Paste from X clipboard
.TP
.B C\-V
Paste from primary X selection
.TP
.B C\-w
Delete word left
.TP
.B C\-y
Paste from X clipboard
.TP
.B C\-Y
Paste from primary X selection
.TP
.B M\-b
Move cursor to the start of the current word
.TP
.B M\-f
Move cursor to the end of the current word
.TP
.B M\-g
Home
.TP
.B M\-G
End
.TP
.B M\-h
Up
.TP
.B M\-j
Page down
.TP
.B M\-k
Page up
.TP
.B M\-l
Down
.SS Mouse commands
.TP
.B Button1
If the mouse cursor is on the input field: clear input text and selection.
If the mouse cursor is on an item: same as pressing Return.
.TP
.B Ctrl-Button1
If the mouse cursor is on the input field: clear input text and selection.
If the mouse cursor is on an item: same as pressing Ctrl-Return.
.TP
.B Shift-Button1
If the mouse cursor is on input field: same as pressing Shift-Return.
.TP
.B Button2
Paste from X clipboard
.TP
.B Shift\-Button2
Paste from primary X selection
.TP
.B Button3
Exit without selecting an item, returning failure.
.TP
.B Button4
Page up
.TP
.B Button5
Page down
.SH SEE ALSO
.IR dwm (1),
.IR stest (1)