diff options
| author | Auke Kok <auke-jan.h.kok@intel.com> | 2013-04-14 12:54:54 -0700 |
|---|---|---|
| committer | Auke Kok <auke-jan.h.kok@intel.com> | 2013-04-14 12:54:54 -0700 |
| commit | cfca24f3df2fc17021cee712a76ccc1ce6f1809d (patch) | |
| tree | 31b437cfe036232aaec06aeab4e832e609b7c2b0 /man/systemd-readahead-replay.service.xml | |
| parent | 268d944e44bea60d5c498cb24a8629f012aac055 (diff) | |
readahead: document options and commands.
Diffstat (limited to 'man/systemd-readahead-replay.service.xml')
| -rw-r--r-- | man/systemd-readahead-replay.service.xml | 96 |
1 files changed, 95 insertions, 1 deletions
diff --git a/man/systemd-readahead-replay.service.xml b/man/systemd-readahead-replay.service.xml index 3d7d9f542..a00f7e589 100644 --- a/man/systemd-readahead-replay.service.xml +++ b/man/systemd-readahead-replay.service.xml @@ -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> @@ -104,6 +109,95 @@ </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> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> |