jgmenu

https://jgmenu.github.io/
Admin
jgmenu is a simple, independent, contemporary-looking X11 menu, designed for scripting, ricing and...
Tokens:9,887
Snippets:159
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize with interactive mode

Source: https://jgmenu.github.io/jgmenututorial.7.html

Start the initialization process in interactive mode to select themes.

```bash
jgmenu_run init -i
```

--------------------------------

### Create Menu Data File

Source: https://jgmenu.github.io/jgmenututorial.7.html

Example of creating a text file containing menu items.

```bash
echo >foo.txt <<EOF
xterm
firefox
EOF
```

--------------------------------

### Start jgmenu in background

Source: https://jgmenu.github.io/integration.html

Use this command to launch jgmenu during boot. Note that _NET_WORKAREA may not be read correctly when started this way.

```bash
(sleep 2s; jgmenu --hide-on-startup) &
```

--------------------------------

### Install Dependencies and ACYLS

Source: https://jgmenu.github.io/redeyepike.html

Commands to install required system packages and clone the ACYLS icon repository.

```bash
sudo pacman -S python-gobject python-lxml
cd ~/.local/share/icons
git clone https://github.com/worron/ACYLS.git
python3 ACYLS/scripts/run.py
```

--------------------------------

### Launch jgmenu

Source: https://jgmenu.github.io/jgmenu_run.1.html

Executes the menu, mapping an existing instance if one is running or starting a new one.

```bash
jgmenu_run
```

--------------------------------

### Define Menu Items with Icons

Source: https://jgmenu.github.io/jgmenu.1.html

Example of CSV data including descriptions, commands, and icon names.

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

--------------------------------

### Configure csv_cmd variable

Source: https://jgmenu.github.io/jgmenu.1.html

Examples of setting the csv_cmd variable to define how the menu content is generated.

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

--------------------------------

### Define a jgmenu schema file

Source: https://jgmenu.github.io/jgmenu-apps.1.html

Example schema file structure mapping categories to menu names and icons.

```text
Name=Accessories
Name[sv]=Tillbehör
Icon=applications-accessories
Categories=Accessibility;Core;Utility;

Name=Development
Name[sv]=Utveckling
Icon=applications-development
Categories=Development;

Name=Education
Name[sv]=Utbildning
Icon=applications-science
Categories=Education;

Name=Games
Name[sv]=Spel
Icon=applications-games
Categories=Game;

Name=Graphics
Name[sv]=Grafik
Icon=applications-graphics
Categories=Graphics;

Name=Multimedia
Name[sv]=Multimedia
Icon=applications-multimedia
Categories=Audio;Video;AudioVideo;

Name=Internet
Name[sv]=Internet
Icon=applications-internet
Categories=Network;

Name=Office
Name[sv]=Kontorsprogram
Icon=applications-office
Categories=Office;

Name=Other
Name[sv]=Övrigt
Icon=applications-other

Name=Settings
Name[sv]=Inställningar
Icon=preferences-desktop
Categories=Settings;Screensaver;

Name=System
Name[sv]=System
Icon=applications-system
Categories=Emulator;System;
```

--------------------------------

### Synchronize with GTK theme

Source: https://jgmenu.github.io/jgmenu.1.html

Example hook configuration to synchronize jgmenu with the GTK theme settings.

```text
~/.config/gtk-3.0/settings.ini,jgmenu_run gtktheme
```

--------------------------------

### Implement submenus with markup

Source: https://jgmenu.github.io/jgmenututorial.7.html

Use ^checkout() to link to a submenu and ^tag() to define the start of that submenu section.

```text
Terminal,xterm
File Manager,pcmanfm
Settings,^checkout(settings)

^tag(settings)
Set Background Image,nitrogen
```

```text
# the root-menu
item0.0
item0.1
sub1,^checkout(1)
sub2,^checkout(2)

# the first sub-menu
^tag(1)
item1.0
item1.1

# the second sub-menu
^tag(2)
item2.0
item2.1
```

--------------------------------

### Integrate i18n in command plumbing

Source: https://jgmenu.github.io/jgmenu-i18n.1.html

Example of piping a CSV-generating command through the i18n utility before passing it to jgmenu.

