JGMENU(1)

NAME

jgmenu - A simple X11 menu

SYNOPSIS

jgmenu [--no-spawn] [--checkout=<tag>] [--config-file=<file>]
[--icon-size=<size>] [--at-pointer] [--hide-on-startup]
[--simple] [--vsimple] [--csv-file<file>]
[--csv-cmd=<command>] [--die-when-loaded]
[--center]

jgmenu init [--help | <options>]

  Use these three commands to get started

    ┌────────────────────┬─────────────────────────┐
    | jgmenu             | launch menu             |
    ├────────────────────┼─────────────────────────┤
    | jgmenu init        | create config file      |
    ├────────────────────┼─────────────────────────┤
    | man jgmenututorial | read step-by-step guide |
    └────────────────────┴─────────────────────────┘

DESCRIPTION

jgmenu is a small menu application for Linux/BSD. It is intended to
be used with openbox and tint2, but is not dependent on these.

jgmenu reads a list of new-line (`\n') separated items from a file
and creates a menu. Each line is parsed into the following fields
using comma as a field separator:

(1) description

(2) command

(3) icon,

(4) working directory

(5) metadata

Empty lines and lines beginning with `#' are ignored. When the user
selects an item by left-clicking or pressing enter), the command
of their selection is executed as a new process.

For example:

    printf "Terminal,xterm\nWeb Browser,firefox" | jgmenu --simple

If the user wishes to use a comma in a field, triple quotes can be
used around the whole field in the format aaa,""“bbb”""

For example:

    foo,"""^pipe(find . -printf '%f,display %p,%p\n')"""

  Markup

The syntax ^foo(bar) is used to carry out action “foo” with argument
“bar”.

The following markup is supported in the description field:

•   ^sep() - define a separator (with or without text)

The following markup is supported in the command field:

•   ^tag() - define a submenu (can be in the description field if
no other field is defined on that line)

•   ^checkout() - open a submenu in a new window

•   ^root() - open a submenu in the root window, replacing the
current menu

•   ^sub() - draw a “submenu” arrow

•   ^back() - check-out parent menu

•   ^term() - run program in terminal

•   ^pipe() - execute sub-process and checkout a menu based on its
stdout.

•   ^filter() - invoke search

  Icons

Icons will be displayed if the third field is populated; for example:

    Terminal,xterm,utilities-terminal
    Firefox,firefox,firefox

OPTIONS

--no-spawn
    redirect command to stdout rather than executing it

--checkout=<tag>
    checkout submenu <tag> on startup

--config-file=<file>
    read config file

--icon-size=<size>
    specify icon size (22 by default)
If set to 0, icons will not be loaded.

--at-pointer
    launch menu at mouse pointer

--hide-on-startup
    start menu is hidden state

--simple
    - ignore tint2 settings
