merge lsx -> default

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index fa3adc0..7243a36 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,62 +1,96 @@
-.TH DMENU 1 dmenu-VERSION
+.TH DMENU 1 dmenu\-VERSION

 .SH NAME
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 .SH NAME
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu

+.RB [ \-b ]
+.RB [ \-f ]
+.RB [ \-i ]
+.RB [ \-l
+.IR lines ]
+.RB [ \-p
+.IR prompt ]
+.RB [ \-fn
+.IR font ]
+.RB [ \-nb
+.IR color ]
+.RB [ \-nf
+.IR color ]
+.RB [ \-sb
+.IR color ]
+.RB [ \-sf
+.IR color ]

 .RB [ \-v ]
 .RB [ \-v ]

+.P
+.BR dmenu_run " ..."

 .SH DESCRIPTION
 .SH DESCRIPTION

-.SS Overview
-dmenu is a generic menu for X, originally designed for
-.BR dwm (1).
-It manages huge amounts (up to 10.000 and more) of user defined menu items
-efficiently.
-.SS Options
-.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, his
-choice is printed to standard output and dmenu terminates.
+.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
 .P

-dmenu is completely controlled by the keyboard. The following keys are recognized:
+.B dmenu_run
+is a dmenu script used by dwm which lists programs in the user's $PATH and
+executes the selected item.
+.SH OPTIONS

 .TP
 .TP

-.B Any printable character
-Appends the character to the text in the input field.  This works as a filter:
-only items containing this text will be displayed.
+.B \-b
+dmenu appears at the bottom of the screen.

 .TP
 .TP

-.B Left/Right
-Select the previous/next item.
+.B \-f
+dmenu grabs the keyboard before reading stdin.  This is faster, but will lock up
+X until stdin reaches end\-of\-file.

 .TP
 .TP

-.B Tab
-Copy the selected item to the input field.
+.B \-i
+dmenu matches menu items case insensitively.

 .TP
 .TP

-.B Return
-Confirm selection and quit (print the selected item to standard output).
+.BI \-l " lines"
+dmenu lists items vertically, with the given number of lines.

 .TP
 .TP

-.B Shift-Return
-Confirm selection and quit (print the text in the input field to standard output).
+.BI \-p " prompt"
+defines the prompt to be displayed to the left of the input field.

 .TP
 .TP

-.B Escape
-Quit without selecting an item.
+.BI \-fn " font"
+defines the font or font set used.

 .TP
 .TP

-.B Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+.BI \-nb " color"
+defines the normal background color.
+.IR #RGB ,
+.IR #RRGGBB ,
+and X color names are supported.

 .TP
 .TP

-.B Control-u
-Remove all characters from the input field.
-.P
-dwm returns
-.B 0
-if
-.B Return
-is pressed and
-.B 1
-if
-.B Escape
-is pressed on termination.
-.SH CUSTOMIZATION
-dmenu is customized by creating a custom config.h and (re)compiling the source
-code. This keeps it fast, secure and simple.
+.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
+.B \-v
+prints version information to stdout, then exits.
+.SH USAGE
+dmenu is completely controlled by the keyboard.  Besides standard Unix line
+editing and item selection (arrow keys, page up/down, home and end), the
+following keys are recognized:
+.TP
+.B Tab (Ctrl\-i)
+Copy the selected item to the input field.
+.TP
+.B Return (Ctrl\-j)
+Confirm selection.  Prints the selected item to stdout and exits, returning
+success.
+.TP
+.B Shift\-Return (Ctrl\-Shift\-j)
+Confirm input.  Prints the input text to stdout and exits, returning success.
+.TP
+.B Escape (Ctrl\-c)
+Exit without selecting an item, returning failure.
+.TP
+.B Ctrl\-y
+Paste the current X selection into the input field.

 .SH SEE ALSO
 .SH SEE ALSO

-.BR dwm (1)
+.IR dwm (1),
+.IR lsx (1)