Jump to content

# xdg-menu

4 languages

- Español
- 日本語
- Русский
- 中文（简体）

From ArchWiki

xdg-menu is a tool that generates XDG Desktop Menus for the following window managers:

- awesome
- Blackbox
- Fluxbox
- FVWM2
- IceWM
- Openbox
- twm
- Window Maker

KDE, GNOME, Xfce and Enlightenment are already XDG compatible.

## Installation

Install the archlinux-xdg-menu package.

## Menu hierarchy

- Applications
  - Accessibility
  - Accessories
  - Development
  - Education
  - Games
  - Graphics
  - Internet
  - Multimedia
  - Office
  - Other
  - Science
  - System

## Configuration

xdg_menu relies on three sets of information to generate menus: a root menu or in other words an XML menu template generally passed on the command line, information cached when it was last run, and a series of configuration files.

- You can find some XML menu templates in `/etc/xdg/menus`.
- If altering the code in xdg_menu to change layout, make sure you delete everything in `~/.xdg_menu_cache` or you will spend hours trying to figure out why your changes to the perl script do not take.
- You can find individual application configurations in `/usr/share/applications`.

Other configuration file directories can be found under `/usr/share`. In most cases you will not need to touch these. However if you want to change how your menu is layed out you can alter the menu template for minor changes. Major changes require tweaking the actual xdg_menu perl script. If you find that applications do not appear or that they are called strange things, then you will need to look at the .desktop file in `/usr/share/applications`. Check the desktop entry specification.

### Adding desktop entries from other directories

By default, the Xdg-menu will be populated with applications which install their desktop entries to `/usr/share/applications`. To add applications to the menu which install their desktop entry to a user folder such as `~/.local/share/applications`, edit the `/etc/xdg/menus/arch-applications.menu` file and add an `<AppDir>` tag for the relevant directory, see below:

    /etc/xdg/menus/arch-applications.menu

    <Menu>

      <Name>Applications</Name>
      <Directory>Arch-Applications.directory</Directory>
      <DefaultAppDirs/>
      <AppDir>/home/username/.local/share/applications</AppDir>
      <DefaultDirectoryDirs/>
      <DefaultMergeDirs/>
      ...

## Usage

### xdg_menu

    xdg_menu [--format <format>] [--desktop <desktop>]
             [--charset <charset>] [--language <language>]
    	 [--root-menu <root-menu>] [--die-on-error]
    	 [--fullmenu] [--help]

    	format - output format
    	         possible formats: twm, WindowMaker, fvwm2, icewm, ion3
    	                           blackbox, fluxbox, openbox,
    				   xfce4, openbox3, openbox3-pipe, awesome
    				   readable
    		 default: WindowMaker

     	fullmenu  - output a full menu and not only a submenu

    	desktop - desktop name for NotShowIn and OnlyShowIn
    		 default: the same as format

    	charset - output charset
    		 default: <locale>

    	language - output language
    		 default: <locale>

    	root-menu - location of root menu file
    		 default: /opt/gnome/etc/xdg/menus/applications.menu

    	die-on-error - abort execution on any error,
    		 default: try to continue

    	verbose - print debugging information

    	help - print this text

### update-menus

update-menus updates WM's menus from XDG data and can be configured to do it automaticaly.

This is a script wrapper around xdg_menu that relies on `/etc/update-menus.conf`

To use it, you need to install the archlinux-xdg-menu package (xdg_menu)

In `/etc/update-menus.conf`, you have to select from a list of window managers for which the menu should be generated. Comments with # are allowed.

All generated menus are placed in `/var/cache/xdg-menu/`. See wm-specific #Examples section of this page to get more information.

## Examples

### Awesome

#### With xdg_menu

    $ xdg_menu --format awesome --root-menu /etc/xdg/menus/arch-applications.menu > ~/.config/awesome/archmenu.lua

Then, edit your `rc.lua` as shown below.

- Add a require statment for your new `menu.lua` file.
- Add an entry to your `awful.menu` object for your new menu which calls `xdg-menu`.

    ...
    xdg_menu = require("archmenu")
    ...

    ...
    mymainmenu = awful.menu({ items = { { "awesome", myawesomemenu, beautiful.awesome_icon },
                                        { "Applications", xdgmenu },
                                        { "open terminal", terminal }
                                      }
                            })
    ...

### IceWM

#### With xdg_menu

    $ xdg_menu --format icewm --fullmenu --root-menu /etc/xdg/menus/arch-applications.menu >> ~/.icewm/programs

#### With update-menus

- Uncomment icewm in `/etc/update-menus.conf`.
- Run `update-menus` as root.
- Make a symlink to `/var/cache/xdg-menu/icewm/programs` in `~/.icewm/programs`.

### FluxBox

