From 5a36fef547fc3f6b14117bc430e94cb93a153098 Mon Sep 17 00:00:00 2001 From: Johan Malm Date: Fri, 5 Mar 2021 22:14:02 +0000 Subject: [PATCH] Convert man pages from md to scd --- docs/labwc-actions.5.md | 44 ---------------- docs/labwc-actions.5.scd | 28 +++++++++++ docs/labwc-config.5.md | 106 --------------------------------------- docs/labwc-config.5.scd | 73 +++++++++++++++++++++++++++ docs/labwc-theme.5.md | 84 ------------------------------- docs/labwc-theme.5.scd | 72 ++++++++++++++++++++++++++ docs/labwc.1.md | 58 --------------------- docs/labwc.1.scd | 64 +++++++++++++++++++++++ docs/meson.build | 13 ++--- 9 files changed, 244 insertions(+), 298 deletions(-) delete mode 100644 docs/labwc-actions.5.md create mode 100644 docs/labwc-actions.5.scd delete mode 100644 docs/labwc-config.5.md create mode 100644 docs/labwc-config.5.scd delete mode 100644 docs/labwc-theme.5.md create mode 100644 docs/labwc-theme.5.scd delete mode 100644 docs/labwc.1.md create mode 100644 docs/labwc.1.scd diff --git a/docs/labwc-actions.5.md b/docs/labwc-actions.5.md deleted file mode 100644 index 5c3d792d..00000000 --- a/docs/labwc-actions.5.md +++ /dev/null @@ -1,44 +0,0 @@ -% labwc-actions(5) -% Johan Malm -% 31 Oct, 2020 - -# NAME - -labwc - actions - -# ACTIONS - -Actions are used in key bindings. - -Action syntax: - - - OPTION - - -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 `` option. - -`Exit` - -: Exit labwc. - -`NextWindow` - -: Cycle focus to next window. - -`Reconfigure` - -: Re-load configuration and theme files - -`ShowMenu` - -: Show menu specified by `` option. Valid menu is "root-menu" - -# SEE ALSO - -labwc(1), labwc-config(5), labwc-theme(5) diff --git a/docs/labwc-actions.5.scd b/docs/labwc-actions.5.scd new file mode 100644 index 00000000..3f04379a --- /dev/null +++ b/docs/labwc-actions.5.scd @@ -0,0 +1,28 @@ +labwc-actions(5) + +# NAME + +labwc - actions + +# ACTIONS + +Actions are used in keyboard bindings. + +** + Execute command. + +** + Exit labwc. + +** + Cycle focus to next window. + +** + Re-load configuration and theme files. + +** + Show menu. Valid menu name is "root-menu". + +# SEE ALSO + +labwc(1), labwc-config(5), labwc-theme(5) diff --git a/docs/labwc-config.5.md b/docs/labwc-config.5.md deleted file mode 100644 index 91e74641..00000000 --- a/docs/labwc-config.5.md +++ /dev/null @@ -1,106 +0,0 @@ -% labwc-config(5) -% Johan Malm -% 8 Oct, 2020 - -# NAME - -labwc - Configuration - -# CONFIGURATION - -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: - -- `${XDG_CONFIG_HOME:-$HOME/.config}/labwc` -- `${XDG_CONFIG_DIRS:-/etc/xdg}/labwc` - -# RC.XML `` - -Labwc specific settings which are not present in Openbox. - - - - - -`xdg_shell_server_side_deco` (__boolean__; default yes) - -: Use server-side decorations for xdg-shell views where it is possible to - turn of CSD - -# RC.XML `` - - - - - - - - - -`name` (__string__; default Clearlooks) - -: The name of the Openbox theme to use - -`font` - -: The font to use for a specific element of a window, menu or OSD. - - `place` - - : Can be `ActiveWindow` (titlebar of active window) - - `name` - - : Describes font name (__string__; default sans) - - `size` - - : Describes font size in pixels (__integer__; default 8) - -# RC.XML `` - -Describe key bindings. - - - - ACTION - - - -`KEY-COMBINATION` - -: The key combination to bind to an **ACTION** in the format - **modifier-key**, where supported **modifiers** include S (shift); - C (control); A (alt); W (super). Unlike Openbox, multiple space-separated - **KEY-COMBINATION** and key-chains are not supported. - -Example: - - - - - - - - - - - bemenu-run - - - - -Default: - -If no rc.xml file is found, the following default values will be used: - -- Alt+Escape: Exit labwc -- Alt+Tab: Cycle windows -- Alt+F3: Launch bemenu - -# SEE ALSO - -labwc(1), labwc-actions(5), labwc-theme(5) diff --git a/docs/labwc-config.5.scd b/docs/labwc-config.5.scd new file mode 100644 index 00000000..72060973 --- /dev/null +++ b/docs/labwc-config.5.scd @@ -0,0 +1,73 @@ +labwc-config(5) + +# NAME + +labwc - Configuration + +# CONFIGURATION + +The configuration aims to be compatible with openbox specification, 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: + +- ${XDG_CONFIG_HOME:-$HOME/.config}/labwc +- ${XDG_CONFIG_DIRS:-/etc/xdg}/labwc + +# GENERAL + +This section contains settings which are not present in Openbox. + +** [yes|no] + Use server side decorations for xdg-shell views where it is possible to + turn off client side decorations. Default is yes. + +# THEME + +** + The name of the Openbox theme to use. Default is Clearlooks-3.4 + +** + The font to use for a specific element of a window, menu or OSD. + Place can be any of: + - ActiveWindow - titlebar of active window + +** + Describes font name. Default is sans. + +** + Font size in pixels. Default is 8. + +# KEYBOARD + +** + Define a key binding in the format *modifier-key*, where supported + modifiers include S (shift); C (control); A (alt); W (super). Unlike + Openbox, multiple space-separated key combinations and key-chains are + not supported. + +** + Keybind action. See labwc-action(5) + +Default if no rc.xml is found: + +``` + + + + + + + + + + bemenu-run + + + +``` + +# SEE ALSO + +labwc(1), labwc-actions(5), labwc-theme(5) diff --git a/docs/labwc-theme.5.md b/docs/labwc-theme.5.md deleted file mode 100644 index a7db572e..00000000 --- a/docs/labwc-theme.5.md +++ /dev/null @@ -1,84 +0,0 @@ -% 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//openbox-3/` -- `$HOME/.themes//openbox-3/` -- `/usr/share/themes//openbox-3/` -- `/usr/local/share/themes//openbox-3/` -- `/opt/share/themes//openbox-3/` - -Choosing a theme is done by editing the `` key in the `` -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. - -`menu.items.bg.color` - -: Background color of inactive menu items - -`menu.items.text.color` - -: Text color of inactive menu item - -`menu.items.active.bg.color` - -: Background color of active menu items - -`menu.items.active.text.color` - -: Text color of active menu item - -# 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/labwc-theme.5.scd b/docs/labwc-theme.5.scd new file mode 100644 index 00000000..864d6929 --- /dev/null +++ b/docs/labwc-theme.5.scd @@ -0,0 +1,72 @@ +labwc-theme(5) + +# 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//openbox-3/ +- $HOME/.themes//openbox-3/ +- /usr/share/themes//openbox-3/ +- /usr/local/share/themes//openbox-3/ +- /opt/share/themes//openbox-3/ + +Choosing a theme is done by editing the key in the section of +the rc.xml configuration file (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 format #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. + +*menu.items.bg.color* + Background color of inactive menu items + +*menu.items.text.color* + Text color of inactive menu item + +*menu.items.active.bg.color* + Background color of active menu items + +*menu.items.active.text.color* + Text color of active menu item + +# DEFINITIONS + +The handle is the window edge decoration at 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/labwc.1.md b/docs/labwc.1.md deleted file mode 100644 index 9f89d23e..00000000 --- a/docs/labwc.1.md +++ /dev/null @@ -1,58 +0,0 @@ -% labwc(1) -% Johan Malm -% 8 Oct, 2020 - -# NAME - -labwc - A Wayland stacking compositor with the look and feel of Openbox - -# SYNOPSIS - -labwc \[\-c <*config-file*>] \[\-h] \[\-s <*startup-command*>] [-v] - -# DESCRIPTION - -Labwc is a [WIP] free, stacking compositor for Wayland. It aims to be light-weight and have the feel of Openbox. - -# OPTIONS - -`-c ` - -: Specify path to rc.xml - -`-h` - -: Show help message - -`-s ` - -: Specify startup command - -`-v` - -: Increase verbosity. '-v' for info; '-vv' for debug. - -# CONFIGURATION AND THEMES - -Labwc aims to be compatible with openbox configuration and theming, with the -following files controlling the look and behaviour: - -- ~/.config/labwc/rc.xml (see labwc-config(5) for details) -- ~/.config/labwc/autostart -- ~/.config/labwc/environment -- ~/.themes/``/openbox-3/themerc (see labwc-theme(5) for details) - -Equivalent XDG Base Directory Specification locations are also honoured. - -The configuration file and theme are re-loaded on receiving signal SIGHUP. - -The autostart file is executed as a shell script. This is a place for setting -a background image, launching a panel, and so on. - -The environment file is parsed as `=` and sets environment -variables accordingly. It is recommended to specify keyboard settings here, -for example: `XKB_DEFAULT_LAYOUT=gb`. See xkeyboard-config(7) for details. - -# SEE ALSO - -labwc-config(5), labwc-theme(5), labwc-actions(5) diff --git a/docs/labwc.1.scd b/docs/labwc.1.scd new file mode 100644 index 00000000..e8c12176 --- /dev/null +++ b/docs/labwc.1.scd @@ -0,0 +1,64 @@ +labwc(1) + +# NAME + +labwc - A Wayland stacking compositor + +# SYNOPSIS + +*labwc*  [options...] [command] + +# DESCRIPTION + +Labwc is a stacking compositor for Wayland. It aims to be light-weight and have +the feel of Openbox albeit with a smaller feature set. Where practicable, it +uses clients to show wall-paper, take screenshots, and so on. It tries to stay +in keeping with wlroots and sway in terms of approach and coding style. + +# OPTIONS + +*-c* + Specify a config file + +*-d* + Enable full logging, including debug information + +*-h* + Show help message and quit + +*-s* + Run command on startup + +*-v* + Show the version number and quit + +*-V* + Enable more verbose logging + +# CONFIGURATION AND THEMING + +Labwc uses openbox specification for configuration and theming, but does not +support all options. The the following files control the look and behaviour: + +- ~/.config/labwc/rc.xml +- ~/.config/labwc/menu.xml +- ~/.config/labwc/autostart +- ~/.config/labwc/environment +- ~/.themes//openbox-3/themerc + +Equivalent XDG Base Directory Specification locations are also honoured. + +The configuration file and theme are re-loaded on receiving signal SIGHUP. + +The autostart file is executed as a shell script. This is a place for setting a +background image, launching a panel, or similar. + +The environment file is parsed as = and sets environment +variables accordingly. It is recommended to specify keyboard settings here, for +example: `XKB_DEFAULT_LAYOUT=gb`. See xkeyboard-config(7) for details. Note +that the environment file is treated differently by openbox where it is simply +sourced prior to running openbox. + +# SEE ALSO + +labwc-config(5), labwc-theme(5), labwc-actions(5) diff --git a/docs/meson.build b/docs/meson.build index e506ee56..5555367e 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -1,14 +1,15 @@ -pandoc = find_program('pandoc', required: get_option('man-pages')) +scdoc = find_program('scdoc', required: get_option('man-pages')) -sections = ['.1', '-config.5', '-theme.5', '-actions.5'] - -if pandoc.found() +if scdoc.found() + sh = find_program('sh', native: true) + sections = ['.1', '-config.5', '-theme.5', '-actions.5'] foreach s : sections - markdown = files('labwc' + s + '.md') + markdown = 'labwc' + s + '.scd' manpage = 'labwc' + s custom_target( manpage, - command: [pandoc,'-s','-t','man',markdown], + input: markdown, + command: [sh, '-c', 'scdoc < @INPUT@'], output: manpage, capture: true, install: true, -- 2.52.0