aewl

annotate gridmenu.1 @ 20:4560e0882c1d

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