From 44abcb28686fbe72b576c0c5b4d92f04a675270f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= Date: Fri, 4 Mar 2016 10:51:45 +0100 Subject: [PATCH] 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. --- doc/guix.texi | 10 +++++++--- gnu/services/base.scm | 10 +++++++--- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 67a794aa15..44cddf84da 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -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} diff --git a/gnu/services/base.scm b/gnu/services/base.scm index 6160e79f30..9b3dc73831 100644 --- a/gnu/services/base.scm +++ b/gnu/services/base.scm @@ -80,6 +80,7 @@ nscd-service-type nscd-service syslog-service + %default-syslog.conf guix-configuration guix-configuration? @@ -804,9 +805,12 @@ Service Switch}, for an example." ")) (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))