X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=e1f839324559984e7d6b17b9c881e2eae95e9d2a;hb=a7aee433ccfd2590e0785a7b93a89d8d0593a234;hp=0fa21f92e57e15e4ebc10697e32af8497554c391;hpb=32ea45084b389d604369d74c6806d4a12613099a;p=dmenu.git

diff --git a/dmenu.1 b/dmenu.1
index 0fa21f9..e1f8393 100644
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,64 +1,99 @@
-.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
+.IR lines ]
+.RB [ \-p
+.IR prompt ]
+.RB [ \-fn
+.IR font ]
+.RB [ \-nb
+.IR color ]
+.RB [ \-nf
+.IR color ]
+.RB [ \-sb
+.IR color ]
+.RB [ \-sf
+.IR color ]
 .RB [ \-v ]
+.P
+.BR dmenu_run " ..."
+.P
+.B dmenu_path
 .SH DESCRIPTION
-.SS Overview
 .B dmenu
-is a generic menu for X, originally designed for
+is a dynamic 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
+It manages huge numbers of user-defined menu items efficiently.
+.P
+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_run
+is a dmenu script used by dwm which lists programs in the user's PATH and
+executes the selected item.
+.P
+.B dmenu_path
+is a script used by dmenu_run to find and cache a list of programs.
+.SH OPTIONS
+.TP
+.B \-b
+dmenu appears at the bottom of the screen.
+.TP
+.B \-i
+dmenu matches menu items case insensitively.
+.TP
+.BI \-l " lines"
+dmenu lists items vertically, with the given number of lines.
+.TP
+.BI \-p " prompt"
+defines the prompt to be displayed to the left of the input area.
+.TP
+.BI \-fn " font"
+defines the font set used.
+.TP
+.BI \-nb " color"
+defines the normal background color.
+.IR #RGB ,
+.IR #RRGGBB ,
+and color names are supported.
+.TP
+.BI \-nf " color"
+defines the normal foreground color.
+.TP
+.BI \-sb " color"
+defines the selected background color.
+.TP
+.BI \-sf " color"
+defines the selected foreground color.
 .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:
-.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.
+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
-Left/Right
-Select the previous/next item.
-.TP
-Tab
+.B Tab (Control\-i)
 Copy the selected item to the input field.
 .TP
-Return
-Confirm selection and quit (print the selected item to standard output).
-.TP
-Shift-Return
-Confirm selection and quit (print the text in the input field to standard output).
+.B Return (Control\-j)
+Confirm selection.  Prints the selected item to standard output and exits,
+returning success.
 .TP
-Escape
-Quit without selecting an item.
+.B Shift\-Return (Control\-Shift\-j)
+Confirm input.  Prints the input text to standard output and exits, returning
+success.
 .TP
-Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+.B Escape (Control\-c)
+Exit without selecting an item, returning failure.
 .TP
-Control-u
-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.
+.B Control\-y
+Paste the current X selection into the input field.
 .SH SEE ALSO
 .BR dwm (1)