X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=2d8bc201faa3c18ec08ca5c88512e00eb26ef051;hb=a3606ecb0eeaffa752fdf26565ebaaba29b83239;hp=694debdd1d44d30d40c1a92099a73f5b9af9502c;hpb=9bd80b3968a20ad91565e6090ea1d370221eb23a;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index 694debd..2d8bc20 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -1,90 +1,105 @@ -.TH DMENU 1 dmenu-VERSION +.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 [ \-p " "] -.RB [ \-t " "] +.RB [ \-b ] +.RB [ \-i ] +.RB [ \-l " ]" +.RB [ \-p " ]" +.RB [ \-fn " ]" +.RB [ \-nb " ]" +.RB [ \-nf " ]" +.RB [ \-sb " ]" +.RB [ \-sf " ]" .RB [ \-v ] + +.B dmenu_run +.RB [ \-b ] +.RB [ \-i ] +.RB [ \-l " ]" +.RB [ \-p " ]" +.RB [ \-fn " ]" +.RB [ \-nb " ]" +.RB [ \-nf " ]" +.RB [ \-sb " ]" +.RB [ \-sf " ]" +.RB [ \-v ] + +.B dmenu_path .SH DESCRIPTION .SS Overview -dmenu is a generic menu for X, originally designed for +.B dmenu +is a generic menu for X, originally designed for .BR dwm (1). -It manages huge amounts (up to 10.000 and more) of user defined menu items -efficiently. +It manages huge amounts (10000 and more) of user defined menu items efficiently. +.P +.B dmenu_run +is a dmenu script which lists programs in the user's PATH and executes +the selected item. +.P +.B dmenu_path +is a script used by +.I dmenu_run +to find and cache a list of programs. .SS Options .TP -.B \-font -defines the font. +.B \-b +dmenu appears at the bottom of the screen. .TP -.B \-normbg -defines the normal background color (#RGB, #RRGGBB, and color names are supported). +.B \-i +dmenu matches menu entries case insensitively. .TP -.B \-normfg -defines the normal foreground color (#RGB, #RRGGBB, and color names are supported). +.B \-l +dmenu lists items vertically, with the given number of lines. .TP -.B \-selbg -defines the selected background color (#RGB, #RRGGBB, and color names are supported). +.B \-p +sets the prompt to be displayed to the left of the input area. .TP -.B \-selfg -defines the selected foreground color (#RGB, #RRGGBB, and color names are supported). +.B \-fn +sets the font. .TP -.B \-p -defines a prompt to be displayed before the input area. +.B \-nb +sets the background color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-nf +sets the 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). +.B \-sb +sets the background color of selected items (#RGB, #RRGGBB, and color names are +supported). +.TP +.B \-sf +sets the foreground color of selected items (#RGB, #RRGGBB, and color names are +supported). .TP .B \-v 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. +menu. When the user selects an item or enters any text and presses Return, +their 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 -.B Left/Right -Select the previous/next item. +dmenu is completely controlled by the keyboard. Besides standard Unix line +editing and item selection (Up/Down/Left/Right, PageUp/PageDown, Home/End), the +following keys are recognized: .TP -.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 +.B Tab (Control\-i) 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 -on termination. +.B Return (Control\-j) +Confirm selection. Prints the selected item to standard output and exits, +returning success. .TP -.B Escape -Quit without selecting an item. Returns -.B 1 -on termination. +.B Shift\-Return (Control\-Shift\-j) +Confirm input. Prints the input text to standard output and exits, returning +success. .TP -.B Backspace (Control-h) -Remove enough characters from the input field to change its filtering effect. +.B Escape (Control\-c) +Quit without selecting an item, returning failure. .TP -.B Control-u -Remove all characters from the input field. +.B Control\-y +Paste the current X selection into the input field. .SH SEE ALSO -.BR dwm (1) +.BR dwm (1), +.BR wmii (1).