File: root_menu.md

package info (click to toggle)
wlmaker 0.7.1-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 7,696 kB
  • sloc: ansic: 58,587; xml: 1,424; python: 1,400; cpp: 253; yacc: 118; sh: 73; lex: 70; makefile: 8
file content (40 lines) | stat: -rw-r--r-- 1,391 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Root Menu {#root_menu}

# Root Menu configuration file {#root_menu_file}

wlmaker displays a root menu when right-clicking on an unoccupied area of the
workspace, or when pressing the configured hotkey for the `RootMenu` action.

It uses a built-in onfiguration (see @ref etc_root_menu_plist), but can be
overriden by setting the `--root_menu_file` argument (see @ref commandline).

The root menu file must define a Plist array. The first element of the array
specifies the menu's title, and further elements will either define a menu
item, or a command to include a further plist file, or to invoke a shell
command to generate a plist menu output.

## Example: A menu with two items

@include tests/data/menu.plist

## Example: A menu including another file

@include tests/data/menu-include.plist

## Example: A menu invoking a shell command to generate the menu

@include tests/data/menu-generate.plist

## Automatic Generation

Wayland Maker provides the `wlmtool` utility for generating a Plist menu
specification from the applications found in the host's XDG application
repository.

This can be used to define a menu item with a submenu, or to directly define
the toplevel root window.

Example usage:
@snippet{trimleft} etc/RootMenuDebian.plist wlmtool

Alternatively, the [`wmmenugen`](https://www.windowmaker.org/docs/manpages/wmmenugen.html) tool from Window Maker can be used.