summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2016-03-04 10:51:45 +0100
committerLudovic Courtès <ludo@gnu.org>2016-03-04 11:48:52 +0100
commit44abcb28686fbe72b576c0c5b4d92f04a675270f (patch)
tree98e50abfbb59ca3cec9e173008cf75cec9234890
parent4ce783a2f9edc5cf1024b02e3c434ed361e8897d (diff)
downloadpatches-44abcb28686fbe72b576c0c5b4d92f04a675270f.tar
patches-44abcb28686fbe72b576c0c5b4d92f04a675270f.tar.gz
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.
-rw-r--r--doc/guix.texi10
-rw-r--r--gnu/services/base.scm10
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))