X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dmenu.1;h=fb0a5fe7fa9b10de9c2ac72da560135bdb534909;hb=04eade6a767a4145388585f666c6d1628285e96d;hp=3387c7acdc464206d3b94265b57a7bb02e623f59;hpb=5146c3f27f730b3b37805c1f7b19bbebe312959f;p=dmenu.git diff --git a/dmenu.1 b/dmenu.1 index 3387c7a..fb0a5fe 100644 --- a/dmenu.1 +++ b/dmenu.1 @@ -7,54 +7,53 @@ dmenu \- dynamic menu .SH DESCRIPTION .SS Overview .B dmenu -is a generic, highly customizable, and efficient menu for the X Window System, +is a generic, highly customizable, and efficient menu for X, originally designed for .BR dwm (1). It supports arbitrary, user defined menu contents. .SS Options .TP .B \-v -prints version information to stdout, then exits. -.SS Usage +prints version information to standard output, then exits. +.SH USAGE .B 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 Enter, his choice -is printed to stdout and +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 choice +is printed to standard output and .B dmenu terminates. -.SS Keyboard Control .B dmenu is completely controlled by the keyboard. The following keys are recognized: -.TP 2 +.TP Any printable character -appends the character to the text in the input field. This works as a filter: +Appends the character to the text in the input field. This works as a filter: only items containing this text will be displayed. -.TP 2 -Left/Right (Control-p/Control-n) -select the previous/next item. -.TP 2 -Tab (Control-i) -copy the selected item to the input field. -.TP 2 -Enter (Control-j) -confirm selection and quit (print the selected item to stdout). -.TP 2 -Shift-Enter (Shift-Control-j) -confirm selection and quit (print the text in the input field to stdout). -.TP 2 -Escape (Control-[) -quit without selecting an item. -.TP 2 +.TP +Left/Right +Select the previous/next item. +.TP +Tab +Copy the selected item to the input field. +.TP +Return +Confirm selection and quit (print the selected item to standard output). +.TP +Shift-Return +Confirm selection and quit (print the text in the input field to standard output). +.TP +Escape +Quit without selecting an item. +.TP Backspace (Control-h) -remove enough characters from the input field to change its filtering effect. -.TP 2 +Remove enough characters from the input field to change its filtering effect. +.TP Control-u -remove all characters from the input field. -.SS Exit codes +Remove all characters from the input field. +.P .B dmenu returns .B 0 -if Enter is pressed on termination, +if Return is pressed on termination, .B 1 if Escape is pressed. .SH CUSTOMIZATION