From: Daniel Kahn Gillmor Date: Mon, 5 Feb 2018 05:20:29 +0000 (-0500) Subject: doc: kresd.systemd belongs in section 7 of the manual X-Git-Tag: v2.1.0~16^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=23c8ffbfaac9e4c7a8c1400d08e961aca3ab772a;p=thirdparty%2Fknot-resolver.git doc: kresd.systemd belongs in section 7 of the manual "man man" says that the sections are: 1 Executable programs or shell commands 2 System calls (functions provided by the kernel) 3 Library calls (functions within program libraries) 4 Special files (usually found in /dev) 5 File formats and conventions eg /etc/passwd 6 Games 7 Miscellaneous (including macro packages and conventions), e.g. man(7), groff(7) 8 System administration commands (usually only for root) 9 Kernel routines [Non standard] Since there is no command named kresd.system it does not belong in section 8. Section 7 includes conventions and useful patterns like gitcli(7), which seems more similar to the documentation that is supplied in kresd.systemd. --- diff --git a/NEWS b/NEWS index 22b7e3627..ac6b30a70 100644 --- a/NEWS +++ b/NEWS @@ -5,7 +5,7 @@ Incompatible changes -------------------- - systemd: change unit files to allow running multiple instances, deployments with single instance now must use `kresd@1.service` - instead of `kresd.service`; see kresd.systemd(8) for details + instead of `kresd.service`; see kresd.systemd(7) for details - systemd: the directory for cache is now /var/cache/knot-resolver - unify default directory and user to `knot-resolver` - directory with trust anchor file specified by -k option must be writeable diff --git a/daemon/README.rst b/daemon/README.rst index 649f1d686..07c8f6a9e 100644 --- a/daemon/README.rst +++ b/daemon/README.rst @@ -1012,7 +1012,7 @@ The watchdog process must notify kresd about active file descriptors, and kresd The daemon also supports `systemd socket activation`_, it is automatically detected and requires no configuration on users's side. -See ``kresd.systemd(8)`` for details. +See ``kresd.systemd(7)`` for details. Enabling DNSSEC =============== diff --git a/doc/kresd.8.in b/doc/kresd.8.in index fb4784ee4..150d6bf82 100644 --- a/doc/kresd.8.in +++ b/doc/kresd.8.in @@ -164,7 +164,7 @@ Show short commandline option help. .B \-V Show the version. .SH "SEE ALSO" -\fIkresd.systemd(8)\fR, +\fIkresd.systemd(7)\fR, \fIhttps://knot-resolver.readthedocs.io\fR .SH "AUTHORS" .B kresd diff --git a/doc/kresd.systemd.8 b/doc/kresd.systemd.7 similarity index 96% rename from doc/kresd.systemd.8 rename to doc/kresd.systemd.7 index 0eca9805e..f046710d7 100644 --- a/doc/kresd.systemd.8 +++ b/doc/kresd.systemd.7 @@ -1,6 +1,6 @@ -.TH "kresd.systemd" "8" "2018-01-30" "CZ.NIC" "Knot DNS Resolver Systemd Units" +.TH "kresd.systemd" "7" "2018-01-30" "CZ.NIC" "Knot DNS Resolver Systemd Units" .\" -.\" kresd.systemd.8 -- man page for systemd units for kresd +.\" kresd.systemd.7 -- man page for systemd units for kresd .\" .\" Copyright (c) 2018, CZ.NIC. All rights reserved. .\" diff --git a/systemd/README.md b/systemd/README.md index d44c2bf7a..353f4873a 100644 --- a/systemd/README.md +++ b/systemd/README.md @@ -9,7 +9,7 @@ sd_listen_fds_with_names(3)). Usage and Configuration ----------------------- -See kresd.systemd(8) for details. +See kresd.systemd(7) for details. Manual activation -----------------