chiark / gitweb /
man: document systemd-random-seed-load.service
authorLennart Poettering <lennart@poettering.net>
Mon, 25 Jun 2012 10:13:17 +0000 (12:13 +0200)
committerLennart Poettering <lennart@poettering.net>
Mon, 25 Jun 2012 10:13:17 +0000 (12:13 +0200)
Makefile.am
man/systemd-random-seed-load.service.xml [new file with mode: 0644]
units/systemd-random-seed-load.service.in
units/systemd-random-seed-save.service.in

index b7fb370..ca676e5 100644 (file)
@@ -2484,6 +2484,17 @@ randomseed-install-data-hook:
 
 INSTALL_DATA_HOOKS += \
        randomseed-install-data-hook
 
 INSTALL_DATA_HOOKS += \
        randomseed-install-data-hook
+
+MANPAGES += \
+       man/systemd-random-seed-load.service.8
+
+MANPAGES_ALIAS +=  \
+       man/systemd-random-seed-save.service.8 \
+       man/systemd-random-seed.8
+
+man/systemd-random-seed-save.service.8: man/systemd-random-seed-load.service.8
+man/systemd-random-seed.8: man/systemd-random-seed-load.service.8
+
 endif
 
 # ------------------------------------------------------------------------------
 endif
 
 # ------------------------------------------------------------------------------
diff --git a/man/systemd-random-seed-load.service.xml b/man/systemd-random-seed-load.service.xml
new file mode 100644 (file)
index 0000000..87f563e
--- /dev/null
@@ -0,0 +1,80 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!--
+  This file is part of systemd.
+
+  Copyright 2012 Lennart Poettering
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+<refentry id="systemd-random-seed-load.service">
+
+        <refentryinfo>
+                <title>systemd-random-seed-load.service</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Lennart</firstname>
+                                <surname>Poettering</surname>
+                                <email>lennart@poettering.net</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>systemd-random-seed-load.service</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-random-seed-load.service</refname>
+                <refname>systemd-random-seed-save.service</refname>
+                <refname>systemd-random-seed</refname>
+                <refpurpose>Load and save the system random seed at boot and shutdown</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-random-seed-load.service</filename></para>
+                <para><filename>systemd-random-seed-save.service</filename></para>
+                <para><filename>/usr/lib/systemd/systemd-random-seed</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-random-seed-load.service</filename>
+                is an early-boot service that restores the random seed
+                of the
+                system. <filename>systemd-random-seed-save.service</filename>
+                is a late-shutdown service that saves the random seed
+                of the system. See
+                <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry>
+                for details. Saving/restoring the random seed across
+                boots increases the amount of available entropy early
+                at boot. On disk the random seed is stored in
+                <filename>/var/lib/random-seed</filename>.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
index a5e2bbb..8ea5750 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Load Random Seed
 
 [Unit]
 Description=Load Random Seed
+Documentation=man:systemd-random-seed-load.service(8) man:random(4)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service systemd-remount-fs.service
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service systemd-remount-fs.service
index 0ebd07d..05b3c61 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Save Random Seed
 
 [Unit]
 Description=Save Random Seed
+Documentation=man:systemd-random-seed-load.service(8) man:random(4)
 DefaultDependencies=no
 After=systemd-random-seed-load.service
 Before=shutdown.target
 DefaultDependencies=no
 After=systemd-random-seed-load.service
 Before=shutdown.target