X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=2d8bc201faa3c18ec08ca5c88512e00eb26ef051;hb=a3606ecb0eeaffa752fdf26565ebaaba29b83239;hp=926b559bbb926aa994b1fc9270df98c87fc7cd3a;hpb=e4fbc432534bfb42a0b0d97bcdd687274780e95e;p=dmenu.git

diff --git a/dmenu.1 b/dmenu.1
index 926b559..2d8bc20 100644
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,64 +1,105 @@
-.TH DMENU 1 dmenu-VERSION
+.TH DMENU 1 dmenu\-VERSION
 .SH NAME
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
+.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_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
 .B dmenu
-is a generic, highly customizable, and efficient menu for the X Window System,
-originally designed for
+is a generic menu for X, originally designed for
 .BR dwm (1).
-It supports arbitrary, user defined menu contents.
+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 \-v
-prints version information to stdout, then exits.
-.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:
+.B \-b
+dmenu appears at the bottom of the screen.
 .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 \-i
+dmenu matches menu entries case insensitively.
 .TP
-Left/Right
-Select the previous/next item.
+.B \-l <lines>
+dmenu lists items vertically, with the given number of lines.
 .TP
-Tab
-Copy the selected item to the input field.
+.B \-p <prompt>
+sets the prompt to be displayed to the left of the input area.
+.TP
+.B \-fn <font>
+sets the font.
 .TP
-Return
-Confirm selection and quit (print the selected item to stdout).
+.B \-nb <color>
+sets the background color (#RGB, #RRGGBB, and color names are supported).
 .TP
-Shift-Return
-Confirm selection and quit (print the text in the input field to stdout).
+.B \-nf <color>
+sets the foreground color (#RGB, #RRGGBB, and color names are supported).
 .TP
-Escape
-Quit without selecting an item.
+.B \-sb <color>
+sets the background color of selected items (#RGB, #RRGGBB, and color names are
+supported).
 .TP
-Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+.B \-sf <color>
+sets the foreground color of selected items (#RGB, #RRGGBB, and color names are
+supported).
 .TP
-Control-u
-Remove all characters from the input field.
+.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,
+their choice is printed to standard output and dmenu terminates.
 .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.
+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.  Prints the selected item to standard output and exits,
+returning success.
+.TP
+.B Shift\-Return (Control\-Shift\-j)
+Confirm input.  Prints the input text to standard output and exits, returning
+success.
+.TP
+.B Escape (Control\-c)
+Quit without selecting an item, returning failure.
+.TP
+.B Control\-y
+Paste the current X selection into the input field.
 .SH SEE ALSO
-.BR dwm (1)
+.BR dwm (1),
+.BR wmii (1).