patch: mousesupport

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index fa3adc0..6254195 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,62 +1,200 @@
-.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 [ \-v ]
+.RB [ \-bfiv ]
+.RB [ \-l
+.IR lines ]
+.RB [ \-m
+.IR monitor ]
+.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 [ \-w
+.IR windowid ]
+.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 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
+dmenu appears at the bottom of the screen.
+.TP
+.B \-c
+dmenu appears centered on the screen.
+.TP
+.B \-F
+dmenu use fuzzy matching.
+.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
+.BI \-l " lines"
+dmenu lists items vertically, with the given number of lines.
+.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
 .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.
+.BI \-fn " font"
+defines the font or font set used.

 .TP
 .TP

-.B Left/Right
-Select the previous/next item.
+.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
+.B \-v
+prints version information to stdout, then exits.
+.TP
+.BI \-w " windowid"
+embed into windowid.
+.SH USAGE
+dmenu is completely controlled by the keyboard.  Items are selected using the
+arrow keys, page up, page down, home, and end.

 .TP
 .B Tab
 Copy the selected item to the input field.
 .TP
 .B Return
 .TP
 .B Tab
 Copy the selected item to the input field.
 .TP
 .B Return

-Confirm selection and quit (print the selected item to standard output).
+Confirm selection.  Prints the selected item to stdout and exits, returning
+success.

 .TP
 .TP

-.B Shift-Return
-Confirm selection and quit (print the text in the input field to standard output).
+.B Ctrl-Return
+Confirm selection.  Prints the selected item to stdout and continues.
+.TP
+.B Shift\-Return
+Confirm input.  Prints the input text to stdout and exits, returning success.

 .TP
 .B Escape
 .TP
 .B Escape

-Quit without selecting an item.
+Exit without selecting an item, returning failure.

 .TP
 .TP

-.B Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+.B Ctrl-Left
+Move cursor to the start of the current word

 .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.
+.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\-w
+Delete word left
+.TP
+.B C\-y
+Paste from primary X selection
+.TP
+.B C\-Y
+Paste from X clipboard
+.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

 .SH SEE ALSO
 .SH SEE ALSO

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