X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=2d8bc201faa3c18ec08ca5c88512e00eb26ef051;hb=a3606ecb0eeaffa752fdf26565ebaaba29b83239;hp=8eecf8e61466a46cdd39fc080f86700c6a5874cc;hpb=1538bb7426af201f632f6de38114caf91100d698;p=dmenu.git

diff --git a/dmenu.1 b/dmenu.1
index 8eecf8e..2d8bc20 100644
--- a/dmenu.1
+++ b/dmenu.1
@@ -3,106 +3,103 @@
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
+.RB [ \-b ]
 .RB [ \-i ]
-.RB [ \-x " <x>"]
-.RB [ \-y " <y>"]
-.RB [ \-w " <width>"]
-.RB [ \-fn " <font>"]
-.RB [ \-nb " <color>"]
-.RB [ \-nf " <color>"]
-.RB [ \-p " <prompt>"]
-.RB [ \-sb " <color>"]
-.RB [ \-sf " <color>"]
+.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_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
-dmenu is a generic menu for X, originally designed for
+.B 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.
+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
-.B \-x
-defines the x coordinate dmenu appears at (0 by default).
+.B \-b
+dmenu appears at the bottom of the screen.
 .TP
-.B \-y
-defines the y coordinate dmenu appears at (0 by default). If it is negative,
-dmenu will appear with the bottom at the given positive coordinate. If it is
--0, dmenu appears at the screen bottom.
+.B \-i
+dmenu matches menu entries case insensitively.
 .TP
-.B \-w
-defines the width of the dmenu window (screen width by default).
+.B \-l <lines>
+dmenu lists items vertically, with the given number of lines.
 .TP
-.B \-i
-makes dmenu match menu entries case insensitively.
+.B \-p <prompt>
+sets the prompt to be displayed to the left of the input area.
 .TP
 .B \-fn <font>
-defines the font.
+sets the font.
 .TP
 .B \-nb <color>
-defines the normal background color (#RGB, #RRGGBB, and color names are supported).
+sets the 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.
+sets the foreground color (#RGB, #RRGGBB, and color names are supported).
 .TP
 .B \-sb <color>
-defines the selected background color (#RGB, #RRGGBB, and color names are supported).
+sets the background color of selected items (#RGB, #RRGGBB, and color names are
+supported).
 .TP
 .B \-sf <color>
-defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
+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
-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
-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 (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.
+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
 .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
-on termination.
+Confirm selection.  Prints the selected item to standard output and exits,
+returning success.
 .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.
-.TP
-.B Escape (Control\-bracketleft)
-Quit without selecting an item. Returns
-.B 1
-on termination.
-.TP
-.B Backspace (Control\-h)
-Remove a character from the input field.
+Confirm input.  Prints the input text to standard output and exits, returning
+success.
 .TP
-.B Control\-u
-Remove all characters from the input field.
+.B Escape (Control\-c)
+Quit without selecting an item, returning failure.
 .TP
-.B Control\-w
-Remove all characters of current word from the input field.
+.B Control\-y
+Paste the current X selection into the input field.
 .SH SEE ALSO
 .BR dwm (1),
-.BR wmii (1) .
+.BR wmii (1).