doc: Mention syslogd configuration.

* gnu/services/base.scm (syslog-service): Add xref to Inetutils in the
docstring.
(%default-syslog.conf): Export.
* doc/guix.texi (Base Services): Update accordingly.
This commit is contained in:
Ludovic Courtès 2016-03-04 10:51:45 +01:00
parent 4ce783a2f9
commit 44abcb2868
2 changed files with 14 additions and 6 deletions

View file

@ -6984,10 +6984,14 @@ external name servers do not even need to be queried.
@end defvr
@deffn {Scheme Procedure} syslog-service [#:config-file #f]
Return a service that runs @code{syslogd}. If configuration file name
@var{config-file} is not specified, use some reasonable default
@deffn {Scheme Procedure} syslog-service @
[#:config-file @var{%default-syslog.conf}]
Return a service that runs @command{syslogd}. If configuration file
name @var{config-file} is not specified, use some reasonable default
settings.
@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more
information on the configuration file syntax.
@end deffn
@anchor{guix-configuration-type}

View file

@ -80,6 +80,7 @@ (define-module (gnu services base)
nscd-service-type
nscd-service
syslog-service
%default-syslog.conf
guix-configuration
guix-configuration?
@ -804,9 +805,12 @@ (define %default-syslog.conf
"))
(define* (syslog-service #:key (config-file %default-syslog.conf))
"Return a service that runs @code{syslogd}.
If configuration file name @var{config-file} is not specified, use some
reasonable default settings."
"Return a service that runs @command{syslogd}. If configuration file
name @var{config-file} is not specified, use some reasonable default
settings.
@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more
information on the configuration file syntax."
(service syslog-service-type config-file))