Library used to read freedesktop.org menus
C M4 Vala Other
Latest commit 5e50156 Nov 6, 2016 @LStranger LStranger Release 1.0.2.
Permalink
Failed to load latest commit information.
docs
libmenu-cache
menu-cache-daemon
menu-cache-gen
vapi
.gitignore
AUTHORS
COPYING
ChangeLog
INSTALL
Makefile.am
NEWS
README
autogen.sh
configure.ac

README

Libmenu-cache is a library creating and utilizing caches to speed up
the manipulation for freedesktop.org defined application menus.
It can be used as a replacement of libgnome-menu of gnome-menus.

Advantages:
1. Shorten time for loading menu entries.
2. Ease of use. (API is very similar to that of libgnome-menu)
3. Lightweight runtime library. (Parsing of the menu definition files 
   are done by menu-cache-gen when the menus are really changed.)
4. Less unnecessary and complicated file monitoring.
5. Heavily reduced disk I/O.

Installing:

Since version 0.7.0 the Libmenu-cache requires Libfm-extra for the
menu-cache-gen menu cache generation binary. Since Libfm depends on
Libmenu-cache, there is some hint for bootstrapers how to build those
libraries together: you need create Libfm-extra first, you can easily
do this by passing '--with-extra-only' option to configure script and
installing Libfm-extra. Then you can succesfully build Libmenu-cache
and therefore build full version of Libfm.

Diagnostics:

Libmenu-cache uses cache generation in "fail-proof" mode when it will
ignore improper tags in XML menu file but fail only if that menu file
doesn't exist at all, or has invalid XML structure, or has no root menu
with name 'Applications'. If you want to explore how it is generated
then you can start menu-cache-gen manually in verbose mode, for example:

G_MESSAGES_DEBUG=all \
  /usr/lib/menu-cache/menu-cache-gen -v -i applications.menu -o /dev/null

so you can see all the processing of your XML file and it will fail on
any broken tag or at least show you a warning and you can inspect that
log.

Spec:

Cached menus are localized and stored in ~/.cache/menus/file_name.
file_name is a md5 hash of the name of the original menu +
                                       some environment variable +
                                       locale name.

Since most data in a menu are plain text (names, description comments,
icon names,...etc.), the cached file is in plain text rather than binary
to prevent byte order problems.

Format of the cached menu file, line by line.
(Spaces before the lines are for easier demostration of hierarchy.
 There are no spaces in the real cached file.
 Fields marked with [**] added only in the file format 1.2):

version number (major.minor)
menu name>
number of files to monitor
list of files/dirs which require monitor (prefix D or F indicate whether it
                                          is a dir or file)
list of DE names used in this menu other than the known DEs (LXDE, GNOME,
                                                             XFCE, KDE, ROX),
seperated by ;
+id of top menu dir (+ means dir entry, and - means an application entry)
  title
  comment
  icon name
  menu directory file basename
  dir in which menu directory file locates (use this number as index to get
                                            the string from array of preceding
                                            list of monitored files)
  [**] bitmask flags: (--)|(--)|(not displayed)
    -application desktop id (NOTE: desktop id is not necessarily the basename
                             of desktop file)
     title
     comment
     icon name
     app desktop file basename, empty means the same as desktop id.
     dir in which the desktop file localtes (use this number as index to get
                                             the string from array of
                                             preceding list of monitored files)
     generic name
     exec command line
     bitmask flags: (use terminal)|(use startup notification)|(not displayed)
     show_in_flags: bitwise or of masks for various DEs.
     [**] executable name to test for availability
     [**] working dir for exec
     [**] categories: list divided by semicolon
     [**] keywords: list divided by comma
    +sub dir id
     title
     comment
     icon name
     ...