From b43d5820318bcbf5c515c282a70c20484818b7e0 Mon Sep 17 00:00:00 2001 From: Leon Henrik Plickat Date: Fri, 25 Sep 2020 15:14:30 +0200 Subject: Write man page --- doc/wlclock.1.scd | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) (limited to 'doc/wlclock.1.scd') diff --git a/doc/wlclock.1.scd b/doc/wlclock.1.scd index 4c0a6f6..a6c5e42 100644 --- a/doc/wlclock.1.scd +++ b/doc/wlclock.1.scd @@ -5,7 +5,92 @@ wlclock - A digital analog clock for Wayland # DESCRIPTION +wlclock displays an analog clock on Wayland desktops. + +A Wayland compositor must implement the Layer-Shell and XDG-Output for wlclock +to work. + +wlclock is heavily inspired by xclock(1) and the default configuration has been +chosen to mimic xclock. However unlike xclock, wlclock is not a regular window +but a desktop-widget. + +# OPTIONS +*-h*, *--help* + Display help message and exit. + +*-V*, *--version* + Display version and exit. + +*-v*, *--verbose* + Increase verbosity of logging. + +*--anchor* + Set the directional anchors of the layer surface. Requires 4 arguments, + each being a boolean "true" or "false". By default all anchors are "false". + +*--background-colour* + The background colour of the clock. The default is "#FFFFFF". + +*--border-colour* + The border colour of the clock. The default is "#000000". + +*--border-size* , *--border-size* + Set the border size. Requires either one argument, to set all border sizes, + or four arguments, to set the border sizes individually. The default border + size is 1. + +*--clock-colour* + The colour of clock elements. The default is "#000000". + +*--clock-face-size* + The size of the minute markers on the clock face. The default is 1. + +*--exclusive-zone* + Exclusive zone of the surface. Can be "true", "false" or "stationary". If + "true", the compositor is informed that it should not obstruct the surface + of wlclock with other surfaces. If "false", the compositor is informed that + it can place other surfaces over or under the surface of wlclock. If + "stationary", the compositor is informed that the surface of wlclock should + not be moved to accommodate other layer shell surfaces and that it can + freely place other surfaces over or under the surface of wlclock. The + default is "stationary". The exact implementation is compositor dependant; + A compositor may choose to ignore the requested exclusive zone of surfaces. + +*--layer* + Layer of the layer surface. Can be "overlay", "top", "bottom" or + "background". Typically, "bottom" and "background" will be underneath + regular windows, while "top" and "overlay" will be above them, however + the exact placement on the z axis depends on the implementation of the + compositor. The default layer is "overlay". + +*--margin* , *--margin* + Set the margin. Requires either one argument, to set all margins, or four + arguments, to set the margins individually. The default margin is 0. + +*--namespace* + The namespace of the layers surface. Some compositors may treat layer + surfaces differently based on their namespace. The default is "wlclock". + +*--no-input* + If this flag is provided, wlclock will ask the compositor to not send it + input events; This will make mouse events pass through wlclock to windows + beneath it. + +*--output* + Name of the output on which wlclock should be displayed. Output names + are compositor dependant. If set to "all" or "\*", wlclock will be displayed + on all outputs, which is the default behaviour. + +*--corner-radius* , *--corner-radius* + The radius of the corners. Expects either one argument, to set the radius of + all corners, or four arguments, to set the individual corner radii. The + default radius is 5. If set to sufficiently high values, wlclock will be + completely round. Set to 0 to disable corner roundness. + +*--size* + The size of the clock, without borders. The default size is 165. # AUTHORS Leon Henrik Plickat + -- cgit v1.2.3