gridmenu.1
author Anselm R. Garbe <garbeam@wmii.de>
Tue, 11 Jul 2006 11:50:18 +0200
changeset 8 7066ff2fe8bc
parent 2 a79188fe4a40
permissions -rw-r--r--
added key handling
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     1
.TH GRIDMENU 1 grid-0.0
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     2
.SH NAME
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     3
gridmenu \- grid window manager menu
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     4
.SH SYNOPSIS
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     5
.B gridmenu
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     6
.RB [ \-v ]
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     7
.RB [ \-t
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     8
.IR title ]
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
     9
.SH DESCRIPTION
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    10
.SS Overview
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    11
.B gridmenu
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    12
is a generic, highly customizable, and efficient menu for the X Window System,
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    13
originally designed for
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    14
.BR grid (1).
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    15
It supports arbitrary, user defined menu contents.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    16
.SS Options
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    17
.TP
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    18
.B \-v
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    19
prints version information to stdout, then exits.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    20
.TP
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    21
.BI \-t " title"
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    22
displays
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    23
.I title
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    24
above the menu.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    25
.SS Usage
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    26
.B gridmenu
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    27
reads a list of newline-separated items from stdin and creates a menu.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    28
When the user selects an item or enters any text and presses Enter, his choice
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    29
is printed to stdout and
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    30
.B gridmenu
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    31
terminates.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    32
.SS Keyboard Control 
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    33
.B gridmenu
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    34
is completely controlled by the keyboard.  The following keys are recognized:
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    35
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    36
Any printable character
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    37
appends the character to the text in the input field. This works as a filter:
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    38
only items containing this text will be displayed.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    39
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    40
Left/Right (Control-p/Control-n)
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    41
select the previous/next item.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    42
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    43
Tab (Control-i)
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    44
copy the selected item to the input field.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    45
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    46
Enter (Control-j)
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    47
confirm selection and quit (print the selected item to stdout).
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    48
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    49
Shift-Enter (Shift-Control-j)
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    50
confirm selection and quit (print the text in the input field to stdout).
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    51
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    52
Escape (Control-[)
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    53
quit without selecting an item.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    54
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    55
Backspace (Control-h)
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    56
remove enough characters from the input field to change its filtering effect.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    57
.TP 2
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    58
Control-u
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    59
remove all characters from the input field.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    60
.SS Exit codes
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    61
.B gridmenu
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    62
returns
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    63
.B 0
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    64
if Enter is pressed on termination,
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    65
.B 1
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    66
if Escape is pressed.
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    67
.SH SEE ALSO
f10194d4b76d added gridmenu
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
    68
.BR gridwm (1)