- run in `short-lived' mode (i.e. exit after mouse click or
enter/escape)
- read menu items from stdin

--vsimple
    same as –simple, but also disables icons and ignores jgmenurc

--csv-file=<file>
    specify menu file (in jgmenu flavoured CSV format)
If file cannot be opened, input if reverted to stdin

--csv-cmd=<command>
    specify command to produce menu data
E.g. jgmenu_run pmenu

--die-when-loaded
    open menu and then exit(0). This is for debugging and testing.

--center
    center align menu horizontally and vertically
Also set tint2_look=0 to disable alignment to tint2 panel

USER INTERFACE

•   Up/Down - select previous/next item

•   Left/Right - move to parent/sub menu

•   PgUp/PgDn - scroll up/down by one menu’s worth of items

•   Home/End - select first/last item

•   Enter - select an item or open a submenu

•   F5 - restart

•   F8 - print node tree to stderr

•   F9 - exit(1)

•   F10 - exit(0)

•   Backspace - return to parent menu

Type any string to invoke a search. Words separated by space will
be searched for using OR logic (i.e. the match of either word is
sufficient to display an item).

CONFIGURATION FILE

If no file is specified using the –config-file= option, the XDG Base
Directory Specification is adhered to. I.e:

•   Global config in ${XDG_CONFIG_DIRS:-/etc/xdg}

•   User config override in ${XDG_CONFIG_HOME:-$HOME/.config}

For most users ~/.config/jgmenu/jgmenurc is appropriate.

Global config variables are set in the following order (i.e. bottom
of list has higher precedence):

•   built-in defaults (config.c)

•   tint2rc config file (can be specified by TINT2_CONFIG
environment variable

•   jgmenurc config file (can be specified by –config-file=)

•   command line arguments

  Syntax

Lines beginning with # are ignored.

All other lines are recognised as setting variables in the format
key = value

White spaces are mostly ignored.

  Values

Unless otherwise specified, values as treated as simple strings.

Here follow some specific types:

boolean
When a variable takes a boolean value, only 0 and 1 are accepted.
0 means false; 1 means true.

integer
When a variable takes an integer value, only numerical values are
accepted. The only valid characters are digits (0-9) and
minus-sign.

All integer variables relating to geometry and position are
interpreted as pixel values unless otherwise specified.

color
When a variable takes a color value, only the syntax described
below is recognised:

#rrggbb aaa

where rr, gg and bb represent hexadecimal values (00-ff) for
the colours red, green and blue respectively; and aaa stands for
the alpha channel value expressed as a percentage (0-100).
(i.e. 100 means no transparency and 0 means fully transparent.)

For example #ff0000 100 represents red with no transparency,
whereas #000088 50 means dark blue with 50% transparency.

pathname
When a variable takes a pathname value, it is evaluated as a
string. If the first character is tilde (~), it will be
replaced by the the environment variable $HOME just as a shell
would expand it.

  Variables

stay_alive = boolean (default 1)

If set to 1, the menu will “hide” rather than “exit” when the
following events occur:
- clicking on menu item
- clicking outside the menu
- pressing escape
When in the hidden mode, a USR1 signal will “un-hide” the menu.

hide_on_startup = boolean (default 0)

If set to 1, jgmenu start in “hidden” mode. This is useful for
starting jgmenu during the boot process and then sending a
killall -SIGUSR1 jgmenu to show the menu.

csv_cmd = string (default pmenu)

Defines the command to produce the jgmenu flavoured CSV for
jgmenu. Accpetable keyword include pmenu, lx and ob.
If a value is given other than these keywords, it will be
executed in a shell (so be careful!). If left blank, jgmenu
will read from stdin. Examples:

    csv_cmd = lx
    csv_cmd = jgmenu_run lx --no-dirs
    csv_cmd = cat ~/mymenu.csv

tint2_look = boolean (default 1)

Reads tint2rc and parses config options for colours, dimensions
and alignment. Also reads tint2 button environment variables.
These give more accurate alignment along the length of the panel
than what parsing the tint2 config file can achieve.

at_pointer = boolean (default 0)

If enabled, the menu is launched at the pointer position,
ignoring menu_margin_? and menu_?align values.

edge_snap_x = integer (default 30)

Specify the distance (in pixles) from the left hand edge, within
which the menu will snap to the edge.
Note that this only applies in at_pointer mode.

terminal_exec = string (default x-terminal-emulator)
terminal_args = string (default -e)

The values of these two variables are used to build a string to
launch programs requiring a terminal to run.
With the default values, the string would become:

x-terminal-emulator -e `some_command with arguments'

terminal_args must finish with `-e' or equivalent (where `-e'
refers to the meaning of `-e' in `xterm -e'.

monitor = integer (default 0)

Specify a particular monitor as an index starting from 1.
If 0, the menu will be launched on the monitor where the mouse
is.

hover_delay = integer (default 100)

The amount of time (in milliseconds) from hovering over an item
until a submenu is opened.

hide_back_items = boolean (default 1)

If enabled, all ^back() items will be suppressed. As a general
rule, it should be set to 1 for a multi-window menu, and 0 when
in single-window mode.

columns = integer (default 1)

Specify the number of columns in which to show menu items

tabs = integer (default 120)

Specify the position is pixels of the first tab

menu_margin_x = integer (default 0)
menu_margin_y = integer (default 0)

“margin” refers to space outside an object
The menu_margin_* variables refer to the distance between the
menu (=X11 window) and the edge of the screen.
See note on _NET_WORKAREA under menu_{v,h}align variables

