dmenu.1: clarify monitor numbers are starting from 0 (first mon)

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index 2d8bc20..d3ab805 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -4,102 +4,177 @@ dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 .RB [ \-b ]
 .SH SYNOPSIS
 .B dmenu
 .RB [ \-b ]

+.RB [ \-f ]

 .RB [ \-i ]
 .RB [ \-i ]

-.RB [ \-l " <lines>]"
-.RB [ \-p " <prompt>]"
-.RB [ \-fn " <font>]"
-.RB [ \-nb " <color>]"
-.RB [ \-nf " <color>]"
-.RB [ \-sb " <color>]"
-.RB [ \-sf " <color>]"
+.RB [ \-l
+.RB [ \-m
+.IR monitor ]
+.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 ]
 .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
+.P
+.BR dmenu_run " ..."

 .SH DESCRIPTION
 .SH DESCRIPTION

-.SS Overview

 .B dmenu
 .B dmenu

-is a generic menu for X, originally designed for
-.BR dwm (1).
-It manages huge amounts (10000 and more) of user defined menu items efficiently.
+is a dynamic menu for X, which reads a list of newline\-separated items from
+stdin.  When the user selects an item and presses Return, their choice is printed
+to stdout and dmenu terminates.  Entering text will narrow the items to those
+matching the tokens in the input.

 .P
 .B dmenu_run
 .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
 is a script used by

-.I dmenu_run
-to find and cache a list of programs.
-.SS Options
+.IR dwm (1)
+which lists programs in the user's $PATH and runs the result in their $SHELL.
+.SH OPTIONS

 .TP
 .B \-b
 dmenu appears at the bottom of the screen.
 .TP
 .TP
 .B \-b
 dmenu appears at the bottom of the screen.
 .TP

+.B \-f
+dmenu grabs the keyboard before reading stdin.  This is faster, but will lock up
+X until stdin reaches end\-of\-file.
+.TP

 .B \-i
 .B \-i

-dmenu matches menu entries case insensitively.
+dmenu matches menu items case insensitively.

 .TP
 .TP

-.B \-l <lines>
+.BI \-l " lines"

 dmenu lists items vertically, with the given number of lines.
 .TP
 dmenu lists items vertically, with the given number of lines.
 .TP

-.B \-p <prompt>
-sets the prompt to be displayed to the left of the input area.
+.BI \-m " monitor"
+dmenu is displayed on the monitor number supplied. Monitor numbers are starting
+from 0.
+.TP
+.BI \-p " prompt"
+defines the prompt to be displayed to the left of the input field.

 .TP
 .TP

-.B \-fn <font>
-sets the font.
+.BI \-fn " font"
+defines the font or font set used.

 .TP
 .TP

-.B \-nb <color>
-sets the background color (#RGB, #RRGGBB, and color names are supported).
+.BI \-nb " color"
+defines the normal background color.
+.IR #RGB ,
+.IR #RRGGBB ,
+and X color names are supported.

 .TP
 .TP

-.B \-nf <color>
-sets the foreground color (#RGB, #RRGGBB, and color names are supported).
+.BI \-nf " color"
+defines the normal foreground color.

 .TP
 .TP

-.B \-sb <color>
-sets the background color of selected items (#RGB, #RRGGBB, and color names are
-supported).
+.BI \-sb " color"
+defines the selected background color.

 .TP
 .TP

-.B \-sf <color>
-sets the foreground color of selected items (#RGB, #RRGGBB, and color names are
-supported).
+.BI \-sf " color"
+defines the selected foreground color.

 .TP
 .B \-v
 .TP
 .B \-v

-prints version information to standard output, then exits.
+prints version information to stdout, then exits.

 .SH USAGE
 .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
-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:
+dmenu is completely controlled by the keyboard.  Items are selected using the
+arrow keys, page up, page down, home, and end.

 .TP
 .TP

-.B Tab (Control\-i)
+.B Tab

 Copy the selected item to the input field.
 .TP
 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
+.B Return
+Confirm selection.  Prints the selected item to stdout and exits, returning

 success.
 .TP
 success.
 .TP

-.B Escape (Control\-c)
-Quit without selecting an item, returning failure.
+.B Ctrl-Return
+Confirm selection.  Prints the selected item to stdout and continues.
+.TP
+.B Shift\-Return
+Confirm input.  Prints the input text to stdout and exits, returning success.
+.TP
+.B Escape
+Exit without selecting an item, returning failure.
+.TP
+C\-a
+Home
+.TP
+C\-b
+Left
+.TP
+C\-c
+Escape
+.TP
+C\-d
+Delete
+.TP
+C\-e
+End
+.TP
+C\-f
+Right
+.TP
+C\-g
+Escape
+.TP
+C\-h
+Backspace
+.TP
+C\-i
+Tab
+.TP
+C\-j
+Return
+.TP
+C\-J
+Shift-Return
+.TP
+C\-k
+Delete line right
+.TP
+C\-m
+Return
+.TP
+C\-M
+Shift-Return
+.TP
+C\-n
+Down
+.TP
+C\-p
+Up
+.TP
+C\-u
+Delete line left
+.TP
+C\-w
+Delete word left
+.TP
+C\-y
+Paste from primary X selection
+.TP
+C\-Y
+Paste from X clipboard
+.TP
+M\-g
+Home
+.TP
+M\-G
+End
+.TP
+M\-h
+Up
+.TP
+M\-j
+Page down
+.TP
+M\-k
+Page up

 .TP
 .TP

-.B Control\-y
-Paste the current X selection into the input field.
+M\-l
+Down

 .SH SEE ALSO
 .SH SEE ALSO

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