X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=76bb71c6fe58a2be9a20ffa12357fac4246941ed;hb=3438af001adcb1d8ff840f89ae7cb5ef8589bde6;hp=fb0a5fe7fa9b10de9c2ac72da560135bdb534909;hpb=d4a4cc1ab8c316c22f3d6f2a47b287a6db6fa1d7;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index fb0a5fe..76bb71c 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -3,62 +3,92 @@ dmenu \- dynamic menu .SH SYNOPSIS .B dmenu +.RB [ \-bottom ] +.RB [ \-font " "] +.RB [ \-normbg " "] +.RB [ \-normfg " "] +.RB [ \-selbg " "] +.RB [ \-selfg " "] +.RB [ \-p " "] +.RB [ \-t " "] .RB [ \-v ] .SH DESCRIPTION .SS Overview -.B dmenu -is a generic, highly customizable, and efficient menu for X, -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 \-bottom +makes dmenu appear at the screen bottom (by default it appears at the screen top). +.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 \-p +defines a prompt to be displayed before the input area. +.TP +.B \-t +defines the seconds to wait for standard input, before exiting (default is 3). +.TP .B \-v prints version information to standard output, then exits. .SH USAGE -.B 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 -.B dmenu -terminates. -.B dmenu -is completely controlled by the keyboard. The following keys are recognized: +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 -Any printable character -Appends the character to the text in the input field. This works as a filter: +.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 -Left/Right +.B Left/Right Select the previous/next item. .TP -Tab +.B PageUp/PageDown +Select the first item of the previous/next 'page' of items. +.TP +.B Home/End +Select the first/last item. +.TP +.B Tab Copy the selected item to the input field. .TP -Return -Confirm selection and quit (print the selected item to standard output). +.B Return +Confirm selection and quit (print the selected item to standard output). Returns +.B 0 +on termination. .TP -Shift-Return +.B Shift-Return Confirm selection and quit (print the text in the input field to standard output). +Returns +.B 0 +on termination. .TP -Escape -Quit without selecting an item. +.B Escape +Quit without selecting an item. Returns +.B 1 +on termination. .TP -Backspace (Control-h) +.B Backspace (Control-h) Remove enough characters from the input field to change its filtering effect. .TP -Control-u +.B 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. .SH SEE ALSO .BR dwm (1)