applied cursor, vertical and paste patches for upcoming 4.1 dmenu version (due to...

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index 0fa21f9..24ee38b 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,64 +1,103 @@
-.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 [ \-i ]
+.RB [ \-b ]
+.RB [ \-l " <lines>"]
+.RB [ \-fn " <font>"]
+.RB [ \-nb " <color>"]
+.RB [ \-nf " <color>"]
+.RB [ \-p " <prompt>"]
+.RB [ \-sb " <color>"]
+.RB [ \-sf " <color>"]

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

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

 .BR dwm (1).
 It manages huge amounts (up to 10.000 and more) of user defined menu items
 efficiently.
 .SS Options
 .TP
 .BR dwm (1).
 It manages huge amounts (up to 10.000 and more) of user defined menu items
 efficiently.
 .SS Options
 .TP

+.B \-i
+makes dmenu match menu entries case insensitively.
+.TP
+.B \-b
+defines that dmenu appears at the bottom.
+.TP
+.B \-l <lines>
+activates vertical list mode.
+The given number of lines will be displayed. Window height will get adjusted.
+.TP
+.B \-fn <font>
+defines the font.
+.TP
+.B \-nb <color>
+defines the normal background color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-nf <color>
+defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-p <prompt>
+defines a prompt to be displayed before the input area.
+.TP
+.B \-sb <color>
+defines the selected background color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-sf <color>
+defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
+.TP

 .B \-v
 prints version information to standard output, then exits.
 .SH USAGE
 .B \-v
 prints version information to standard output, then exits.
 .SH USAGE

-.B 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 choice
-is printed to standard output 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
+.B Left/Right (Up/Down) (Mod1\-h/Mod1\-l)

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

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

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

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

 .TP
 .TP

-Shift-Return
+.B Shift\-Return (Control\-Shift\-j)

 Confirm selection and quit (print the text in the input field to standard output).
 Confirm selection and quit (print the text in the input field to standard output).

+Returns
+.B 0
+on termination.

 .TP
 .TP

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

 .TP
 .TP

-Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+.B Backspace (Control\-h)
+Remove a character from the input field.

 .TP
 .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.
+.TP
+.B Control\-w
+Remove all characters of current word from the input field.

 .SH SEE ALSO
 .SH SEE ALSO

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