patch: mousesupport

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index d2a93d1..6254195 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -3,8 +3,7 @@
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu

-.RB [ \-b ]
-.RB [ \-i ]
+.RB [ \-bfiv ]

 .RB [ \-l
 .IR lines ]
 .RB [ \-m
 .RB [ \-l
 .IR lines ]
 .RB [ \-m


@@ -21,32 +20,36 @@ dmenu \- dynamic menu
 .IR color ]
 .RB [ \-sf
 .IR color ]
 .IR color ]
 .RB [ \-sf
 .IR color ]

-.RB [ \-v ]
+.RB [ \-w
+.IR windowid ]

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

-.P
-.B dmenu_path

 .SH DESCRIPTION
 .B dmenu
 .SH DESCRIPTION
 .B dmenu

-is a dynamic menu for X, originally designed for
-.BR dwm (1).
-It manages huge numbers of user-defined menu items efficiently.
-.P
-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.
+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
 .P
 .B dmenu_run

-is a dmenu script used by dwm which lists programs in the user's PATH and
-executes the selected item.
-.P
-.B dmenu_path
-is a program used by dmenu_run to find and cache a list of executables.
+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
 .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
 .B \-i
 dmenu matches menu items case insensitively.
 .TP


@@ -54,7 +57,8 @@ dmenu matches menu items case insensitively.
 dmenu lists items vertically, with the given number of lines.
 .TP
 .BI \-m " monitor"
 dmenu lists items vertically, with the given number of lines.
 .TP
 .BI \-m " monitor"

-dmenu appears on the given Xinerama screen.
+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 \-p " prompt"
 defines the prompt to be displayed to the left of the input field.


@@ -66,7 +70,7 @@ defines the font or font set used.
 defines the normal background color.
 .IR #RGB ,
 .IR #RRGGBB ,
 defines the normal background color.
 .IR #RGB ,
 .IR #RRGGBB ,

-and color names are supported.
+and X color names are supported.

 .TP
 .BI \-nf " color"
 defines the normal foreground color.
 .TP
 .BI \-nf " color"
 defines the normal foreground color.


@@ -78,27 +82,119 @@ defines the selected background color.
 defines the selected foreground color.
 .TP
 .B \-v
 defines the selected foreground color.
 .TP
 .B \-v

-prints version information to standard output, then exits.
+prints version information to stdout, then exits.
+.TP
+.BI \-w " windowid"
+embed into windowid.

 .SH USAGE
 .SH USAGE

-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:
+dmenu is completely controlled by the keyboard.  Items are selected using the
+arrow keys, page up, page down, home, and end.

 .TP
 .TP

-.B Tab (Control\-i)
+.B Tab

 Copy the selected item to the input field.
 .TP
 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
+.B Return
+Confirm selection.  Prints the selected item to stdout and exits, returning

 success.
 .TP
 success.
 .TP

-.B Escape (Control\-c)
+.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

 Exit without selecting an item, returning failure.
 .TP
 Exit without selecting an item, returning failure.
 .TP

-.B Control\-y
-Paste the current X selection into the input field.
+.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\-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)