menu_width = integer (default 200)

Set the minimum menu width. The menu width will adjust to the
longest item in the current (sub)menu. If a filter is applied
(e.g. by the user typing) the menu width will NOT adjust.

menu_height_min = integer (default 0)
menu_height_max = integer (default 0)

Set the min and max height of the root menu. If these are set to
the same value, the menu height will be fixed at that value. If
set to zero, they will be ignored.

menu_height_mode = (static | dynamic) (default static)

“static” means that the height of the initial root menu will be
used for any subsequent ^root() action.

“dynamic” means that the root menu height will be re-calculated
every time the root menu is redefined using ^root().

menu_padding_top = integer (default 5)
menu_padding_right = integer (default 5)
menu_padding_bottom = integer (default 5)
menu_padding_left = integer (default 5)

“padding” refers to space inside an object (between border and
content)

menu_radius = integer (default 1)

“radius” refers to the size of rounded corners

menu_border = integer (default 0)

“border” refers to the border-thickness

menu_halign = (left | right | center) (default left)
menu_valign = (top | bottom | center) (default bottom)

Horizontal and vertical alignment respectively.

Note: If these variables are not set, jgmenu will try to guess
the alignment and margin by reading _NET_WORKAREA and tint2’s
config file and environment variables.

_NET_WORKAREA is a freedesktop EWMH root window property. Not
all Window Managers and Panels respect these.
Here follow some example of those that do:
openbox, xfwm4, tint2, polybar
And some that do not:
awesome, i3, bspwm, plank

sub_spacing = integer (default 1)

Horizontal space between windows. A negative value results in
each submenu window overlapping its parent window.

sub_padding_top = integer (default auto)
sub_padding_right = integer (default auto)
sub_padding_bottom = integer (default auto)
sub_padding_left = integer (default auto)

The same as menu_padding_* but applies to submenu windows
only. It understands the keyword `auto'. If set to `auto', the
smallest of the four menu_padding_* will be used.

sub_hover_action = integer (default 1)

Open submenu when hovering over item (only works in multi-window
mode).

item_margin_x = integer (default 3)
item_margin_y = integer (default 3)
item_height = integer (default 25)
item_padding_x = integer (default 4)
item_radius = integer (default 1)
item_border = integer (default 0)

See equivalent menu_ variable definitions.

item_halign = (left | right) (default left)

Horizontal alignment of actual menu items. Items are left-aligned
by default. If set to right, the option arrow_string should be
changed too.

sep_height = integer (default 5)

Height of separator without text (defined by ^sep())
Note that separators with text use item_height

sep_halign = (left | center | right) (default left)

Horizontal alignment of separator text

sep_markup = string (unset by default)

If specified, <span $sep_markup>foo</span> will be passed to pango
for ^sep(foo). See the following link for pango attributes:
https://developer.gnome.org/pango/stable/PangoMarkupFormat.html

