diff options
author | Andrew Tropin <andrew@trop.in> | 2021-09-02 12:33:36 +0300 |
---|---|---|
committer | Oleg Pykhalov <go.wigust@gmail.com> | 2021-09-09 20:28:03 +0300 |
commit | 6b5ff71b993611d413d3c179b3d50115cd87f408 (patch) | |
tree | f202072452af71db149bf8c5926280c86ad532f8 /doc/guix.texi | |
parent | aaffa43c1752e062934580f55616e0380963a1be (diff) | |
download | guix-6b5ff71b993611d413d3c179b3d50115cd87f408.tar.gz |
home-services: Add Shepherd.
* gnu/home-services/shepherd.scm: New file. * gnu/local.mk: Add this. * doc/guix.texi: Add documentation about Shepherd Home Service. Signed-off-by: Oleg Pykhalov <go.wigust@gmail.com>
Diffstat (limited to 'doc/guix.texi')
-rw-r--r-- | doc/guix.texi | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 637ec2799b..e546fcc0d2 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -35689,7 +35689,37 @@ mcron info here @node Shepherd Home Service @subsection Managing User's Daemons -shepherd info here + +@cindex shepherd services + +@defvr {Scheme Variable} home-shepherd-service-type +The service type for the userland Shepherd, which allows one to manage +long-running processes or one-shot tasks. User's Shepherd is not an +init process (PID 1), but almost all other information described in +(@pxref{Shepherd Services}) is applicable here too. + +This is the service type that extensions target when they want to create +shepherd services (@pxref{Service Types and Services}, for an example). +Each extension must pass a list of @code{<shepherd-service>}. Its +value must be a @code{shepherd-configuration}, as described below. +@end defvr + +@deftp {Data Type} shepherd-configuration +This data type represents the Shepherd's configuration. + +@table @code +@item shepherd (default: @code{shepherd}) +The Shepherd package to use. + +@item auto-start? (default: @code{#t}) +Whether or not to start Shepherd on first login. + +@item services (default: @code{'()}) +A list of @code{<shepherd-service>} to start. +You should probably use the service extension +mechanism instead (@pxref{Shepherd Services}). +@end table +@end deftp @node Invoking guix home @section Invoking @code{guix home} |