X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=c6827114c0df40be2bf005b6c61139f11b89e472;hb=3ba8b71abafdd52adaf8c2d4bfa56dc9023c865e;hp=3387c7acdc464206d3b94265b57a7bb02e623f59;hpb=5146c3f27f730b3b37805c1f7b19bbebe312959f;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index 3387c7a..c682711 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -3,63 +3,93 @@ dmenu \- dynamic menu .SH SYNOPSIS .B dmenu +.RB [ \-b ] +.RB [ \-fn " "] +.RB [ \-nb " "] +.RB [ \-nf " "] +.RB [ \-p " "] +.RB [ \-sb " "] +.RB [ \-sf " "] +.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 \-b +makes dmenu appear at the screen bottom (by default it appears at the screen top). +.TP +.B \-fn +defines the font. +.TP +.B \-nb +defines the normal background color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-nf +defines the normal foreground color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-p +defines a prompt to be displayed before the input area. +.TP +.B \-sb +defines the selected background color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-sf +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/her +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 (Mod1-h/Mod1-l) +Select the previous/next item. +.TP +.B PageUp/PageDown (Mod1-k/Mod1-j) +Select the first item of the previous/next 'page' of items. +.TP +.B Home/End (Mod1-g/Mod1-G) +Select the first/last item. +.TP +.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 -if Enter is pressed on termination, +on termination. +.TP +.B Shift-Return (Control-Shift-j) +Confirm selection and quit (print the text in the input field to standard output). +Returns +.B 0 +on termination. +.TP +.B Escape (Control-bracketleft) +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) +.BR dwm (1), +.BR wmii (1) .