Keywords include (but are not limited to):
font
size (x-small, small, medium, large, x-large)
style (normal, oblique, italic)
weight (ultralight, light, normal, bold, ultrabold, heavy
foreground (using format #rrggbb or a colour name)
underline (none, single, double)

Example:
sep_markup = font="Sans Italic 12" foreground="blue"

font = string (unset by default)

font accepts a string such as Cantarell 10 or
UbuntuCondensed 11. The font description without a specified
size unit is interpreted as “points”. If “px” is added, it will
be read as pixels. Using “points” enables consistency with other
applications.

font_fallback = string (default xtg)

The same as `icon_theme_fallback' (see below), except that
the xsettings variable `Gtk/FontName' is read.

icon_size = integer (default 22)

If icon_size is set to 0, icons will not be searched for and
loaded.

icon_text_spacing = integer (default 10)

Distance between icon and text.

icon_theme = string (unset by default)

Specify icon theme.

icon_theme_fallback = string (default xtg)

Specifies the fallback sources of the icon theme in order of
precedence, where the left-most letter designates the source
with the highest precedence. The following are acceptable
characters:

x = xsettings `Net/IconThemeName'
t = tint2 config file
g = gtk3.0 config file

`icon_theme' takes priority if set.

In order to increase consistency with tint2, xsettings
variables will only be read if the tint2rc variable
launcher_icon_theme_override is zero.

arrow_string = string (default ▸)

The “arrow” indicates that a menu item points a submenu.
Suggested styles include:
→ ▶ ➔ ➙ ➛ ➜ ➝ ➞ ➟ ➠ ➡ ➢ ➣ ➤ ➥ ➦ ↦ ⇒ ⇝ ⇢ ⇥ ⇨ ⇾ ➭ ➮ ➯ ➱ ➲ ➺ ➼ ➽ ➾

arrow_width = integer (default 15)

Width of area allocated for arrow. Set to 0 to hide arrow.

color_menu_bg = color (default #000000 85)

Background colour of menu window

color_menu_border = color (default #eeeeee 8)

Border colour of menu window

color_norm_bg = color (default #000000 0)
color_norm_fg = color (default #eeeeee 100)

Background and foreground (=font) colors of all menu items,
except the one currently selected.

color_sel_bg = color (default #ffffff 20)
color_sel_fg = color (default #eeeeee 100)
color_sel_border = color (default #eeeeee 8)

Background, foreground (=font) and border colors of the currently
selected menu item.

color_sep_fg = color (default #ffffff 20)

Colour of seperator

color_scroll_ind = color (default #eeeeee 40)

Colour of scroll indicator lines (which show if there are menu
items above or below those which are visible).

  CSV generator variables

The following variables begin with “csv_” which denotes that they set
environment variables which are used by the CSV generators.

csv_name_format = string (default %n (%g))

Defines the format of the name field for CSV generators
(currently only applicable to lx). It understands the following
two fields:
%n - application name
%g - application generic name
If a generic name does not exist or is the same as the name,
%n will be used without any formatting.

csv_single_window = boolean (default 0)

If set, ^root() will be used instead of ^checkout().
This results in a single window menu, where submenus appear in
the same window.
This is currently only supported by pmenu.

csv_no_dirs = boolean (default 0)

If set, applications will be listed without any directory
structure. This is currently only supported by pmenu and lx.

csv_i18n = string (no default)

If set, the ob module will look for a translation file in the
specified file or directory. See jgmenu_run i18n --help for
further details.

DIAGRAMS

  Vertical

    menu
    ╔════════════════════════╗  1. menu_padding_top
    ║            1           ║  2. item_margin_y
    ╟────────────────────────╢  3. menu_padding_bottom
    ║            2           ║
    ╟────────────────────────╢
    ║          item          ║
    ╟────────────────────────╢
    ║            2           ║
    ╟────────────────────────╢
    ║          item          ║
    ╟────────────────────────╢
    ║            2           ║
    ╟────────────────────────╢
    ║            3           ║
    ╚════════════════════════╝

  Horizontal

    menu
    ╔═╤═╤════════════════╤═╤═╗  1. item_margin_x
    ║ | |                | | ║  2. padding_left
    ║ | ├────────────────┤ | ║  3. padding_right
    ║ | | @    web      >| | ║  4. icon_size
    ║ | ├────────────────┤ | ║  5. icon_to_text_spacing
    ║2|1|                |1|3║  6. arrow_width
    ║ | ├───┬─┬────────┬─┤ | ║
    ║ | | 4 |5|        |6| | ║
    ║ | ├───┴─┴────────┴─┤ | ║
    ║ | |                | | ║
    ║ | |                | | ║
    ╚═╧═╧════════════════╧═╧═╝

  External to menu

    screen
    ╔════════════════════════╗  1. menu_margin_x
    ║    2                   ║  2. menu_margin_y
    ║ ──────┐               ║  3. sub_spacing
    ║ | root | ──────┐      ║
    ║1| menu | | sub  |      ║
    ║ |      |3| menu |      ║
    ║ └──────┘ |      |      ║
    ║          └──────┘      ║
    ║                        ║
    ║                        ║
    ║                        ║
    ╚════════════════════════╝

SEE ALSO

jgmenu_run(1)
jgmenututorial(7)

The jgmenu source code and documentation can be downloaded from
<https://github.com/johanmalm/jgmenu/>

AUTHORS
Johan Malm.