X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=f0c45f49f87ce02508dad7d18981312271a42557;hb=08b264393d41321c1b7ae3644f73c67cb825c95c;hp=fa3adc0b3a1d063e9d7ebb181c2f6ecc09d35928;hpb=1f207893e6162f8ae8be17440830ca1eb1e80746;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index fa3adc0..f0c45f4 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -1,62 +1,101 @@ -.TH DMENU 1 dmenu-VERSION +.TH DMENU 1 dmenu\-VERSION .SH NAME 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 [ \-v ] + +.B dmenu_run +[] + +.B dmenu_path .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. + +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. +.TP +.B \-b +defines that dmenu appears at the bottom. +.TP +.B \-e +reparents dmenu to the window specified by xid. +.TP +.B \-l +activates vertical list mode. +The given number of lines will be displayed. Window height will be adjusted. +.TP +.B \-fn +defines the font. +.TP +.B \-nb +defines the normal background color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-nf +defines the normal foreground color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-p +defines a prompt to be displayed before the input area. +.TP +.B \-sb +defines the selected background color (#RGB, #RRGGBB, and color names are supported). +.TP +.B \-sf +defines the selected foreground color (#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 +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 (Up/Down or Left/Right, PageUp/PageDown, Home/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 -Select the previous/next 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). -.TP -.B Shift-Return -Confirm selection and quit (print the text in the input field to standard output). -.TP -.B Escape -Quit without selecting an item. -.TP -.B Backspace (Control-h) -Remove enough characters from the input field to change its filtering effect. +.B Return (Control\-j) +Confirm selection and quit (print the selected item to standard output). Returns +.B 0 +on termination. .TP -.B Control-u -Remove all characters from the input field. -.P -dwm returns +.B Shift\-Return (Control\-Shift\-j) +Confirm input and quit (print the text in the input field to standard output). +Returns .B 0 -if -.B Return -is pressed and +on termination. +.TP +.B Escape (Control\-c) +Quit without selecting an item. Returns .B 1 -if -.B Escape -is pressed on termination. -.SH CUSTOMIZATION -dmenu is customized by creating a custom config.h and (re)compiling the source -code. This keeps it fast, secure and simple. +on termination. +.TP +.B Control\-y +Pastes the X selection into the input field. This requires +.BR sselp (1). .SH SEE ALSO -.BR dwm (1) +.BR dwm (1), +.BR wmii (1).