1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/gridmenu.1	Mon Jul 10 16:49:43 2006 +0200
     1.3 @@ -0,0 +1,84 @@
     1.4 +.TH GRIDMENU 1 grid-0.0
     1.5 +.SH NAME
     1.6 +gridmenu \- grid window manager menu
     1.7 +.SH SYNOPSIS
     1.8 +.B gridmenu
     1.9 +.RB [ \-v ]
    1.10 +.RB [ \-t
    1.11 +.IR title ]
    1.12 +.SH DESCRIPTION
    1.13 +.SS Overview
    1.14 +.B gridmenu
    1.15 +is a generic, highly customizable, and efficient menu for the X Window System,
    1.16 +originally designed for
    1.17 +.BR grid (1).
    1.18 +It supports arbitrary, user defined menu contents.
    1.19 +.SS Options
    1.20 +.TP
    1.21 +.B \-v
    1.22 +prints version information to stdout, then exits.
    1.23 +.TP
    1.24 +.BI \-t " title"
    1.25 +displays
    1.26 +.I title
    1.27 +above the menu.
    1.28 +.SS Usage
    1.29 +.B gridmenu
    1.30 +reads a list of newline-separated items from stdin and creates a menu.
    1.31 +When the user selects an item or enters any text and presses Enter, his choice
    1.32 +is printed to stdout and
    1.33 +.B gridmenu
    1.34 +terminates.
    1.35 +.SS Keyboard Control 
    1.36 +.B gridmenu
    1.37 +is completely controlled by the keyboard.  The following keys are recognized:
    1.38 +.TP 2
    1.39 +Any printable character
    1.40 +appends the character to the text in the input field. This works as a filter:
    1.41 +only items containing this text will be displayed.
    1.42 +.TP 2
    1.43 +Left/Right (Control-p/Control-n)
    1.44 +select the previous/next item.
    1.45 +.TP 2
    1.46 +Tab (Control-i)
    1.47 +copy the selected item to the input field.
    1.48 +.TP 2
    1.49 +Enter (Control-j)
    1.50 +confirm selection and quit (print the selected item to stdout).
    1.51 +.TP 2
    1.52 +Shift-Enter (Shift-Control-j)
    1.53 +confirm selection and quit (print the text in the input field to stdout).
    1.54 +.TP 2
    1.55 +Escape (Control-[)
    1.56 +quit without selecting an item.
    1.57 +.TP 2
    1.58 +Backspace (Control-h)
    1.59 +remove enough characters from the input field to change its filtering effect.
    1.60 +.TP 2
    1.61 +Control-u
    1.62 +remove all characters from the input field.
    1.63 +.SS Exit codes
    1.64 +.B gridmenu
    1.65 +returns
    1.66 +.B 0
    1.67 +if Enter is pressed on termination,
    1.68 +.B 1
    1.69 +if Escape is pressed.
    1.70 +.SH ENVIRONMENT
    1.71 +.TP
    1.72 +GRID_FONT
    1.73 +The X11 font used to display each item in the menu.
    1.74 +.br
    1.75 +Default: fixed
    1.76 +.TP
    1.77 +GRID_NORMCOLORS
    1.78 +The foreground, background, and border colors of a label. Syntactically, three blank-separated color values of the form #RRGGBB are expected.
    1.79 +.br
    1.80 +Default: #222222 #eeeeee #666666
    1.81 +.TP
    1.82 +GRID_SELCOLORS
    1.83 +Like GRID_NORMCOLORS, but for the selected label.
    1.84 +.br
    1.85 +Default: #ffffff #335577 #447799
    1.86 +.SH SEE ALSO
    1.87 +.BR gridwm (1)