dmenu/dmenu.1

65 lines
1.5 KiB
Groff
Raw Normal View History

.TH DMENU 1 dmenu-VERSION
2006-08-04 08:35:27 +01:00
.SH NAME
dmenu \- dynamic menu
.SH SYNOPSIS
.B dmenu
.RB [ \-v ]
.SH DESCRIPTION
.SS Overview
.B dmenu
is a generic, highly customizable, and efficient menu for the X Window System,
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.
2006-08-07 13:07:04 +01:00
.SH USAGE
2006-08-04 08:35:27 +01:00
.B dmenu
reads a list of newline-separated items from stdin and creates a menu.
2006-08-07 13:07:04 +01:00
When the user selects an item or enters any text and presses Return, his choice
2006-08-04 08:35:27 +01:00
is printed to stdout and
.B dmenu
terminates.
.B dmenu
is completely controlled by the keyboard. The following keys are recognized:
2006-08-07 13:07:04 +01:00
.TP
2006-08-04 08:35:27 +01:00
Any printable character
2006-08-07 13:07:04 +01:00
Appends the character to the text in the input field. This works as a filter:
2006-08-04 08:35:27 +01:00
only items containing this text will be displayed.
2006-08-07 13:07:04 +01:00
.TP
Left/Right
2006-08-07 13:07:04 +01:00
Select the previous/next item.
.TP
Tab
2006-08-07 13:07:04 +01:00
Copy the selected item to the input field.
.TP
Return
2006-08-07 13:07:04 +01:00
Confirm selection and quit (print the selected item to stdout).
.TP
Shift-Return
2006-08-07 13:07:04 +01:00
Confirm selection and quit (print the text in the input field to stdout).
.TP
2006-08-04 08:35:27 +01:00
Escape (Control-[)
2006-08-07 13:07:04 +01:00
Quit without selecting an item.
.TP
2006-08-04 08:35:27 +01:00
Backspace (Control-h)
2006-08-07 13:07:04 +01:00
Remove enough characters from the input field to change its filtering effect.
.TP
2006-08-04 08:35:27 +01:00
Control-u
2006-08-07 13:07:04 +01:00
Remove all characters from the input field.
.P
2006-08-04 08:35:27 +01:00
.B dmenu
returns
.B 0
2006-08-07 13:07:04 +01:00
if Return is pressed on termination,
2006-08-04 08:35:27 +01:00
.B 1
if Escape is pressed.
2006-08-07 06:36:18 +01:00
.SH CUSTOMIZATION
2006-08-07 06:37:32 +01:00
.B dmenu
2006-08-07 06:36:18 +01:00
is customized by creating a custom config.h and (re)compiling the source
code. This keeps it fast, secure and simple.
2006-08-04 08:35:27 +01:00
.SH SEE ALSO
.BR dwm (1)