Remove function prototypes and reorder functions accordingly

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index 8f56491..2897ab1 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,64 +1,179 @@
-.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 [ \-b ]
+.RB [ \-f ]
+.RB [ \-i ]
+.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 ]

+.P
+.BR dmenu_run " ..."

 .SH DESCRIPTION
 .SH DESCRIPTION

-.SS Overview

 .B dmenu
 .B dmenu

-is a generic, highly customizable, and efficient menu for X,
-originally designed for
-.BR dwm (1).
-It supports arbitrary, user defined menu contents.
-.SS Options
+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
+is a script used by
+.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
+.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
+dmenu matches menu items case insensitively.
+.TP
+.BI \-l " lines"
+dmenu lists items vertically, with the given number of lines.
+.TP
+.BI \-m " monitor"
+dmenu is displayed on the monitor supplied.
+.TP
+.BI \-p " prompt"
+defines the prompt to be displayed to the left of the input field.
+.TP
+.BI \-fn " font"
+defines the font or font set used.
+.TP
+.BI \-nb " color"
+defines the normal background color.
+.IR #RGB ,
+.IR #RRGGBB ,
+and X 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 stdout, then exits.
 .SH USAGE
 .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:
+dmenu is completely controlled by the keyboard.  Items are selected using the
+arrow keys, page up, page down, home, and end.
+.TP
+.B Tab
+Copy the selected item to the input field.
+.TP
+.B Return
+Confirm selection.  Prints the selected item to stdout and exits, returning
+success.

 .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 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
 .TP

-Left/Right
-Select the previous/next item.
+C\-d
+Delete

 .TP
 .TP

+C\-e
+End
+.TP
+C\-f
+Right
+.TP
+C\-g
+Escape
+.TP
+C\-h
+Backspace
+.TP
+C\-i

 Tab
 Tab

-Copy the selected item to the input field.

 .TP
 .TP

+C\-j

 Return
 Return

-Confirm selection and quit (print the selected item to stdout).

 .TP
 .TP

+C\-J

 Shift-Return
 Shift-Return

-Confirm selection and quit (print the text in the input field to stdout).

 .TP
 .TP

-Escape
-Quit without selecting an item.
+C\-k
+Delete line right

 .TP
 .TP

-Backspace (Control-h)
-Remove enough characters from the input field to change its filtering effect.
+C\-m
+Return

 .TP
 .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.
+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
+M\-l
+Down

 .SH SEE ALSO
 .SH SEE ALSO

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