```bash
<csv-generating-command> \
    | jgmenu_run i18n <translation-file> \
    | jgmenu --vsimple
```

--------------------------------

### Configure Separator Markup

Source: https://jgmenu.github.io/jgmenu.1.html

Example of setting the sep_markup variable to define Pango markup attributes for separators.

```text
sep_markup = font="Sans Italic 12" foreground="blue"
```

--------------------------------

### Define jgmenu widget syntax

Source: https://jgmenu.github.io/jgmenu.1.html

Use this CSV format for lines starting with '@' to define widgets in jgmenu.

```text
@type,action,x,y,w,h,r,halign,valign,fgcol,bgcol,content
```

--------------------------------

### Initialize configuration

Source: https://jgmenu.github.io/jgmenututorial.7.html

Create the default configuration file at ~/.config/jgmenu/jgmenurc.

```bash
jgmenu_run init
```

--------------------------------

### Initialize jgmenu with themes

Source: https://jgmenu.github.io/screenshots.html

Commands to initialize jgmenu using different theme configurations.

```bash
jgmenu_run init --theme=col3
```

```bash
jgmenu_run init --theme=col2
```

```bash
jgmenu_run init --theme=greeneye
```

```bash
jgmenu_run init --theme=archlabs_1803
```

```bash
jgmenu_run init --theme=bunsenlabs_lithium
```

--------------------------------

### Run jgmenu with Input File

Source: https://jgmenu.github.io/jgmenututorial.7.html

Methods for launching jgmenu using a pre-existing text file.

```bash
cat foo.txt | jgmenu --simple --icon-size=0

jgmenu --vsimple --csv-file="foo.txt"
```

--------------------------------

### Launch jgmenu

Source: https://jgmenu.github.io/jgmenu.1.html

Basic commands for initializing and launching the jgmenu application.

```bash
jgmenu_run
```

```bash
jgmenu_run init
```

```bash
jgmenu_run init -i
```

```bash
man jgmenututorial
```

--------------------------------

### Create File with Here-Document

Source: https://jgmenu.github.io/jgmenututorial.7.html

Standard shell syntax for creating a file using a here-document.

```bash
cat >file <<EOF
foo
bar
EOF
```

--------------------------------

### Configure Unity desktop file execution

Source: https://jgmenu.github.io/integration.html

Prepend the Exec command with the JGMENU_UNITY environment variable to prevent launcher flashing.

```ini
Exec=env JGMENU_UNITY=1 jgmenu_run
```

--------------------------------

### Construct and Execute Menu Script

Source: https://jgmenu.github.io/jgmenututorial.7.html

Creating a shell script that generates menu items dynamically and pipes them to jgmenu.

```bash
cat <<EOF >menu.sh
#!/bin/sh
(
printf "foo\n"
printf "bar\n"
) | jgmenu --vsimple
EOF
chmod +x menu.sh
./menu.sh
```

--------------------------------

### Display Simple Menu via Pipe

Source: https://jgmenu.github.io/jgmenu.1.html

Demonstrates piping CSV data directly into jgmenu for a simple interface.

```bash
printf "Terminal,xterm\nWeb Browser,firefox" | jgmenu --vsimple
```

--------------------------------

### Enable tint2 panel synchronization

Source: https://jgmenu.github.io/jgmenututorial.7.html

Configures jgmenu to match the visual style of the tint2 panel.

```text
tint2_look=1
```

--------------------------------

### Create a pipemenu

Source: https://jgmenu.github.io/jgmenututorial.7.html

Use the ^pipe() markup to dynamically generate menu content.

```text
Terminal,xterm
File Manager,pcmanfm
^pipe(jgmenu_run pmenu)
```

--------------------------------

### Configure tint2rc

Source: https://jgmenu.github.io/redeyepike.html

Full configuration file for the tint2 panel, including backgrounds, taskbar, and launcher settings.

