X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=e5aa8cd653048c188423e6f09f0685be1ed5e09d;hb=1654d6cd6269bc784ee99045edd89e4bda24149f;hp=f0c45f49f87ce02508dad7d18981312271a42557;hpb=08b264393d41321c1b7ae3644f73c67cb825c95c;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index f0c45f4..e5aa8cd 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -3,99 +3,106 @@ dmenu \- dynamic menu .SH SYNOPSIS .B dmenu -.RB [ \-i ] .RB [ \-b ] -.RB [ \-e " ]" -.RB [ \-l " ]" -.RB [ \-fn " ]" -.RB [ \-nb " ]" -.RB [ \-nf " ]" -.RB [ \-p " ]" -.RB [ \-sb " ]" -.RB [ \-sf " ]" +.RB [ \-f ] +.RB [ \-i ] +.RB [ \-l +.IR lines ] +.RB [ \-m +.IR monitor ] +.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 ] - -.B dmenu_run -[] - +.P +.BR dmenu_run " ..." +.P .B dmenu_path .SH DESCRIPTION -.SS Overview -dmenu is a generic menu for X, originally designed for +.B dmenu +is a dynamic 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. - -dmenu_run is a dmenu script used by dwm which lists executables in the user's PATH -and executes the selected item. - -dmenu_path is a script used by dmenu_run to find and cache a list of executables. -.SS Options -.TP -.B \-i -makes dmenu match menu entries case insensitively. +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. +.P +.B dmenu_path +is a script used by dmenu_run to find and cache a list of executables. +.SH OPTIONS .TP .B \-b -defines that dmenu appears at the bottom. +dmenu appears at the bottom of the screen. .TP -.B \-e -reparents dmenu to the window specified by xid. +.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 \-l -activates vertical list mode. -The given number of lines will be displayed. Window height will be adjusted. +.B \-i +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 \-m " monitor" +dmenu appears on the given Xinerama screen. .TP -.B \-nb -defines the normal background color (#RGB, #RRGGBB, and color names are supported). +.BI \-p " prompt" +defines the prompt to be displayed to the left of the input field. .TP -.B \-nf -defines the normal foreground color (#RGB, #RRGGBB, and color names are supported). +.BI \-fn " font" +defines the font or font set used. .TP -.B \-p -defines a prompt to be displayed before the input area. +.BI \-nb " color" +defines the normal background color. +.IR #RGB , +.IR #RRGGBB , +and X color names are supported. .TP -.B \-sb -defines the selected background color (#RGB, #RRGGBB, and color names are supported). +.BI \-nf " color" +defines the normal foreground color. .TP -.B \-sf -defines the selected foreground color (#RGB, #RRGGBB, and color names are supported). +.BI \-sb " color" +defines the selected background color. +.TP +.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. Besides standard Unix line editing, -and item selection (Up/Down or Left/Right, PageUp/PageDown, Home/End), the following -keys are recognized: +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 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 -on termination. +Confirm selection. Prints the selected item to stdout and exits, returning +success. .TP .B Shift\-Return (Control\-Shift\-j) -Confirm input and quit (print the text in the input field to standard output). -Returns -.B 0 -on termination. +Confirm input. Prints the input text to stdout and exits, returning success. .TP .B Escape (Control\-c) -Quit without selecting an item. Returns -.B 1 -on termination. +Exit without selecting an item, returning failure. .TP .B Control\-y -Pastes the X selection into the input field. This requires -.BR sselp (1). +Paste the current X selection into the input field. .SH SEE ALSO -.BR dwm (1), -.BR wmii (1). +.BR dwm (1)