Split labwc(5) into {-config, -theme, -actions}

diff --git a/docs/labwc-actions.5.md b/docs/labwc-actions.5.md
new file mode 100644 (file)
index 0000000..d83214e
--- /dev/null
+++ b/docs/labwc-actions.5.md
@@ -0,0 +1,36 @@
+% labwc-actions(5)
+% Johan Malm
+% 31 Aug, 2020
+
+# NAME
+
+labwc - actions
+
+# ACTIONS
+
+Actions are used in key bindings.
+
+Action syntax:
+
+    <action name="NAME">
+      OPTION
+    </action>
+
+where `NAME` is the name of the action as listed below, and `OPTION` is a set
+of tags specific to each action as defined below.
+
+`Execute`
+
+:   Execute command specified by `<command>` option.
+
+`Exit`
+
+:   Exit labwc.
+
+`NextWindow`
+
+:   Cycle focus to next window.
+
+# SEE ALSO
+
+labwc(1), labwc-config(5), labwc-theme(5)

diff --git a/docs/labwc.5.md b/docs/labwc-config.5.md
similarity index 52%
rename from docs/labwc.5.md
rename to docs/labwc-config.5.md
index e2642c40a8e7dc78fad8d644154b4f97800b7600..0a6468377666c774d6c8a68a07c671045dab40a5 100644 (file)
--- a/docs/labwc.5.md
+++ b/docs/labwc-config.5.md
@@ -1,20 +1,18 @@
-% labwc(5)
+% labwc-config(5)
 % Johan Malm
-% 7 Aug, 2020
+% 31 Aug, 2020
 
 # NAME
 
-labwc - Configuration files
+labwc - Configuration
 
 # CONFIGURATION
 
-There are two configuration files which control the look and behaviour of
-labwc, namely rc.xml and themerc. The configuration aims to be compatible with
-Openbox, but there are some differences which are pointed out throughout this
-man page.
+The configuration aims to be compatible with Openbox, but there are some
+differences which are pointed out throughout the man pages.
 
-Adhering to XDG Base Directory Specification, configuration files will be
-searched for in the following order:
+Adhering to XDG Base Directory Specification, configuration files will
+be searched for in the following order:
 
 - `${XDG_CONFIG_HOME:-$HOME/.config}/labwc`  
 - `${XDG_CONFIG_DIRS:-/etc/xdg}/labwc`  
@@ -109,72 +107,6 @@ If no rc.xml file is found, the following default values will be used:
 - Alt+Tab: Cycle windows  
 - Alt+F3: Launch dmenu  
 
-# ACTIONS
-
-Actions are used in key bindings.
-
-Action syntax:
-
-    <action name="NAME">
-      OPTION
-    </action>
-
-where `NAME` is the name of the action as listed below, and `OPTION` is a set
-of tags specific to each action as defined below.
-
-`Execute`
-
-:   Execute command specified by `<command>` option.
-
-`Exit`
-
-:   Exit labwc.
-
-`NextWindow`
-
-:   Cycle focus to next window.
-
-# THEMERC
-
-The theme engine aims to be compatible with openbox and themes will be
-searched for in the following order:
-
-- `${XDG_DATA_HOME:-$HOME/.local/share}/themes/<theme-name>/openbox-3/`  
-- `$HOME/.themes/<theme-name>/openbox-3/`  
-- `/usr/share/themes/<theme-name>/openbox-3/`  
-- `/usr/local/share/themes/<theme-name>/openbox-3/`  
-- `/opt/share/themes/<theme-name>/openbox-3/`  
-
-`window.active.title.bg.color`
-
-:   Background for the focussed window's titlebar
-
-`window.active.handle.bg.color`
-
-:   Background for the focussed window's handle.
-
-`window.inactive.title.bg.color`
-
-:   Background for non-focussed windows' titlebars
-
-# DEFINITIONS
-
-The `handle` is the window decoration placed on the bottom of the window.
-
-# EXAMPLES
-
-## Example 1 - title bar configuration
-
-    +-----------------------------------------+ ^
-    |                                         | |
-    |                                         | |
-    |                                         | | h
-    |                                         | |
-    +-----------------------------------------+ v
-
-    h = padding * 2 + font-vertical-extents
-
-
 # SEE ALSO
 
-labwc(1)
+labwc(1), labwc-actions(5), labwc-theme(5)

diff --git a/docs/labwc-theme.5.md b/docs/labwc-theme.5.md
new file mode 100644 (file)
index 0000000..e32ae95
--- /dev/null
+++ b/docs/labwc-theme.5.md
@@ -0,0 +1,68 @@
+% labwc-theme(5)
+% Johan Malm
+% 31 Aug, 2020
+
+# NAME
+
+labwc - Theme specification
+
+# THEME
+
+The theme engine aims to be compatible with openbox and themes will be
+searched for in the following order:
+
+- `${XDG_DATA_HOME:-$HOME/.local/share}/themes/<theme-name>/openbox-3/`  
+- `$HOME/.themes/<theme-name>/openbox-3/`  
+- `/usr/share/themes/<theme-name>/openbox-3/`  
+- `/usr/local/share/themes/<theme-name>/openbox-3/`  
+- `/opt/share/themes/<theme-name>/openbox-3/`  
+
+Choosing a theme is done by editing the `<name>` key in the `<theme>`
+section of your rc.xml (labwc-config(5)).
+
+A theme consists of a themerc file and optionally some xbm icons.
+
+# DATA TYPES
+
+## Color RGB values
+
+Colors can be specified by hexadecimal RGB values in the `#rrggbb`.
+Other formats will be supported later for better openbox theme
+compatibility.
+
+# THEME ELEMENTS
+
+`window.active.title.bg.color`
+
+:   Background for the focussed window's titlebar
+
+`window.active.handle.bg.color`
+
+:   Background for the focussed window's handle.
+
+`window.inactive.title.bg.color`
+
+:   Background for non-focussed windows' titlebars
+
+`window.active.button.unpressed.image.color`
+
+:   Color of the images in titlebar buttons in their default, unpressed,
+    state. This element is for the focused window.
+
+`window.inactive.button.unpressed.image.color`
+
+:   Color of the images in titlebar buttons in their default, unpressed,
+    state. This element is for non-focused windows.
+
+# DEFINITIONS
+
+The `handle` is the window decoration placed on the bottom of the window.
+
+# DERIVED DIMENSIONS
+
+The window title bar height is equal to the vertical font extents of the title.
+Padding will be added to this later.
+
+# SEE ALSO
+
+labwc(1), labwc-config(5), labwc-actions(5)

diff --git a/docs/meson.build b/docs/meson.build
index bee15c9bfd62d5f0d213085ea34fcae8ecfaf859..55ba7c8326f375e226b2a96817c98a4c3cab9484 100644 (file)
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -1,11 +1,11 @@
 pandoc = find_program('pandoc', required: false)
 
-sections = ['1', '5']
+sections = ['.1', '-config.5', '-theme.5', '-actions.5']
 
 if pandoc.found()
   foreach s : sections
-    markdown = files('labwc.' + s + '.md')
-    manpage = 'labwc.' + s
+    markdown = files('labwc' + s + '.md')
+    manpage = 'labwc' + s
     custom_target(
       manpage,
       command: [pandoc,'-s','-t','man',markdown],