doc: Add documentation for cachefilesd-service.series-3908

* doc/guix.texi (Linux Services): Add a new subsection and document the
cachefilesd service and its configuration.

1 files changed, 35 insertions, 0 deletions

diff --git a/doc/guix.texi b/doc/guix.texi
index 0cba0ee1ec..4aaec43739 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -25724,6 +25724,41 @@ parameters, can be done as follow:
 @end lisp
 @end deffn
 
+@cindex cachefilesd
+@cindex cachefiles
+@cindex fscache
+@subsubheading cachefilesd Service
+
+The cachefilesd service allows one to load start @code{cachefilesd} for
+caching network filesystem data on local disks.  This is especially
+useful for NFS and AFS shares, reducing read latency.
+
+@deffn {Scheme Variable} cachefilesd-service-type
+The service type for starting cachefilesd.  For example starting the
+cachefiles daemon can be done as follow:
+
+@lisp
+(use-modules (gnu) (gnu services))
+(use-package-modules linux)
+(use-service-modules linux)
+
+(operating-system
+  ...
+  (services
+    (cons*
+      (service cachefilesd-service-type
+        (cachefilesd-configuration
+          (dir "/var/cache/fscache") ; the default value
+          (syslog? #f)               ; don't require syslogd
+          (secctx "cachefiles_kernel_t")
+          (tag "mycache")
+          (brun 10)
+          (bcull 7)
+          (bstop 3)))
+       %base-services)))
+@end lisp
+@end deffn
+
 @node Miscellaneous Services
 @subsection Miscellaneous Services