X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=44c953b402111e755a80a1b8d5737bc0f4b23a73;hb=eadf090413c530e69e8568492ebeb4b4087bd2ad;hp=7dac2a12a831c27c46df45918aa660b2485c4bfd;hpb=745c46d8fa810bbf45ef16e79a0f84c787f1a670;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index 7dac2a1..44c953b 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -3,106 +3,96 @@ dmenu \- dynamic menu .SH SYNOPSIS .B dmenu +.RB [ \-b ] +.RB [ \-f ] .RB [ \-i ] -.RB [ \-x " "] -.RB [ \-y " "] -.RB [ \-w " "] -.RB [ \-fn " "] -.RB [ \-nb " "] -.RB [ \-nf " "] -.RB [ \-p " "] -.RB [ \-sb " "] -.RB [ \-sf " "] +.RB [ \-l +.IR lines ] +.RB [ \-p +.IR prompt ] +.RB [ \-fn +.IR font ] +.RB [ \-nb +.IR color ] +.RB [ \-nf +.IR color ] +.RB [ \-sb +.IR color ] +.RB [ \-sf +.IR color ] .RB [ \-v ] +.P +.BR dmenu_run " ..." .SH DESCRIPTION -.SS Overview -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. -.SS Options -.TP -.B \-x -defines the x coordinate dmenu appears at (0 by default). +.B dmenu +is a dynamic menu for X, originally designed for +.IR dwm (1). +It manages huge numbers of user\-defined menu items efficiently. +.P +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 Return, their +choice is printed to stdout and dmenu terminates. +.P +.B dmenu_run +is a dmenu script used by dwm which lists programs in the user's $PATH and +executes the selected item. +.SH OPTIONS .TP -.B \-y -defines the y coordinate dmenu appears at (0 by default). If it is negative, -dmenu will appear with the bottom at the given positive coordinate. It it is --0, dmenu appears at the screen bottom. +.B \-b +dmenu appears at the bottom of the screen. .TP -.B \-w -defines the width of the dmenu window (screen width by default). +.B \-f +dmenu grabs the keyboard before reading stdin. This is faster, but may lock up +X if stdin is from a terminal. .TP .B \-i -makes dmenu match menu entries case insensitively. +dmenu matches menu items case insensitively. +.TP +.BI \-l " lines" +dmenu lists items vertically, with the given number of lines. .TP -.B \-fn -defines the font. +.BI \-p " prompt" +defines the prompt to be displayed to the left of the input field. .TP -.B \-nb -defines the normal background color (#RGB, #RRGGBB, and color names are supported). +.BI \-fn " font" +defines the font or font set used. .TP -.B \-nf -defines the normal foreground color (#RGB, #RRGGBB, and color names are supported). +.BI \-nb " color" +defines the normal background color. +.IR #RGB , +.IR #RRGGBB , +and X color names are supported. .TP -.B \-p -defines a prompt to be displayed before the input area. +.BI \-nf " color" +defines the normal foreground color. .TP -.B \-sb -defines the selected background color (#RGB, #RRGGBB, and color names are supported). +.BI \-sb " color" +defines the selected background color. .TP -.B \-sf -defines the selected foreground color (#RGB, #RRGGBB, and color names are supported). +.BI \-sf " color" +defines the selected foreground color. .TP .B \-v -prints version information to standard output, then exits. +prints version information to stdout, 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: +dmenu is completely controlled by the keyboard. Besides standard Unix line +editing and item selection (arrow keys, page up/down, home and end), 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 (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) +.B Tab (Ctrl\-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 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 -on termination. +.B Return (Ctrl\-j) +Confirm selection. Prints the selected item to stdout and exits, returning +success. .TP -.B Backspace (Control\-h) -Remove a character from the input field. +.B Shift\-Return (Ctrl\-Shift\-j) +Confirm input. Prints the input text to stdout and exits, returning success. .TP -.B Control\-u -Remove all characters from the input field. +.B Escape (Ctrl\-c) +Exit without selecting an item, returning failure. .TP -.B Control\-w -Remove all characters of current word from the input field. +.B Ctrl\-y +Paste the current X selection into the input field. .SH SEE ALSO -.BR dwm (1), -.BR wmii (1) . +.IR dwm (1)