listen for C-S-[jm]

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index 4bc5b03..3a0f4ef 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,95 +1,168 @@
-.TH DMENU 1 dmenu-VERSION
+.TH DMENU 1 dmenu\-VERSION

 .SH NAME
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 .RB [ \-b ]
 .SH NAME
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 .RB [ \-b ]

-.RB [ \-fn " <font>"]
-.RB [ \-nb " <color>"]
-.RB [ \-nf " <color>"]
-.RB [ \-p " <prompt>"]
-.RB [ \-sb " <color>"]
-.RB [ \-sf " <color>"]
-.RB [ \-t " <seconds>"]
+.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
+.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 \-b
 .TP
 .B \-b

-makes dmenu appear at the screen bottom (by default it appears at the screen top).
+dmenu appears at the bottom of the screen.
+.TP
+.B \-f
+dmenu grabs the keyboard before reading stdin.  This is faster, but will lock up
+X until stdin reaches end\-of\-file.
+.TP
+.B \-i
+dmenu matches menu items case insensitively.

 .TP
 .TP

-.B \-fn <font>
-defines the font.
+.BI \-l " lines"
+dmenu lists items vertically, with the given number of lines.

 .TP
 .TP

-.B \-nb <color>
-defines the normal background color (#RGB, #RRGGBB, and color names are supported).
+.BI \-p " prompt"
+defines the prompt to be displayed to the left of the input field.

 .TP
 .TP

-.B \-nf <color>
-defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
+.BI \-fn " font"
+defines the font or font set used.

 .TP
 .TP

-.B \-p <prompt>
-defines a prompt to be displayed before the input area.
+.BI \-nb " color"
+defines the normal background color.
+.IR #RGB ,
+.IR #RRGGBB ,
+and X color names are supported.

 .TP
 .TP

-.B \-sb <color>
-defines the selected background color (#RGB, #RRGGBB, and color names are supported).
+.BI \-nf " color"
+defines the normal foreground color.

 .TP
 .TP

-.B \-sf <color>
-defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
+.BI \-sb " color"
+defines the selected background color.

 .TP
 .TP

-.B \-t <seconds>
-defines the seconds to wait for standard input, before exiting (default is 3).
+.BI \-sf " color"
+defines the selected foreground color.

 .TP
 .B \-v
 .TP
 .B \-v

-prints version information to standard output, then exits.
+prints version information to stdout, then exits.

 .SH USAGE
 .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/her
-choice is printed to standard output and dmenu terminates.
-.P
-dmenu is completely controlled by the keyboard. The following keys are recognized:
+dmenu is completely controlled by the keyboard.  Items are selected using the
+arrow keys, page up, page down, home, and end.

 .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 Tab
+Copy the selected item to the input field.

 .TP
 .TP

-.B Left/Right (Mod1-h/Mod1-l)
-Select the previous/next item.
+.B Return
+Confirm selection.  Prints the selected item to stdout and exits, returning
+success.

 .TP
 .TP

-.B PageUp/PageDown (Mod1-k/Mod1-j)
-Select the first item of the previous/next 'page' of items.
+.B Shift\-Return
+Confirm input.  Prints the input text to stdout and exits, returning success.

 .TP
 .TP

-.B Home/End (Mod1-g/Mod1-Shift-g)
-Select the first/last item.
+.B Escape
+Exit without selecting an item, returning failure.

 .TP
 .TP

-.B Tab (Control-i)
-Copy the selected item to the input field.
+C\-a
+Home

 .TP
 .TP

-.B Return
-Confirm selection and quit (print the selected item to standard output). Returns
-.B 0
-on termination.
-.TP
-.B Shift-Return (Control-j)
-Confirm selection and quit (print the text in the input field to standard output).
-Returns
-.B 0
-on termination.
-.TP
-.B Escape (Control-bracketleft)
-Quit without selecting an item. Returns
-.B 1
-on termination.
-.TP
-.B Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
-.TP
-.B Control-u
-Remove all characters from the input field.
+C\-b
+Left
+.TP
+C\-c
+Escape
+.TP
+C\-d
+Delete
+.TP
+C\-e
+End
+.TP
+C\-f
+Right
+.TP
+C\-g
+Escape
+.TP
+C\-h
+Backspace
+.TP
+C\-i
+Tab
+.TP
+C\-j
+Return
+.TP
+C\-J
+Shift-Return
+.TP
+C\-k
+Delete line right
+.TP
+C\-m
+Return
+.TP
+C\-n
+Down
+.TP
+C\-p
+Up
+.TP
+C\-u
+Delete line left
+.TP
+C\-w
+Delete word left
+.TP
+C\-y
+Paste from primary X selection
+.TP
+C\-Y
+Paste from X clipboard
+.TP
+M\-g
+Home
+.TP
+M\-G
+End
+.TP
+M\-h
+Up
+.TP
+M\-j
+Page down
+.TP
+M\-k
+Page up
+.TP
+M\-l
+Down

 .SH SEE ALSO
 .SH SEE ALSO

-.BR dwm (1),
-.BR wmii (1) .
+.IR dwm (1),
+.IR stest (1)