diff options
| author | jakob.stendahl <jakob.stendahl@infomedia.dk> | 2024-07-14 10:59:59 +0200 |
|---|---|---|
| committer | jakob.stendahl <jakob.stendahl@infomedia.dk> | 2024-07-14 10:59:59 +0200 |
| commit | 7116bc4e91c209f738ca5276a7e08bc19c3b737c (patch) | |
| tree | 6df99977ad4720605ac93e23459333527fe155a7 /snotifd.1 | |
| parent | 36d8ff00dd1d0f60d0a2afca519de979c67f1dce (diff) | |
| download | simple-notification-daemon-7116bc4e91c209f738ca5276a7e08bc19c3b737c.tar.gz simple-notification-daemon-7116bc4e91c209f738ca5276a7e08bc19c3b737c.zip | |
Add some documentation
Diffstat (limited to 'snotifd.1')
| -rw-r--r-- | snotifd.1 | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/snotifd.1 b/snotifd.1 new file mode 100644 index 0000000..5262bfc --- /dev/null +++ b/snotifd.1 @@ -0,0 +1,50 @@ +.TH SNOTIFD 1 2024-07-14 +.SH name +Simple notification daemon +.SH SYNOPSIS +.B snotifd + +.SH DESCRIPTION +.B snotifd +is a simple daemon meant to run per user, which can receive and store notifications via DBus in memory. +All notifications will be cleared on restart of the daemon. + +It is a quite straight forward program, you start it, and it will be listening to the DBus, +the intended way to interact with it is to use +.BR snotifc (1) +which implements the nesecarry functions to connect via the +.BR snotifd.Notifications +DBus-interface. + +It can be built with +.PP +.nf +.RS +make +.RE +.fi +.PP +after which you can install it to your user with +.PP +.nf +.RS +make +.RE +.fi +.PP +Then you can run +.PP +.nf +.RS +systemctl --user enable --now snotifd +.RE +.fi +.PP +to start it if you are on a systemd-system. +If not, you can start it with ~/bin/snotifd. +.BR snotifc +is installed to ~/bin/snotifc. +Make sure that is in your path to be able to execute it. + +.SH SEE ALSO +snotifc(1) |