added dmenu.h, common.c

[dmenu.git] / dmenu.1

diff --git a/dmenu.1 b/dmenu.1
index da69047..f0c45f4 100644 (file)
--- a/dmenu.1
+++ b/dmenu.1
@@ -1,68 +1,101 @@
-.TH DMENU 1 d-0.0
+.TH DMENU 1 dmenu\-VERSION

 .SH NAME
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu
 .SH NAME
 dmenu \- dynamic menu
 .SH SYNOPSIS
 .B dmenu

+.RB [ \-i ]
+.RB [ \-b ]
+.RB [ \-e " <xid>]"
+.RB [ \-l " <lines>]"
+.RB [ \-fn " <font>]"
+.RB [ \-nb " <color>]"
+.RB [ \-nf " <color>]"
+.RB [ \-p " <prompt>]"
+.RB [ \-sb " <color>]"
+.RB [ \-sf " <color>]"

 .RB [ \-v ]
 .RB [ \-v ]

-.RB [ \-t
-.IR title ]
+
+.B dmenu_run
+[<options...>]
+
+.B dmenu_path

 .SH DESCRIPTION
 .SS Overview
 .SH DESCRIPTION
 .SS Overview

-.B dmenu
-is a generic, highly customizable, and efficient menu for the X Window System,
-originally designed for
+dmenu is a generic menu for X, originally designed for

 .BR dwm (1).
 .BR dwm (1).

-It supports arbitrary, user defined menu contents.
+It manages huge amounts (up to 10.000 and more) of user defined menu items
+efficiently.
+
+dmenu_run is a dmenu script used by dwm which lists executables in the user's PATH
+and executes the selected item.
+
+dmenu_path is a script used by dmenu_run to find and cache a list of executables.

 .SS Options
 .TP
 .SS Options
 .TP

+.B \-i
+makes dmenu match menu entries case insensitively.
+.TP
+.B \-b
+defines that dmenu appears at the bottom.
+.TP
+.B \-e <xid>
+reparents dmenu to the window specified by xid.
+.TP
+.B \-l <lines>
+activates vertical list mode.
+The given number of lines will be displayed. Window height will be adjusted.
+.TP
+.B \-fn <font>
+defines the font.
+.TP
+.B \-nb <color>
+defines the normal 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.
+.TP
+.B \-sb <color>
+defines the selected background color (#RGB, #RRGGBB, and color names are supported).
+.TP
+.B \-sf <color>
+defines the selected foreground color (#RGB, #RRGGBB, and color names are supported).
+.TP

 .B \-v
 .B \-v

-prints version information to stdout, then exits.
+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.
+.P
+dmenu is completely controlled by the keyboard. Besides standard Unix line editing,
+and item selection (Up/Down or Left/Right, PageUp/PageDown, Home/End), the following
+keys are recognized:

 .TP
 .TP

-.BI \-t " title"
-displays
-.I title
-above the menu.
-.SS 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 Enter, his choice
-is printed to stdout and
-.B dmenu
-terminates.
-.SS Keyboard Control 
-.B dmenu
-is completely controlled by the keyboard.  The following keys are recognized:
-.TP 2
-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 2
-Left/Right (Control-p/Control-n)
-select the previous/next item.
-.TP 2
-Tab (Control-i)
-copy the selected item to the input field.
-.TP 2
-Enter (Control-j)
-confirm selection and quit (print the selected item to stdout).
-.TP 2
-Shift-Enter (Shift-Control-j)
-confirm selection and quit (print the text in the input field to stdout).
-.TP 2
-Escape (Control-[)
-quit without selecting an item.
-.TP 2
-Backspace (Control-h)
-remove enough characters from the input field to change its filtering effect.
-.TP 2
-Control-u
-remove all characters from the input field.
-.SS Exit codes
-.B dmenu
-returns
+.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.
+.TP
+.B Shift\-Return (Control\-Shift\-j)
+Confirm input and quit (print the text in the input field to standard output).
+Returns

 .B 0
 .B 0

-if Enter is pressed on termination,
+on termination.
+.TP
+.B Escape (Control\-c)
+Quit without selecting an item. Returns

 .B 1
 .B 1

-if Escape is pressed.
+on termination.
+.TP
+.B Control\-y
+Pastes the X selection into the input field. This requires
+.BR sselp (1).

 .SH SEE ALSO
 .SH SEE ALSO

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