```text
#-------------------------------------
# Gradients
#-------------------------------------
# Backgrounds
# Background 1: Panel
rounded = 0
border_width = 1
border_sides = B
background_color = #2c313c 100
border_color = #8fa1b3 100
background_color_hover = #000000 60
border_color_hover = #000000 30
background_color_pressed = #000000 60
border_color_pressed = #000000 30

# Background 2: Default task, Iconified task
rounded = 4
border_width = 1
border_sides = TBLR
background_color = #777777 0
border_color = #777777 0
background_color_hover = #aaaaaa 22
border_color_hover = #eaeaea 44
background_color_pressed = #555555 4
border_color_pressed = #eaeaea 44

# Background 3: Active task
rounded = 4
border_width = 2
border_sides = B
background_color = #777777 0
border_color = #6ba4e7 100
background_color_hover = #aaaaaa 22
border_color_hover = #eaeaea 44
background_color_pressed = #555555 4
border_color_pressed = #eaeaea 44

# Background 4: Urgent task
rounded = 4
border_width = 1
border_sides = TBLR
background_color = #aa4400 100
border_color = #aa7733 100
background_color_hover = #cc7700 100
border_color_hover = #aa7733 100
background_color_pressed = #555555 4
border_color_pressed = #aa7733 100

# Background 5: Tooltip
rounded = 1
border_width = 4
border_sides = TBLR
background_color = #ffffaa 100
border_color = #ca8c8c 79
gradient_id = 0
background_color_hover = #ffffaa 100
border_color_hover = #000000 100
background_color_pressed = #ffffaa 100
border_color_pressed = #d2a0a0 100

#-------------------------------------
# Panel
panel_items = PPP:T:PE:B:C
panel_size = 100% 24
panel_margin = 0 0
panel_padding = 2 0 2
panel_background_id = 1
wm_menu = 1
panel_dock = 0
panel_position = top center horizontal
panel_layer = top
panel_monitor = all
panel_shrink = 0
autohide = 0
autohide_show_timeout = 0
autohide_hide_timeout = 0.5
autohide_height = 2
strut_policy = follow_size
panel_window_name = tint2
disable_transparency = 1
mouse_effects = 1
font_shadow = 0
mouse_hover_icon_asb = 100 0 10
mouse_pressed_icon_asb = 100 0 0

#-------------------------------------
# Taskbar
taskbar_mode = single_desktop
taskbar_hide_if_empty = 0
taskbar_padding = 6 1 2
taskbar_background_id = 0
taskbar_active_background_id = 0
taskbar_name = 0
taskbar_hide_inactive_tasks = 0
taskbar_hide_different_monitor = 0
taskbar_hide_different_desktop = 0
taskbar_always_show_all_desktop_tasks = 0
taskbar_name_padding = 4 2
taskbar_name_background_id = 0
taskbar_name_active_background_id = 0
taskbar_name_font_color = #8fa1b3 100
taskbar_name_active_font_color = #6ba4e7 100
taskbar_distribute_size = 0
taskbar_sort_order = none
task_align = left
task_thumbnail = 1
task_thumbnail_size = 200

#-------------------------------------
# Task
task_text = 0
task_icon = 1
task_centered = 1
urgent_nb_of_blink = 100000
task_maximum_size = 40 35
task_padding = 6 2 4
task_tooltip = 1
task_font_color = #8fa1b3 100
task_background_id = 2
task_active_background_id = 3
task_urgent_background_id = 4
task_iconified_background_id = 2
mouse_left = toggle_iconify
mouse_middle = none
mouse_right = close
mouse_scroll_up = toggle
mouse_scroll_down = iconify

#-------------------------------------
# System tray (notification area)
systray_padding = 0 4 2
systray_background_id = 0
systray_sort = ascending
systray_icon_size = 24
systray_icon_asb = 100 0 0
systray_monitor = 1
systray_name_filter = 

#-------------------------------------
# Launcher
launcher_padding = 2 4 2
launcher_background_id = 0
launcher_icon_background_id = 0
launcher_icon_size = 24
launcher_icon_asb = 100 0 0
launcher_icon_theme = ACYLS
launcher_icon_theme_override = 1
startup_notifications = 1
launcher_tooltip = 1
launcher_item_app = /usr/share/applications/tint2conf.desktop
launcher_item_app = /usr/local/share/applications/tint2conf.desktop
launcher_item_app = /usr/share/applications/firefox.desktop
launcher_item_app = /usr/share/applications/iceweasel.desktop
launcher_item_app = /usr/share/applications/chromium-browser.desktop
launcher_item_app = /usr/share/applications/google-chrome.desktop
```

