sxalert

commit 6c3bab8b89bccf5956520952723f960304f631c4
parent be887e146756620b04b9be219049e41dd3c5cbda
Author: Michael Constantine Dimopoulos <mk@mcdim.xyz>
Date:   Sat, 11 Nov 2023 00:25:01 +0000

Updated documentation

Diffstat:
M
README.md
 | 
3
+++
A
sxalert.1
 | 
43
+++++++++++++++++++++++++++++++++++++++++++

2 files changed, 46 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -40,5 +40,8 @@ These will overwrite the defaults defined in `config.h`
 + Create a manpage
 + Exit by event (perhaps as a patch)
 
+## Optional D-Bus daemon hack
+I've created a small Shell script called [sxalertd](https://github.com/MichaelDim02/sxalertd) that can run as a daemon to read the D-Bus and use sxalert to draw the notifications. The script & parsing method are a little hacky but work quite well.
+
 ## Credit
 The logo is the Alectryon! The rooster image is by Leys, Thomson W. from the 1883 book "Brett's colonists' guide and cyclopaedia" for New Zealand settlers. The font is Byzantine, and the logo was created in GIMP.
diff --git a/sxalert.1 b/sxalert.1
@@ -0,0 +1,43 @@
+.\" Manpage for sxalert
+
+.TH man 8 "11 Nov 2023" "0.1" "sxalert manual page"
+.SH NAME
+sxalert \- Simple X Alert
+.SH SYNOPSIS
+sxalert [OPTIONS] "First line" "Second line" "Third line"
+.SH DESCRIPTION
+sxalert will draw text as a notification for X
+
+.SH OPTIONS
+
+-t text color in hex
+
+-g background color in hex
+
+-r border color in hex
+
+-b border width in pixels
+
+-d duration in milliseconds
+
+-h print help panel & exit
+
+-v print version & exit
+
+.SH EXAMPLES
+
+This will print the string "Updates available":
+
+sxalert "Updates avalailable"
+
+The following will also print "Updates available" but will specify text color to be red, background to be black and border width to be 0:
+
+sxlaert -t 0xff0000 -g 0x000000 -b 0 "Updates available"
+
+.SH AUTHOR
+Michael Constantine Dimopoulos <mk@mcdim.xyz>
+
+https://mcdim.xyz
+
+.SH LICENSE
+GNU General Public License 3.0 (GPL-3.0)