dmenu

[fork] X11 menuing
git clone https://hhvn.uk/dmenu
git clone git://hhvn.uk/dmenu
Log | Files | Refs | README | LICENSE

dmenu.1 (4197B)


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