updated manpage, added paste, cleaned up, new libdraw

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index 694debd..2d8bc20 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,90 +1,105 @@
-.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 [ \-font " <name>"]
-.RB [ \-normbg " <color>"]
-.RB [ \-normfg " <color>"]
-.RB [ \-selbg " <color>"]
-.RB [ \-selfg " <color>"]
-.RB [ \-p " <prompt>"]
-.RB [ \-t " <seconds>"]
+.RB [ \-b ]
+.RB [ \-i ]
+.RB [ \-l " <lines>]"
+.RB [ \-p " <prompt>]"
+.RB [ \-fn " <font>]"
+.RB [ \-nb " <color>]"
+.RB [ \-nf " <color>]"
+.RB [ \-sb " <color>]"
+.RB [ \-sf " <color>]"

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

+
+.B dmenu_run
+.RB [ \-b ]
+.RB [ \-i ]
+.RB [ \-l " <lines>]"
+.RB [ \-p " <prompt>]"
+.RB [ \-fn " <font>]"
+.RB [ \-nb " <color>]"
+.RB [ \-nf " <color>]"
+.RB [ \-sb " <color>]"
+.RB [ \-sf " <color>]"
+.RB [ \-v ]
+
+.B dmenu_path

 .SH DESCRIPTION
 .SS Overview
 .SH DESCRIPTION
 .SS Overview

-dmenu is a generic menu for X, originally designed for
+.B dmenu
+is a generic menu for X, originally designed for

 .BR dwm (1).
 .BR dwm (1).

-It manages huge amounts (up to 10.000 and more) of user defined menu items
-efficiently.
+It manages huge amounts (10000 and more) of user defined menu items efficiently.
+.P
+.B dmenu_run
+is a dmenu script which lists programs in the user's PATH and executes
+the selected item.
+.P
+.B dmenu_path
+is a script used by
+.I dmenu_run
+to find and cache a list of programs.

 .SS Options
 .TP
 .SS Options
 .TP

-.B \-font <name>
-defines the font.
+.B \-b
+dmenu appears at the bottom of the screen.

 .TP
 .TP

-.B \-normbg <color>
-defines the normal background color (#RGB, #RRGGBB, and color names are supported).
+.B \-i
+dmenu matches menu entries case insensitively.

 .TP
 .TP

-.B \-normfg <color>
-defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
+.B \-l <lines>
+dmenu lists items vertically, with the given number of lines.

 .TP
 .TP

-.B \-selbg <color>
-defines the selected background color (#RGB, #RRGGBB, and color names are supported).
+.B \-p <prompt>
+sets the prompt to be displayed to the left of the input area.

 .TP
 .TP

-.B \-selfg <color>
-defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
+.B \-fn <font>
+sets the font.

 .TP
 .TP

-.B \-p <prompt>
-defines a prompt to be displayed before the input area.
+.B \-nb <color>
+sets the background color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-nf <color>
+sets the foreground color (#RGB, #RRGGBB, and color names are supported).

 .TP
 .TP

-.B \-t <seconds>
-defines the seconds to wait for standard input, before exiting (default is 3).
+.B \-sb <color>
+sets the background color of selected items (#RGB, #RRGGBB, and color names are
+supported).
+.TP
+.B \-sf <color>
+sets the foreground color of selected items (#RGB, #RRGGBB, and color names are
+supported).

 .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
 .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/her
-choice is printed to standard output and dmenu terminates.
+menu.  When the user selects an item or enters any text and presses Return,
+their choice is printed to standard output and dmenu terminates.

 .P
 .P

-dmenu is completely controlled by the keyboard. The following keys are recognized:
-.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.
-.TP
-.B Left/Right
-Select the previous/next item.
+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:

 .TP
 .TP

-.B PageUp/PageDown
-Select the first item of the previous/next 'page' of items.
-.TP
-.B Home/End
-Select the first/last item.
-.TP
-.B Tab
+.B Tab (Control\-i)

 Copy the selected item to the input field.
 .TP
 Copy the selected item to the input field.
 .TP

-.B Return
-Confirm selection and quit (print the selected item to standard output). Returns
-.B 0
-on termination.
-.TP
-.B Shift-Return
-Confirm selection and quit (print the text in the input field to standard output).
-Returns
-.B 0
-on termination.
+.B Return (Control\-j)
+Confirm selection.  Prints the selected item to standard output and exits,
+returning success.

 .TP
 .TP

-.B Escape
-Quit without selecting an item. Returns
-.B 1
-on termination.
+.B Shift\-Return (Control\-Shift\-j)
+Confirm input.  Prints the input text to standard output and exits, returning
+success.

 .TP
 .TP

-.B Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+.B Escape (Control\-c)
+Quit without selecting an item, returning failure.

 .TP
 .TP

-.B Control-u
-Remove all characters from the input field.
+.B Control\-y
+Paste the current X selection into the input field.

 .SH SEE ALSO
 .SH SEE ALSO

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