X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd-readahead-replay.service.xml;h=a00f7e589b2a288e5dda1c0bf6f991e8a67da9bc;hb=74d005783e355acc784d123024e33bbb66ef9ef1;hp=e37b1a9edff9dd9c653ea539251cf753a42e37cf;hpb=56a379a97e91380630653b85e5cb3612bf22ecf4;p=elogind.git

diff --git a/man/systemd-readahead-replay.service.xml b/man/systemd-readahead-replay.service.xml
index e37b1a9ed..a00f7e589 100644
--- a/man/systemd-readahead-replay.service.xml
+++ b/man/systemd-readahead-replay.service.xml
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-readahead-replay.service">
+<refentry id="systemd-readahead-replay.service" conditional='ENABLE_READAHEAD'>
 
         <refentryinfo>
                 <title>systemd-readahead-replay.service</title>
@@ -48,7 +48,7 @@
                 <refname>systemd-readahead-done.service</refname>
                 <refname>systemd-readahead-done.timer</refname>
                 <refname>systemd-readahead</refname>
-                <refpurpose>systemd Disk Read Ahead Logic</refpurpose>
+                <refpurpose>Disk read ahead logic</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -56,7 +56,12 @@
                 <para><filename>systemd-readahead-collect.service</filename></para>
                 <para><filename>systemd-readahead-done.service</filename></para>
                 <para><filename>systemd-readahead-done.timer</filename></para>
-                <para><filename>/usr/lib/systemd/systemd-readahead</filename></para>
+                <cmdsynopsis>
+                        <command>/usr/lib/systemd/systemd-readahead/systemd-readahead</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="plain">COMMAND</arg>
+                        <arg choice="opt">DIRECTORY | FILE</arg>
+                </cmdsynopsis>
         </refsynopsisdiv>
 
         <refsect1>
@@ -85,7 +90,7 @@
                 and
                 <filename>systemd-readahead-replay.service</filename>
                 are activated at boot so that access patterns from the
-                preceeding boot are replayed and new data collected
+                preceding boot are replayed and new data collected
                 for the subsequent boot. However, on read-only media
                 where the collected data cannot be stored it might
                 be a good idea to disable
@@ -103,6 +108,95 @@
                 optimize subsequent boot times.</para>
         </refsect1>
 
+        <refsect1>
+                <title>Options</title>
+
+                <para><filename>systemd-readahead</filename> understands
+                the following options:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><option>-h</option></term>
+                                <term><option>--help</option></term>
+
+                                <listitem><para>Prints a short help text
+                                and exits.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--max-files=</option></term>
+
+                                <listitem><para>Maximum number of
+                                files to read ahead. Only valid
+                                for thes <command>collect</command>
+                                command.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--file-size-max=</option></term>
+
+                                <listitem><para>Maximum size of files
+                                (in bytes) to read ahead. Only valid
+                                for the <command>collect</command>
+                                and <command>replay</command>
+                                commands.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--timeout=</option></term>
+
+                                <listitem><para>Maximum time (in usec)
+                                to to spend collecting data. Only valid
+                                for the <command>collect</command>
+                                command.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Commands</title>
+
+                <para>The following commands are understood by
+                <filename>systemd-readahead</filename>:</para> <variablelist>
+                        <varlistentry>
+                                <term><command>collect
+                                [<replaceable>DIRECTORY</replaceable>]</command></term>
+                                <listitem>
+                                        <para>Collect read-ahead data on
+                                        early boot. When terminating it will
+                                        write out a pack file to the indicated
+                                        directory containing the read-ahead
+                                        data. </para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>replay
+                                [<replaceable>DIRECTORY</replaceable>]</command></term>
+                                <listitem>
+                                        <para>Perform read-ahead on the
+                                        specified directory tree.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>analyze
+                                [<replaceable>FILE</replaceable>]</command></term>
+                                <listitem>
+                                        <para>Dumps the content of the
+                                        read-ahead pack file to the
+                                        terminal. The output lists
+                                        approximately for each file
+                                        how much will be read-ahead by
+                                        the <command>replay</command>
+                                        command.</para>
+                                </listitem>
+                        </varlistentry>
+
+                </variablelist>
+        </refsect1>
+
         <refsect1>
                 <title>See Also</title>
                 <para>