dmenu.1

   1 .TH DMENU 1 dmenu-VERSION
   2 .SH NAME
   3 dmenu \- dynamic menu
   4 .SH SYNOPSIS
   5 .B dmenu
   6 .RB [ \-v ]
   7 .SH DESCRIPTION
   8 .SS Overview
   9 .B dmenu
  10 is a generic, highly customizable, and efficient menu for the X Window System,
  11 originally designed for
  12 .BR dwm (1).
  13 It supports arbitrary, user defined menu contents.
  14 .SS Options
  15 .TP
  16 .B \-v
  17 prints version information to stdout, then exits.
  18 .SH USAGE
  19 .B dmenu
  20 reads a list of newline-separated items from stdin and creates a menu.
  21 When the user selects an item or enters any text and presses Return, his choice
  22 is printed to stdout and
  23 .B dmenu
  24 terminates.
  25 .B dmenu
  26 is completely controlled by the keyboard.  The following keys are recognized:
  27 .TP
  28 Any printable character
  29 Appends the character to the text in the input field. This works as a filter:
  30 only items containing this text will be displayed.
  31 .TP
  32 Left/Right (Control-p/Control-n)
  33 Select the previous/next item.
  34 .TP
  35 Tab (Control-i)
  36 Copy the selected item to the input field.
  37 .TP
  38 Return (Control-j)
  39 Confirm selection and quit (print the selected item to stdout).
  40 .TP
  41 Shift-Return (Shift-Control-j)
  42 Confirm selection and quit (print the text in the input field to stdout).
  43 .TP
  44 Escape (Control-[)
  45 Quit without selecting an item.
  46 .TP
  47 Backspace (Control-h)
  48 Remove enough characters from the input field to change its filtering effect.
  49 .TP
  50 Control-u
  51 Remove all characters from the input field.
  52 .P
  53 .B dmenu
  54 returns
  55 .B 0
  56 if Return is pressed on termination,
  57 .B 1
  58 if Escape is pressed.
  59 .SH CUSTOMIZATION
  60 .B dmenu
  61 is customized by creating a custom config.h and (re)compiling the source
  62 code. This keeps it fast, secure and simple.
  63 .SH SEE ALSO
  64 .BR dwm (1)