dmenu

my fork of dmenu
Index Commits Files Refs README LICENSE
dmenu.1 (3938B)
   1 .TH DMENU 1 dmenu\-VERSION
   2 .SH NAME
   3 dmenu \- dynamic menu
   4 .SH SYNOPSIS
   5 .B dmenu
   6 .RB [ \-bfiv ]
   7 .RB [ \-l
   8 .IR lines ]
   9 .RB [ \-h
  10 .IR height ]
  11 .RB [ \-m
  12 .IR monitor ]
  13 .RB [ \-x
  14 .IR xoffset ]
  15 .RB [ \-y
  16 .IR yoffset ]
  17 .RB [ \-z
  18 .IR width ]
  19 .RB [ \-p
  20 .IR prompt ]
  21 .RB [ \-fn
  22 .IR font ]
  23 .RB [ \-nb
  24 .IR color ]
  25 .RB [ \-nf
  26 .IR color ]
  27 .RB [ \-sb
  28 .IR color ]
  29 .RB [ \-sf
  30 .IR color ]
  31 .RB [ \-w
  32 .IR windowid ]
  33 .P
  34 .BR dmenu_run " ..."
  35 .SH DESCRIPTION
  36 .B dmenu
  37 is a dynamic menu for X, which reads a list of newline\-separated items from
  38 stdin.  When the user selects an item and presses Return, their choice is printed
  39 to stdout and dmenu terminates.  Entering text will narrow the items to those
  40 matching the tokens in the input.
  41 .P
  42 .B dmenu_run
  43 is a script used by
  44 .IR dwm (1)
  45 which lists programs in the user's $PATH and runs the result in their $SHELL.
  46 .SH OPTIONS
  47 .TP
  48 .B \-b
  49 dmenu appears at the bottom of the screen.
  50 .TP
  51 .B \-c
  52 dmenu appears centered on the screen.
  53 .TP
  54 .B \-f
  55 dmenu grabs the keyboard before reading stdin if not reading from a tty. This
  56 is faster, but will lock up X until stdin reaches end\-of\-file.
  57 .TP
  58 .B \-i
  59 dmenu matches menu items case insensitively.
  60 .TP
  61 .B \-S
  62 dmenu does not sort menu items after matching.
  63 .TP
  64 .BI \-l " lines"
  65 dmenu lists items vertically, with the given number of lines.
  66 .TP
  67 .BI \-h " height"
  68 dmenu uses a menu line of at least 'height' pixels tall, but no less than 8.
  69 .TP
  70 .BI \-m " monitor"
  71 dmenu is displayed on the monitor number supplied. Monitor numbers are starting
  72 from 0.
  73 .TP
  74 .BI \-x " xoffset"
  75 dmenu is placed at this offset measured from the left side of the monitor.
  76 Can be negative.
  77 If option
  78 .B \-m
  79 is present, the measurement will use the given monitor.
  80 .TP
  81 .BI \-y " yoffset"
  82 dmenu is placed at this offset measured from the top of the monitor.  If the
  83 .B \-b
  84 option is used, the offset is measured from the bottom.  Can be negative.
  85 If option
  86 .B \-m
  87 is present, the measurement will use the given monitor.
  88 .TP
  89 .BI \-z " width"
  90 sets the width of the dmenu window.
  91 .TP
  92 .BI \-p " prompt"
  93 defines the prompt to be displayed to the left of the input field.
  94 .TP
  95 .BI \-fn " font"
  96 defines the font or font set used.
  97 .TP
  98 .BI \-nb " color"
  99 defines the normal background color.
 100 .IR #RGB ,
 101 .IR #RRGGBB ,
 102 and X color names are supported.
 103 .TP
 104 .BI \-nf " color"
 105 defines the normal foreground color.
 106 .TP
 107 .BI \-sb " color"
 108 defines the selected background color.
 109 .TP
 110 .BI \-sf " color"
 111 defines the selected foreground color.
 112 .TP
 113 .B \-v
 114 prints version information to stdout, then exits.
 115 .TP
 116 .BI \-w " windowid"
 117 embed into windowid.
 118 .SH USAGE
 119 dmenu is completely controlled by the keyboard.  Items are selected using the
 120 arrow keys, page up, page down, home, and end.
 121 .TP
 122 .B Tab
 123 Copy the selected item to the input field.
 124 .TP
 125 .B Return
 126 Confirm selection.  Prints the selected item to stdout and exits, returning
 127 success.
 128 .TP
 129 .B Ctrl-Return
 130 Confirm selection.  Prints the selected item to stdout and continues.
 131 .TP
 132 .B Shift\-Return
 133 Confirm input.  Prints the input text to stdout and exits, returning success.
 134 .TP
 135 .B Escape
 136 Exit without selecting an item, returning failure.
 137 .TP
 138 .B Ctrl-Left
 139 Move cursor to the start of the current word
 140 .TP
 141 .B Ctrl-Right
 142 Move cursor to the end of the current word
 143 .TP
 144 .B C\-a
 145 Home
 146 .TP
 147 .B C\-b
 148 Left
 149 .TP
 150 .B C\-c
 151 Escape
 152 .TP
 153 .B C\-d
 154 Delete
 155 .TP
 156 .B C\-e
 157 End
 158 .TP
 159 .B C\-f
 160 Right
 161 .TP
 162 .B C\-g
 163 Escape
 164 .TP
 165 .B C\-h
 166 Backspace
 167 .TP
 168 .B C\-i
 169 Tab
 170 .TP
 171 .B C\-j
 172 Return
 173 .TP
 174 .B C\-J
 175 Shift-Return
 176 .TP
 177 .B C\-k
 178 Delete line right
 179 .TP
 180 .B C\-m
 181 Return
 182 .TP
 183 .B C\-M
 184 Shift-Return
 185 .TP
 186 .B C\-n
 187 Down
 188 .TP
 189 .B C\-p
 190 Up
 191 .TP
 192 .B C\-u
 193 Delete line left
 194 .TP
 195 .B C\-w
 196 Delete word left
 197 .TP
 198 .B C\-y
 199 Paste from primary X selection
 200 .TP
 201 .B C\-Y
 202 Paste from X clipboard
 203 .TP
 204 .B M\-b
 205 Move cursor to the start of the current word
 206 .TP
 207 .B M\-f
 208 Move cursor to the end of the current word
 209 .TP
 210 .B M\-g
 211 Home
 212 .TP
 213 .B M\-G
 214 End
 215 .TP
 216 .B M\-h
 217 Up
 218 .TP
 219 .B M\-j
 220 Page down
 221 .TP
 222 .B M\-k
 223 Page up
 224 .TP
 225 .B M\-l
 226 Down
 227 .SH SEE ALSO
 228 .IR dwm (1),
 229 .IR stest (1)