--------------------------------

### i3 Window Manager Bindings

Source: https://jgmenu.github.io/integration.html

Configure keyboard shortcuts and status bar mouse events in the i3 configuration file.

```text
bindsym $mod+z exec jgmenu_run
```

```text
bar {
        bindsym button3 exec --no-startup-id jgmenu_run
}
```

--------------------------------

### Define configuration key-value pairs

Source: https://jgmenu.github.io/jgmenu.1.html

The standard syntax for setting configuration variables in jgmenu.

```text
key = value
```

--------------------------------

### Configure prepend.csv

Source: https://jgmenu.github.io/jgmenututorial.7.html

Add menu items to the top of the root menu by defining them in ~/.config/jgmenu/prepend.csv.

```csv
Browser,      firefox,               firefox
File manager, pcmanfm,               system-file-manager
Terminal,     xterm,                 utilities-terminal
^sep()
```

--------------------------------

### Create translation file templates

Source: https://jgmenu.github.io/jgmenu-i18n.1.html

Commands to generate a skeleton translation file from existing menu generators or CSV files.

```bash
jgmenu_run ob | jgmenu_run i18n --init >sv
```

```bash
jgmenu_run i18n --init <prepend.csv >sv
```

--------------------------------

### Configure Rofi-style menu layout

Source: https://jgmenu.github.io/jgmenututorial.7.html

Sets parameters to achieve a Rofi-like appearance for the jgmenu interface.

```text
csv_no_dirs=1
csv_single_window=1
columns=2
menu_width=600
menu_valign=center
menu_halign=center
```

--------------------------------

### Create Submenu with ^sub()

Source: https://jgmenu.github.io/jgmenu.1.html

Draws a submenu arrow and executes a command to populate the submenu.

```text
item0.0
item0.1
submenu1,^sub(echo "item1.0" | jgmenu --simple)
```

--------------------------------

### xmonad Key and Mouse Bindings

Source: https://jgmenu.github.io/integration.html

Define custom key and mouse bindings within xmonad.hs to launch jgmenu.

```haskell
customKeys (XConfig { modMask = modm }) = M.fromList
  [ ((modm, xK_p), spawn "jgmenu_run") ...
```

```haskell
customMouseBindings (XConfig { modMask = modm }) = M.fromList
  [ ((modm, button2), const $ spawn "jgmenu_run") ...
```

--------------------------------

### Define Menu Structure with Tags

Source: https://jgmenu.github.io/jgmenu.1.html

Uses ^tag() to define sub-structures and ^checkout() or ^root() to navigate between them.

```text
item0.0
item0.1
submenu1,^checkout(1)
submenu2,^root(2)

^tag(1)
item1.0
item1.1

^tag(2)
item2.0
item2.1
```

--------------------------------

### Openbox Keyboard and Mouse Bindings

Source: https://jgmenu.github.io/integration.html

Add these snippets to ~/.config/openbox/rc.xml to trigger jgmenu via keyboard or mouse.

```xml
<keybind key="C-Escape">
  <action name="Execute">
    <command>jgmenu_run</command>
  </action>
</keybind>
```

```xml
<mousebind button="Right" action="Release">
  <action name="Execute">
    <command>jgmenu_run</command>
  </action>
</mousebind>
```

--------------------------------

### List jgmenu commands

Source: https://jgmenu.github.io/jgmenu_run.1.html

Displays all executable programs available in the jgmenu libexec directory.

```bash
ls $(jgmenu_run --exec-path)
```

--------------------------------

### dwm Configuration and jgmenurc

Source: https://jgmenu.github.io/integration.html

Integrate jgmenu into dwm by modifying config.h and adjusting the jgmenurc file for appearance and pointer behavior.

```c
{ MODKEY, XK_F1, spawn, {.v = jgmenucmd } },
```

```c
static const char *jgmenucmd[]  = { "jgmenu_run", NULL };
```

