summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorJan (janneke) Nieuwenhuizen <janneke@gnu.org>2023-03-05 17:38:50 +0100
committerJanneke Nieuwenhuizen <janneke@gnu.org>2023-03-16 14:32:50 +0100
commit193f547ca35eb49ef57bd9a25b67cb3965f10b03 (patch)
tree6bf8fa7915d2b148f50c756627d467afce547b99 /doc
parent2c2f382e757d5eef39e8460a20ac75a1b1f8b22e (diff)
downloadguix-193f547ca35eb49ef57bd9a25b67cb3965f10b03.tar.gz
gnu: home: services: Add home-znc-service-type.
* gnu/home/services/messaging.scm: New file.
* gnu/local.mk (GNU_SYSTEM_MODULES): Add it.
* po/guix/POTFILES.in: Likewise.
* doc/guix.texi (Messaging Home Services): Document it in new subsection.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 8baa2f3224..a823d5f27d 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -41705,6 +41705,7 @@ services)}.
 * Guix: Guix Home Services.     Services for Guix.
 * Fonts: Fonts Home Services.   Services for managing User's fonts.
 * Sound: Sound Home Services.   Dealing with audio.
+* Messaging: Messaging Home Services.   Services for managing messaging.
 @end menu
 @c In addition to that Home Services can provide
 
@@ -42797,6 +42798,42 @@ Stopping the Shepherd service turns off broadcasting.
 This is the multicast address used by default by the two services above.
 @end defvar
 
+@node Messaging Home Services
+@subsection Messaging Home Services
+
+@cindex znc
+The @uref{https://znc.in, ZNC bouncer} can be run as a daemon to manage
+your IRC presence.  With the @code{(gnu home services znc)} service, you
+can configure ZNC to run upon login.
+
+You will have to provide a @file{~/.znc/configs/znc.conf} seperately.
+
+Here is an example of a service and its configuration that you could add
+to the @code{services} field of your @code{home-environment}:
+
+@lisp
+(service home-znc-service-type)
+@end lisp
+
+@defvr {Scheme Variable} home-znc-service-type
+This is the type of the @code{git daemon} home service, whose value is an
+@code{home-znc-configuration} object.
+@end defvr
+
+@deftp {Data Type} home-znc-configuration
+Available @code{home-znc-configuration} fields are:
+
+@table @asis
+@item @code{git} (default: @code{git}) (type: file-like)
+The git package to use.
+
+@item @code{extra-options} (default: @code{'()})
+Extra options will be passed to @command{znc}, please run @command{man
+znc} for more information.
+
+@end table
+@end deftp
+
 @node Invoking guix home
 @section Invoking @command{guix home}