gridmenu.1
changeset 1 f10194d4b76d
child 2 a79188fe4a40
equal deleted inserted replaced
0:491f34c11291 1:f10194d4b76d
       
     1 .TH GRIDMENU 1 grid-0.0
       
     2 .SH NAME
       
     3 gridmenu \- grid window manager menu
       
     4 .SH SYNOPSIS
       
     5 .B gridmenu
       
     6 .RB [ \-v ]
       
     7 .RB [ \-t
       
     8 .IR title ]
       
     9 .SH DESCRIPTION
       
    10 .SS Overview
       
    11 .B gridmenu
       
    12 is a generic, highly customizable, and efficient menu for the X Window System,
       
    13 originally designed for
       
    14 .BR grid (1).
       
    15 It supports arbitrary, user defined menu contents.
       
    16 .SS Options
       
    17 .TP
       
    18 .B \-v
       
    19 prints version information to stdout, then exits.
       
    20 .TP
       
    21 .BI \-t " title"
       
    22 displays
       
    23 .I title
       
    24 above the menu.
       
    25 .SS Usage
       
    26 .B gridmenu
       
    27 reads a list of newline-separated items from stdin and creates a menu.
       
    28 When the user selects an item or enters any text and presses Enter, his choice
       
    29 is printed to stdout and
       
    30 .B gridmenu
       
    31 terminates.
       
    32 .SS Keyboard Control 
       
    33 .B gridmenu
       
    34 is completely controlled by the keyboard.  The following keys are recognized:
       
    35 .TP 2
       
    36 Any printable character
       
    37 appends the character to the text in the input field. This works as a filter:
       
    38 only items containing this text will be displayed.
       
    39 .TP 2
       
    40 Left/Right (Control-p/Control-n)
       
    41 select the previous/next item.
       
    42 .TP 2
       
    43 Tab (Control-i)
       
    44 copy the selected item to the input field.
       
    45 .TP 2
       
    46 Enter (Control-j)
       
    47 confirm selection and quit (print the selected item to stdout).
       
    48 .TP 2
       
    49 Shift-Enter (Shift-Control-j)
       
    50 confirm selection and quit (print the text in the input field to stdout).
       
    51 .TP 2
       
    52 Escape (Control-[)
       
    53 quit without selecting an item.
       
    54 .TP 2
       
    55 Backspace (Control-h)
       
    56 remove enough characters from the input field to change its filtering effect.
       
    57 .TP 2
       
    58 Control-u
       
    59 remove all characters from the input field.
       
    60 .SS Exit codes
       
    61 .B gridmenu
       
    62 returns
       
    63 .B 0
       
    64 if Enter is pressed on termination,
       
    65 .B 1
       
    66 if Escape is pressed.
       
    67 .SH ENVIRONMENT
       
    68 .TP
       
    69 GRID_FONT
       
    70 The X11 font used to display each item in the menu.
       
    71 .br
       
    72 Default: fixed
       
    73 .TP
       
    74 GRID_NORMCOLORS
       
    75 The foreground, background, and border colors of a label. Syntactically, three blank-separated color values of the form #RRGGBB are expected.
       
    76 .br
       
    77 Default: #222222 #eeeeee #666666
       
    78 .TP
       
    79 GRID_SELCOLORS
       
    80 Like GRID_NORMCOLORS, but for the selected label.
       
    81 .br
       
    82 Default: #ffffff #335577 #447799
       
    83 .SH SEE ALSO
       
    84 .BR gridwm (1)