]> git.mdlowis.com Git - proto/labwc.git/commitdiff
Add labwc-menu(5)
authorJohan Malm <jgm323@gmail.com>
Fri, 19 Mar 2021 21:20:54 +0000 (21:20 +0000)
committerJohan Malm <jgm323@gmail.com>
Fri, 19 Mar 2021 21:20:54 +0000 (21:20 +0000)
docs/labwc-menu.5.scd [new file with mode: 0644]
docs/meson.build

diff --git a/docs/labwc-menu.5.scd b/docs/labwc-menu.5.scd
new file mode 100644 (file)
index 0000000..00b9758
--- /dev/null
@@ -0,0 +1,37 @@
+labwc-menu(5)
+
+# NAME
+
+labwc - menu
+
+# DESCRIPTION
+
+Static menus are built based on content of XML files located at
+"~/.config/openbox" and equivalent XDG Base Directories.
+
+# SYNTAX
+
+A menu file must be entirely enclosed within <openbox_menu> and
+</openbox_menu> tags.  Inside these tags, menus are specified as follows:
+
+```
+<menu id="">
+  <item label="">
+    <action></action>
+  </item>
+</menu>
+```
+
+*menu.id*
+       Each menu must be given an id, which is a unique identifier of the menu.
+       This id is used to refer to the menu in a ShowMenu action.
+
+*menu.item.label*
+       The visible name of the menu item.
+
+*menu.item.action*
+       See labwc-action(5)
+
+# SEE ALSO
+
+labwc(1), labwc-action(5), labwc-config(5), labwc-theme(5)
index 5555367e80fa7287049afbb2843fb4728cd3feea..58d12cf3b798df8dc2e96e454d5acb5e2ce89c4a 100644 (file)
@@ -2,7 +2,7 @@ scdoc = find_program('scdoc', required: get_option('man-pages'))
 
 if scdoc.found()
   sh = find_program('sh', native: true)
-  sections = ['.1', '-config.5', '-theme.5', '-actions.5']
+  sections = ['.1', '-config.5', '-theme.5', '-actions.5', '-menu.5']
   foreach s : sections
     markdown = 'labwc' + s + '.scd'
     manpage = 'labwc' + s