```text
tint2_look          = 0
menu_width          = 120
menu_margin_y       = 17
menu_margin_x       = 0
menu_padding_top    = 0
menu_padding_right  = 0
menu_padding_bottom = 0
menu_padding_left   = 0
menu_radius         = 1
menu_valign         = top
sub_spacing         = 0
item_margin_x       = 1
item_margin_y       = 1
item_height         = 17
sep_height          = 4
icon_size           = 0
arrow_width         = 8
```

```c
{ ClkWinTitle, 0, Button1, spawn, {.v = jgmenucmd } },
{ ClkWinTitle, 0, Button3, spawn, {.v = jgmenucmd } },
{ ClkRootWin,  0, Button3, spawn, {.v = jgmenucmd } },
```

```text
at_pointer          = 1
```

--------------------------------

### Configure tint2 button plugin

Source: https://jgmenu.github.io/integration.html

Add these lines to your tint2rc to create a jgmenu button plugin.

```ini
button = new
button_icon = /path/to/favourite_icon.png
button_lclick_command = jgmenu_run
```

--------------------------------

### Access CSV generator documentation

Source: https://jgmenu.github.io/jgmenututorial.7.html

View manual pages or help messages for specific CSV generators.

```bash
man jgmenu-<command>
jgmenu_run <command> --help
```

--------------------------------

### Synchronize GTK theme

Source: https://jgmenu.github.io/integration.html

Scripts to detect GTK theme changes and update jgmenu accordingly. Requires the startup script to be executable.

```bash
#!/bin/sh

gtktheme () {
    while IFS='=' read -r key value; do
        if [ "${key}" = "gtk-theme-name" ]; then
            printf '%s' "${value}"
            return 0
        fi
    done < "$HOME/.config/gtk-3.0/settings.ini"
}

old=$(cat ~/.cache/jgmenu/.last-gtktheme)
new=$(gtktheme)

if ! [ "${old}" = "${new}" ]; then
    printf '%b\n' "info: change gtk theme from ${old} to ${new}"
    jgmenu_run gtktheme
fi
```

```conf
~/.config/gtk-3.0/settings.ini,jgmenu_run gtktheme
```

--------------------------------

### Define menu items with descriptions

Source: https://jgmenu.github.io/jgmenututorial.7.html

Use a comma-separated format to define a menu item label and its corresponding command.

```csv
Terminal,xterm
File Manager,pcmanfm
```

--------------------------------

### Configure compton shadow and fade exclusions

Source: https://jgmenu.github.io/integration.html

Add these rules to compton.conf to manage window shadows and fading behavior for jgmenu.

```conf
shadow-exclude = [ "name = 'jgmenu'" ];
```

```conf
shadow-exclude = [ "class_g = 'jgmenu'" ];
```

```conf
fade-exclude = [ "name = 'jgmenu'" ];
```

--------------------------------

### Architecture Process Flow

Source: https://jgmenu.github.io/jgmenututorial.7.html

Visual representation of the jgmenu process architecture.

```text
┌────────────────┐
│ csv-generator  │
└────────────────┘
        |
        V
┌────────────────┐
│ graphical menu │
└────────────────┘
```

--------------------------------

### Configure append.csv

Source: https://jgmenu.github.io/jgmenututorial.7.html

Add menu items to the bottom of the root menu by defining them in ~/.config/jgmenu/append.csv.

```csv
^sep()
Suspend,      systemctl -i suspend,  system-log-out
Reboot,       systemctl -i reboot,   system-reboot
Poweroff,       systemctl -i poweroff, system-shutdown
```

--------------------------------

### Integrate obmenu-generator

Source: https://jgmenu.github.io/integration.html

Configure jgmenu to use obmenu-generator for menu data, either as a short-lived command or a persistent configuration.

```bash
jgmenu --csv-cmd="jgmenu_run ob --cmd='obmenu-generator -i'" --simple
```

```conf
csv_cmd = jgmenu_run ob --cmd='obmenu-generator -i'
```

--------------------------------

### Configure jgmenurc

Source: https://jgmenu.github.io/redeyepike.html

Configuration settings for the jgmenu appearance and borders.

```text
tint2_look          = 1
menu_border         = 1
item_height         = 20
item_border         = 1
icon_size           = 16
color_menu_border   = #8FA1B3 30
color_sel_border    = #8FA1B3 40
color_sep_fg        = #8FA1B3 40
```

--------------------------------

