GSMENU(1)		    General Commands Manual		     GSMENU(1)



NAME
       gsmenu - grid menu

SYNOPSIS
       gsmenu [Sindre options...]

DESCRIPTION
   Overview
       gsmenu  is  a  generic  grid  menu  for	X11,  originally a port of the
       GridSelect contrib for XMonad.  Now it is a program built on Sindre. It
       displays  elements  as a grid of rectangular cells.  gsmenu always uses
       the display indicated in the DISPLAY environment variable.

   Options
       No options are accepted apart from those provided by sindre(1).

USAGE
       gsmenu reads a list of newline-separated elements from  standard  input
       and  presents  them  in	a  grid.   Each element has a foreground and a
       background colour, as well as a name  (what  will  be  visible  on  the
       screen) and a list of tags that are used only for filtering.

   INPUT FORMAT
       The standard Sindre key-value format is used.  Each line takes the form
       of key-value pairs, with the key being  a  sequence  of	alphanumerics,
       followed  by  an  equals  sign,	followed  by  a value in double quotes
       (double-quotes can be embedded by  doubling  them).   For  example,  an
       element might be

       name="foo" bg="red"

       And  a  list-value  can	be  given by simply writing more double-quoted
       strings (this also showcases double quote-escaping):

       name="quote ""this"" please" tags="bar" "baz" bg="red"

       The following keys are defined:

       name   The string that will be displayed in the grid.   The  value  can
	      also  be	a  list,  in  which case each part of the list will be
	      printed as a line by itself (note that there will  probably  not
	      be  room	for  more  than two lines).  Also, only the first line
	      will  count  as  the  "name"  as	far  as  selection  output  is
	      concerned.

       fg     The  foreground (text) colour of the element (#RGB, #RRGGBB, and
	      color names are supported).

       bg     The background colour of the element (#RGB, #RRGGBB,  and  color
	      names are supported).

       tags   A list of tags of the element, used when filtering.

       value  Instead  of  the	name,  print  the  value  of this key when the
	      element is selected.  If a list,	a  newline  is	printed  after
	      every element but the last.

   INTERACTION
       When  the  user	moves  focus  to  an  element and presses Return, that
       element is selected and	is  printed  to  standard  output  and	gsmenu
       terminates.  Elements can also be selected by clicking on them with the
       mouse.  Additionally, the following keyboard commands are recognised:

       Any printable character
	      Appends the character to the text  in  the  input  field.   This
	      works  as a filter: only items containing this text (possibly in
	      a tag) will be displayed.

       Backspace
	      Remove the last character in the input field, or if empty,  open
	      the topmost filter for editing.

       Left/Right/Up/Down (CTRL-b/CTRL-f/CTRL-p/CTRL-n)
	      Move focus in the grid.

       CTRL-a Set focus to the leftmost element in the row.

       CTRL-e Set focus to the rightmost element in the row.

       CTRL-s Focus  on  the  next  element  following	a spiral path from the
	      center.

       CTRL-r Focus on the previous element following a spiral path  from  the
	      center.

       CTRL-w Remove the topmost filter, if any.

       Escape, CTRL-c, CTRL-g
	      Cancel selection and exit gsmenu.

EXIT STATUS
       gsmenu  returns	a 0 exit status on success, 1 if there was an internal
       problem, and 2 if the user cancelled.

SEE ALSO
       sindre(1), dmenu(1), xmonad(1)



				  gsmenu-4.0			     GSMENU(1)