X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=dmenu.1;h=88f77de337b226616df8cf8e97a53eb04fdf8f3e;hb=0d12a47415edba5db73f56dba76f123394581387;hp=9cc80a5cb88dd946bba7f09a7c8378bfa7d29e39;hpb=0e96ae6f4842b4ef4c79eaea821658e24bc03d5e;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index 9cc80a5..88f77de 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -1,95 +1,171 @@ -.TH DMENU 1 dmenu-VERSION +.TH DMENU 1 dmenu\-VERSION .SH NAME dmenu \- dynamic menu .SH SYNOPSIS .B dmenu .RB [ \-b ] -.RB [ \-fn " "] -.RB [ \-nb " "] -.RB [ \-nf " "] -.RB [ \-p " "] -.RB [ \-sb " "] -.RB [ \-sf " "] -.RB [ \-t " "] +.RB [ \-f ] +.RB [ \-i ] +.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 +.B dmenu +is a dynamic menu for X, which reads a list of newline\-separated items from +stdin. When the user selects an item and presses Return, their choice is printed +to stdout and dmenu terminates. Entering text will narrow the items to those +matching the tokens in the input. +.P +.B dmenu_run +is a script used by +.IR dwm (1) +which lists programs in the user's $PATH and runs the result in their $SHELL. +.SH OPTIONS .TP .B \-b -makes dmenu appear at the screen bottom (by default it appears at the screen top). +dmenu appears at the bottom of the screen. .TP -.B \-font -defines the font. +.B \-f +dmenu grabs the keyboard before reading stdin. This is faster, but will lock up +X until stdin reaches end\-of\-file. .TP -.B \-nb -defines the normal background color (#RGB, #RRGGBB, and color names are supported). +.B \-i +dmenu matches menu items case insensitively. .TP -.B \-nf -defines the normal foreground color (#RGB, #RRGGBB, and color names are supported). +.BI \-l " lines" +dmenu lists items vertically, with the given number of lines. .TP -.B \-p -defines a prompt to be displayed before the input area. +.BI \-p " prompt" +defines the prompt to be displayed to the left of the input field. .TP -.B \-sb -defines the selected background color (#RGB, #RRGGBB, and color names are supported). +.BI \-fn " font" +defines the font or font set used. .TP -.B \-sf -defines the selected 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 \-t -defines the seconds to wait for standard input, before exiting (default is 3). +.BI \-nf " color" +defines the normal foreground color. .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. -.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. +.BI \-sb " color" +defines the selected background color. .TP -.B Left/Right -Select the previous/next item. +.BI \-sf " color" +defines the selected foreground color. .TP -.B PageUp/PageDown -Select the first item of the previous/next 'page' of items. -.TP -.B Home/End -Select the first/last item. +.B \-v +prints version information to stdout, then exits. +.SH USAGE +dmenu is completely controlled by the keyboard. Items are selected using the +arrow keys, page up, page down, home, and end. .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. +Confirm selection. Prints the selected item to stdout and exits, returning +success. +.TP +.B Ctrl-Return +Confirm selection. Prints the selected item to stdout and continues. .TP -.B Shift-Return -Confirm selection and quit (print the text in the input field to standard output). -Returns -.B 0 -on termination. +.B Shift\-Return +Confirm input. Prints the input text to stdout and exits, returning success. .TP .B Escape -Quit without selecting an item. Returns -.B 1 -on termination. +Exit without selecting an item, returning failure. +.TP +C\-a +Home +.TP +C\-b +Left +.TP +C\-c +Escape +.TP +C\-d +Delete +.TP +C\-e +End +.TP +C\-f +Right +.TP +C\-g +Escape +.TP +C\-h +Backspace +.TP +C\-i +Tab +.TP +C\-j +Return +.TP +C\-J +Shift-Return +.TP +C\-k +Delete line right +.TP +C\-m +Return +.TP +C\-n +Down +.TP +C\-p +Up +.TP +C\-u +Delete line left +.TP +C\-w +Delete word left +.TP +C\-y +Paste from primary X selection +.TP +C\-Y +Paste from X clipboard +.TP +M\-g +Home +.TP +M\-G +End +.TP +M\-h +Up +.TP +M\-j +Page down .TP -.B Backspace (Control-h) -Remove enough characters from the input field to change its filtering effect. +M\-k +Page up .TP -.B Control-u -Remove all characters from the input field. +M\-l +Down .SH SEE ALSO -.BR dwm (1), -.BR wmii (1) . +.IR dwm (1), +.IR stest (1)