### Add search widget to jgmenu

Source: https://jgmenu.github.io/jgmenututorial.7.html

Insert a search box into the menu by adding this line to the prepend.csv configuration file.

```csv
@search,,3,3,150,20,2,left,top,auto,#000000 0,Type to Search
```

--------------------------------

### Pipe CSV output to jgmenu

Source: https://jgmenu.github.io/jgmenututorial.7.html

Use the --simple flag to read CSV data from standard input.

```bash
jgmenu_run pmenu | jgmenu --simple
```

--------------------------------

### Adjust menu padding for search

Source: https://jgmenu.github.io/jgmenututorial.7.html

Update the menu padding configuration to accommodate the search widget.

```text
menu_padding_top=24
```

--------------------------------

### Bind super-key using xcape

Source: https://jgmenu.github.io/integration.html

Map the Super key to a specific key combination using xcape after binding the command to that combination.

```bash
xcape -e 'Super_L=Control_L|Escape'
```

--------------------------------

### Define a jgmenu hook

Source: https://jgmenu.github.io/jgmenu.1.html

Hooks follow a specific format to trigger commands upon file changes.

```text
<file>,<command>
```

--------------------------------

### Disable tint2 startup notifications

Source: https://jgmenu.github.io/integration.html

Set this in your tint2rc to prevent the spinning hourglass cursor after clicking the menu button.

```ini
startup_notifications = 0
```

--------------------------------

### Define polybar jgmenu module

Source: https://jgmenu.github.io/integration.html

Define the custom text module for jgmenu in polybar.

```ini
[module/jgmenu]
type = custom/text
content-padding = 2
content = menu
click-left = "jgmenu_run >/dev/null 2>&1 &"
```

--------------------------------

### Add jgmenu to polybar modules

Source: https://jgmenu.github.io/integration.html

Include jgmenu in your bar module configuration.

```ini
[bar/example]
modules-left = jgmenu bspwm i3
```

--------------------------------

### jgmenu_run Pseudo Code

Source: https://jgmenu.github.io/jgmenututorial.7.html

Logic flow for the jgmenu_run wrapper script.

```text
if (jgmenu is already running)
        show menu
else
        start a new instance of jgmenu
```

--------------------------------

### Panel Alignment Visualization

Source: https://jgmenu.github.io/jgmenu.1.html

A visual representation of the coordinate system used for panel alignment.

```text
(X1,Y1)
╔══════════════════════╗
║ panel                ║
╚══════════════════════╝
                 (X2,Y2)
```

--------------------------------

### Add icons to menu items

Source: https://jgmenu.github.io/jgmenututorial.7.html

Include an icon name or full path in the third field of the CSV data to display icons in the menu.

```csv
Browser,        firefox,               firefox
File manager,   pcmanfm,               system-file-manager
Terminal,       xterm,                 utilities-terminal
Lock,           i3lock -c 000000,      system-lock-screen
Exit to prompt, openbox --exit,        system-log-out
Reboot,         systemctl -i reboot,   system-reboot
Poweroff,       systemctl -i poweroff, system-shutdown
```

--------------------------------

### Translation file format

Source: https://jgmenu.github.io/jgmenu-i18n.1.html

The structure of the generated po-style translation file.

```text
msgid "Web Browser"
msgstr ""
```

--------------------------------

### Set csv_cmd in jgmenurc

Source: https://jgmenu.github.io/jgmenututorial.7.html

Specify the default CSV generator in the configuration file.

```ini
csv_cmd = pmenu
```

--------------------------------

### Invoke CSV generators

Source: https://jgmenu.github.io/jgmenututorial.7.html

Run CSV generator commands using jgmenu_run.

```bash
jgmenu_run <command>
```

--------------------------------

### Display Unicode in Terminal

Source: https://jgmenu.github.io/jgmenuunicode.7.html

Use printf to output a specific Unicode character by its hex code point in a terminal.

```bash
printf '%b' '\u1234'
```

--------------------------------

### Specify CSV generator via command line

Source: https://jgmenu.github.io/jgmenututorial.7.html

Override the CSV generator using the --csv-cmd flag.

```bash
jgmenu --csv-cmd="jgmenu_run pmenu"
```
Tokens:
Raw