#### With xdg_menu

    $ xdg_menu --format fluxbox --root-menu /etc/xdg/menus/arch-applications.menu > ~/.fluxbox/my-menu

Change your menu file to include the generated menu.

For example, add this line:

    [include] (my-menu)

#### With update-menus

- Uncomment fluxbox in `/etc/update-menus.conf`.
- Run `update-menus` as root.
- Change your menu file to include generated menu.

For example, add this line:

    [include] (/var/cache/xdg-menu/fluxbox/boxrc)

### OpenBox

#### With xdg_menu

Generate menu with:

    $ xdg_menu --format openbox3 --root-menu /etc/xdg/menus/arch-applications.menu > xdg-menu.xml

And manually add it into your `menu.xml`. For example, put `xdg-menu.xml` into `menu.xml` and add:

    <menu id="Applications" />

Into `root-menu`.

#### As a pipe menu

Using xdg_open as a pipe menu gives you the added benefit of having a menu that automatically updates when you install new applications.

Add the following somewhere inside your menu.xml between your root menu tags:

    <menu id="applications" label="Applications" execute="xdg_menu --format openbox3-pipe --root-menu /etc/xdg/menus/arch-applications.menu" />

A very basic example:

    <?xml version="1.0" encoding="UTF-8"?>

    <openbox_menu xmlns="http://openbox.org/3.4/menu">

    <menu id="root-menu" label="Openbox 3">
      <menu id="applications" label="Applications" execute="xdg_menu --format openbox3-pipe --root-menu /etc/xdg/menus/arch-applications.menu" />
      <separator />
      <item label="Log Out">
        <action name="Exit">
          <prompt>yes</prompt>
        </action>
      </item>
    </menu>

    </openbox_menu>

#### With update-menus

- Uncomment openbox in `/etc/update-menus.conf`.
- Run `update-menus` as root.
- Change your `menu.xml` file to include generated menu.

For example, add following to root-menu:

    <menu id="xdg-menu" label="XDG Menu" execute="cat /var/cache/xdg-menu/openbox/menu.xml"/>

### Twm

#### With xdg_menu

Use:

    $ xdg_menu --format twm --root-menu /etc/xdg/menus/arch-applications.menu >my-twm-menu

And add it into twmrc manually. In the case of twm derivatives with m4 preprocessing such as vtwm or ctwm it can be included by adding:

    sinclude(`/PATH/TO/my-twm-menu')

To `*twmrc`.

#### With update-menus

- Uncomment twm in `/etc/update-menus.conf`.
- Add in `/etc/X11/twm/system.twmrc` a file applications menu (add it into `defops menu`):

     "apps"          f.menu "Applications"

- Run `update-menus` as root.
- Run `twm -f /var/cache/xdg-menu/twm/twmrc`.

Tip: You will also want to add your other customizations to `/etc/X11/twm/system.twmrc`.

### WindowMaker

#### With xdg_menu

Use:

    $ xdg_menu --format WindowMaker --root-menu /etc/xdg/menus/arch-applications.menu >my-wm-menu

And add:

    #include "my-wm-menu"

Into your WindowMaker menu file.

You can also use the WPrefs "Application Menu Definitions", and add the xdg command as a parameter in a "Generated Submenu" object.

#### With update-menus

- Uncomment WindowMaker in `/etc/update-menus.conf`.
- Run `update-menus` as root.
- Add:

    #include "/var/cache/xdg-menu/WindowMaker/wmrc"

Into your menu file.

### Fvwm2

#### With xdg_menu

Generate the menu:

    $ xdg_menu --format fvwm2 --root-menu /etc/xdg/menus/arch-applications.menu >fvwm2-menu

And add it into the root menu:

    read fvwm2-menu

    AddToMenu MenuFvwmRoot  "Root Menu"             Title
    +                       "&0. XDG Menu"          Popup xdg_menu

#### With update-menus

- Uncomment fvwm2 in `/etc/update-menus.conf`.
- Run `update-menus` as root.
- Change your `.fvwm2rc` file to include generated menu. For example:

    AddToMenu MenuFvwmRoot  "Root Menu"             Title
    +                       "&0. XDG Menu"          Popup xdg_menu

    read /var/cache/xdg-menu/fvwm2/fvwm2rc

### BlackBox

#### With xdg_menu

    $ xdg_menu --format blackbox  --root-menu /etc/xdg/menus/arch-applications.menu >my-menu

Change your menu file to include the generated menu.

For example, add this line:

    [include] (my-menu)

#### With update-menus

- Uncomment blackbox in `/etc/update-menus.conf`.
- Run `update-menus` as root.
- Change your menu file to include the generated menu.

For example, add this line:

    [include] (/var/cache/xdg-menu/blackbox/boxrc)

## See also

- Sawfish#Menus
- https://github.com/gapan/xdgmenumaker

Category:

- Freedesktop.org