ordered switch branches in kpress alphabetically, applied Sanders patch for PgUp...

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index 7a45503..ff0c000 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -3,62 +3,84 @@
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu

+.RB [ \-font " <name>"]
+.RB [ \-normbg " <color>"]
+.RB [ \-normfg " <color>"]
+.RB [ \-selbg " <color>"]
+.RB [ \-selfg " <color>"]
+.RB [ \-t " <seconds>"]

 .RB [ \-v ]
 .SH DESCRIPTION
 .SS Overview
 .RB [ \-v ]
 .SH DESCRIPTION
 .SS Overview

-.B dmenu
-is a generic, highly customizable, and efficient menu for the X Window System,
-originally designed for
+dmenu is a generic menu for X, originally designed for

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

-It supports arbitrary, user defined menu contents.
+It manages huge amounts (up to 10.000 and more) of user defined menu items
+efficiently.

 .SS Options
 .TP
 .SS Options
 .TP

+.B \-font <name>
+defines the font.
+.TP
+.B \-normbg <color>
+defines the normal background color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-normfg <color>
+defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-selbg <color>
+defines the selected background color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-selfg <color>
+defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-t <seconds>
+defines the seconds to wait for standard input, before exiting (default is 3).
+.TP

 .B \-v
 .B \-v

-prints version information to stdout, then exits.
+prints version information to standard output, then exits.

 .SH USAGE
 .SH USAGE

-.B dmenu
-reads a list of newline-separated items from stdin and creates a menu.
-When the user selects an item or enters any text and presses Return, his choice
-is printed to stdout and
-.B dmenu
-terminates.
-.B dmenu
-is completely controlled by the keyboard.  The following keys are recognized:
+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
 .TP

-Any printable character
-Appends the character to the text in the input field. This works as a filter:
+.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
 only items containing this text will be displayed.
 .TP

-Left/Right (Control-p/Control-n)
+.B Left/Right

 Select the previous/next item.
 .TP
 Select the previous/next item.
 .TP

-Tab (Control-i)
+.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

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

-Return (Control-j)
-Confirm selection and quit (print the selected item to stdout).
+.B Return
+Confirm selection and quit (print the selected item to standard output). Returns
+.B 0
+on termination.

 .TP
 .TP

-Shift-Return (Shift-Control-j)
-Confirm selection and quit (print the text in the input field to stdout).
+.B Shift-Return
+Confirm selection and quit (print the text in the input field to standard output).
+Returns
+.B 0
+on termination.

 .TP
 .TP

-Escape (Control-[)
-Quit without selecting an item.
+.B Escape
+Quit without selecting an item. Returns
+.B 1
+on termination.

 .TP
 .TP

-Backspace (Control-h)
+.B Backspace (Control-h)

 Remove enough characters from the input field to change its filtering effect.
 .TP
 Remove enough characters from the input field to change its filtering effect.
 .TP

-Control-u
+.B Control-u

 Remove all characters from the input field.
 Remove all characters from the input field.

-.P
-.B dmenu
-returns
-.B 0
-if Return is pressed on termination,
-.B 1
-if Escape is pressed.
-.SH CUSTOMIZATION
-.B dmenu
-is customized by creating a custom config.h and (re)compiling the source
-code. This keeps it fast, secure and simple.

 .SH SEE ALSO
 .BR dwm (1)
 .SH SEE ALSO
 .BR dwm (1)