X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=c47044a94c3a525f4fe9c77143a52b407614777a;hb=02238725f6b580ea8b6356377e359f933c5ca720;hp=f49dda9e3390b585501da3e0b82d7e8f58514e61;hpb=6a332a043a0674884dcb3b449628be3fb3a07017;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index f49dda9..c47044a 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -1,65 +1,80 @@ -.TH DMENU 1 d-0.3 +.TH DMENU 1 dmenu-VERSION .SH NAME dmenu \- dynamic menu .SH SYNOPSIS .B dmenu +.RB [ \-font " "] +.RB [ \-normbg " "] +.RB [ \-normfg " "] +.RB [ \-selbg " "] +.RB [ \-selfg " "] +.RB [ \-t " "] .RB [ \-v ] .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). -It supports arbitrary, user defined menu contents. +It manages huge amounts (up to 10.000 and more) of user defined menu items +efficiently. .SS Options .TP +.B \-font +defines the font. +.TP +.B \-normbg +defines the normal background color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-normfg +defines the normal foreground color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-selbg +defines the selected background color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-selfg +defines the selected foreground color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-t +defines the seconds to wait for standard input, before exiting (default is 3). +.TP .B \-v -prints version information to stdout, then exits. -.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: +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 +choice is printed to standard output and dmenu terminates. +.P +dmenu is completely controlled by the keyboard. The following keys are recognized: +.TP +.B 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 +.TP +.B Left/Right +Select the previous/next item. +.TP +.B Tab +Copy the selected item to the input field. +.TP +.B Return +Confirm selection and quit (print the selected item to standard output). Returns +.B 0 +on termination. +.TP +.B Shift-Return +Confirm selection and quit (print the text in the input field to standard output). +Returns .B 0 -if Enter is pressed on termination, +on termination. +.TP +.B Escape +Quit without selecting an item. Returns .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. +on termination. +.TP +.B Backspace (Control-h) +Remove enough characters from the input field to change its filtering effect. +.TP +.B Control-u +Remove all characters from the input field. .SH SEE ALSO .BR dwm (1)