typo fixes
[dmenu.git] / dmenu.1
diff --git a/dmenu.1 b/dmenu.1
index 0fa21f9..f0c45f4 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
-.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 [ \-e " <xid>]"
+.RB [ \-l " <lines>]"
+.RB [ \-fn " <font>]"
+.RB [ \-nb " <color>]"
+.RB [ \-nf " <color>]"
+.RB [ \-p " <prompt>]"
+.RB [ \-sb " <color>]"
+.RB [ \-sf " <color>]"
 .RB [ \-v ]
 .RB [ \-v ]
+
+.B dmenu_run
+[<options...>]
+
+.B dmenu_path
 .SH DESCRIPTION
 .SS Overview
 .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.
 .BR dwm (1).
 It manages huge amounts (up to 10.000 and more) of user defined menu items
 efficiently.
+
+dmenu_run is a dmenu script used by dwm which lists executables in the user's PATH
+and executes the selected item.
+
+dmenu_path is a script used by dmenu_run to find and cache a list of executables.
 .SS Options
 .TP
 .SS Options
 .TP
-.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:
+.B \-i
+makes dmenu match menu entries case insensitively.
 .TP
 .TP
-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.
+.B \-b
+defines that dmenu appears at the bottom.
 .TP
 .TP
-Left/Right
-Select the previous/next item.
+.B \-e <xid>
+reparents dmenu to the window specified by xid.
 .TP
 .TP
-Tab
-Copy the selected item to the input field.
+.B \-l <lines>
+activates vertical list mode.
+The given number of lines will be displayed. Window height will be adjusted.
+.TP
+.B \-fn <font>
+defines the font.
 .TP
 .TP
-Return
-Confirm selection and quit (print the selected item to standard output).
+.B \-nb <color>
+defines the normal background color (#RGB, #RRGGBB, and color names are supported).
 .TP
 .TP
-Shift-Return
-Confirm selection and quit (print the text in the input field to standard output).
+.B \-nf <color>
+defines the normal foreground color (#RGB, #RRGGBB, and color names are supported).
 .TP
 .TP
-Escape
-Quit without selecting an item.
+.B \-p <prompt>
+defines a prompt to be displayed before the input area.
 .TP
 .TP
-Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+.B \-sb <color>
+defines the selected background color (#RGB, #RRGGBB, and color names are supported).
 .TP
 .TP
-Control-u
-Remove all characters from the input field.
+.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
+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
 .P
-.B dmenu
-returns
+dmenu is completely controlled by the keyboard. Besides standard Unix line editing,
+and item selection (Up/Down or Left/Right, PageUp/PageDown, Home/End), the following
+keys are recognized:
+.TP
+.B Tab (Control\-i)
+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
 .B 0
-if Return is pressed on termination,
+on termination.
+.TP
+.B Shift\-Return (Control\-Shift\-j)
+Confirm input and quit (print the text in the input field to standard output).
+Returns
+.B 0
+on termination.
+.TP
+.B Escape (Control\-c)
+Quit without selecting an item. Returns
 .B 1
 .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.
+on termination.
+.TP
+.B Control\-y
+Pastes the X selection into the input field. This requires
+.BR sselp (1).
 .SH SEE ALSO
 .SH SEE ALSO
-.BR dwm (1)
+.BR dwm (1),
+.BR wmii (1).