helpful errors

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index c682711..d2a93d1 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,95 +1,104 @@
-.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 [ \-i ]
+.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 [ \-v ]
 .RB [ \-v ]

+.P
+.BR dmenu_run " ..."
+.P
+.B dmenu_path

 .SH DESCRIPTION
 .SH DESCRIPTION

-.SS Overview
-dmenu is a generic menu for X, originally designed for
+.B dmenu
+is a dynamic 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.
-.SS Options
+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.
+.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.
+.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 \-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 \-m " monitor"
+dmenu appears on the given Xinerama screen.

 .TP
 .TP

-.B \-nf <color>
-defines the normal foreground 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 \-p <prompt>
-defines a prompt to be displayed before the input area.
+.BI \-fn " font"
+defines the font or font set used.

 .TP
 .TP

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

 .TP
 .TP

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

 .TP
 .TP

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

 .TP
 .B \-v
 prints version information to standard output, then exits.
 .SH USAGE
 .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.
-.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.
+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 Left/Right (Mod1-h/Mod1-l)
-Select the previous/next item.
-.TP
-.B PageUp/PageDown (Mod1-k/Mod1-j)
-Select the first item of the previous/next 'page' of items.
-.TP
-.B Home/End (Mod1-g/Mod1-G)
-Select the first/last item.
-.TP
-.B Tab (Control-i)
+.B Tab (Control\-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 and quit (print the selected item to standard output). Returns
-.B 0
-on termination.
-.TP
-.B Shift-Return (Control-Shift-j)
-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 (Control-bracketleft)
-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)
+Exit 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 wmii (1) .
+.BR dwm (1)