update manpage

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index a1ec695..5f74463 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -4,6 +4,7 @@ dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 .RB [ \-b ]
 .SH SYNOPSIS
 .B dmenu
 .RB [ \-b ]

+.RB [ \-f ]

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


@@ -22,29 +23,26 @@ dmenu \- dynamic menu
 .RB [ \-v ]
 .P
 .BR dmenu_run " ..."
 .RB [ \-v ]
 .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 script used by dmenu_run to find and cache a list of programs.
+is a script used by
+.IR dwm (1)
+which lists programs in the user's $PATH and executes the selected item.

 .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 \-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
 .B \-i
 dmenu matches menu items case insensitively.
 .TP


@@ -55,13 +53,13 @@ dmenu lists items vertically, with the given number of lines.
 defines the prompt to be displayed to the left of the input field.
 .TP
 .BI \-fn " font"
 defines the prompt to be displayed to the left of the input field.
 .TP
 .BI \-fn " font"

-defines the font set used.
+defines the font or font set used.

 .TP
 .BI \-nb " color"
 defines the normal background color.
 .IR #RGB ,
 .IR #RRGGBB ,
 .TP
 .BI \-nb " color"
 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.


@@ -73,27 +71,30 @@ 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.

 .SH USAGE
 dmenu is completely controlled by the keyboard.  Besides standard Unix line
 .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
+editing and item selection (arrow keys, page up/down, home and end), the

 following keys are recognized:
 .TP
 following keys are recognized:
 .TP

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

 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 (Ctrl\-j)
+Confirm selection.  Prints the selected item to stdout and exits, returning

 success.
 .TP
 success.
 .TP

-.B Escape (Control\-c)
+.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
 Exit without selecting an item, returning failure.
 .TP

-.B Control\-y
-Paste the current X selection into the input field.
+.B Ctrl\-y
+Paste the primary X selection into the input field.
+.TP
+.B Ctrl-Shift-y
+Paste the X clipboard into the input field.

 .SH SEE ALSO
 .SH SEE ALSO

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