summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorDaniel Buch <boogiewasthere@gmail.com>2014-08-26 21:17:22 +0200
committerTom Gundersen <teg@jklm.no>2014-09-25 16:39:18 +0200
commitd6bc8348d5be8576a475ac8ced2b0146e60fb71f (patch)
tree1cc185bf0c719da2a39c679f7ddfe5ef47508143 /man
parent4a3bb599609d687e0a501a748bfac491f5fb9f6c (diff)
readahead: wipe out readahead
Diffstat (limited to 'man')
-rw-r--r--man/sd-daemon.xml1
-rw-r--r--man/sd-login.xml1
-rw-r--r--man/sd-readahead.xml117
-rw-r--r--man/sd_readahead.xml178
-rw-r--r--man/systemd-notify.xml11
-rw-r--r--man/systemd-readahead-replay.service.xml203
6 files changed, 0 insertions, 511 deletions
diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml
index d78a1151c..5f331e740 100644
--- a/man/sd-daemon.xml
+++ b/man/sd-daemon.xml
@@ -140,7 +140,6 @@
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
diff --git a/man/sd-login.xml b/man/sd-login.xml
index d8d45048e..f21170db1 100644
--- a/man/sd-login.xml
+++ b/man/sd-login.xml
@@ -131,7 +131,6 @@
<citerefentry><refentrytitle>sd_get_seats</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_login_monitor_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
diff --git a/man/sd-readahead.xml b/man/sd-readahead.xml
deleted file mode 100644
index bcc46b24d..000000000
--- a/man/sd-readahead.xml
+++ /dev/null
@@ -1,117 +0,0 @@
-<?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 2010 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="sd-readahead" conditional='ENABLE_READAHEAD'>
-
- <refentryinfo>
- <title>sd-readahead</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>sd-readahead</refentrytitle>
- <manvolnum>3</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>sd-readahead</refname>
- <refpurpose>Reference implementation of APIs for
- controlling boot-time read-ahead</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>#include "sd-readahead.h"</funcsynopsisinfo>
- </funcsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
-
- <para><filename>sd-readahead.c</filename> and
- <filename>sd-readahead.h</filename> provide a
- reference implementation for APIs for controlling boot-time
- read-ahead, as implemented by the read-ahead subsystem
- of the
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- init system.</para>
-
- <para>See
- <citerefentry><refentrytitle>sd_readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- for more information about the function
- implemented.</para>
- </refsect1>
-
- <refsect1>
- <title>Notes</title>
-
- <para>This interface is provided by the reference
- implementation of APIs for controlling boot-time
- read-ahead and distributed with the systemd
- package. The algorithms it implements are simple, and
- can easily be reimplemented in daemons if it is
- important to support this interface without using the
- reference implementation. See the respective function
- man pages for details.</para>
-
- <para>In addition, for details about the algorithms,
- check the liberally licensed reference implementation
- sources:
- <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/readahead/sd-readahead.c"/>
- and <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/systemd/sd-readahead.h"/></para>
-
- <para>These APIs are implemented in the reference
- implementation's drop-in
- <filename>sd-readahead.c</filename> and
- <filename>sd-readahead.h</filename> files. It is
- recommended that applications consuming these APIs copy
- the implementation into their source tree, either
- verbatim or in excerpts. These interfaces are
- currently not available in a dynamic library.</para>
-
- <para>The functions provided by this interface become
- NOPs when -DDISABLE_SYSTEMD is set during
- compilation. In addition, if
- <filename>sd-readhead.c</filename> is compiled on
- non-Linux systems it becomes NOPs.</para>
- </refsect1>
-
- <refsect1>
- <title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd_readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- </para>
- </refsect1>
-
-</refentry>
diff --git a/man/sd_readahead.xml b/man/sd_readahead.xml
deleted file mode 100644
index 98272997c..000000000
--- a/man/sd_readahead.xml
+++ /dev/null
@@ -1,178 +0,0 @@
-<?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 2010 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="sd_readahead" conditional='ENABLE_READAHEAD'>
-
- <refentryinfo>
- <title>sd_readahead</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>sd_readahead</refentrytitle>
- <manvolnum>3</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>sd_readahead</refname>
- <refpurpose>Control ongoing disk boot-time read-ahead operations</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>#include "sd-readahead.h"</funcsynopsisinfo>
-
- <funcprototype>
- <funcdef>int <function>sd_readahead</function></funcdef>
- <paramdef>const char *<parameter>action</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
- <para><function>sd_readahead()</function> may be
- called by programs involved with early boot-up to
- control ongoing boot-time disk read-ahead operations. It may be
- used to terminate read-ahead operations in case an
- uncommon disk access pattern is to be expected and
- hence read-ahead replay or collection is unlikely to
- have the desired speed-up effect on the current or
- future boot-ups.</para>
-
- <para>The <parameter>action</parameter> should be one
- of the following strings:</para>
-
- <variablelist>
- <varlistentry>
- <term>cancel</term>
-
- <listitem><para>Terminates read-ahead
- data collection, and drops all
- read-ahead data collected during this
- boot-up.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>done</term>
-
- <listitem><para>Terminates read-ahead
- data collection, but keeps all
- read-ahead data collected during this
- boot-up around for use during
- subsequent boot-ups.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>noreplay</term>
-
- <listitem><para>Terminates read-ahead
- replay.</para></listitem>
- </varlistentry>
-
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Return Value</title>
-
- <para>On failure, these calls return a negative
- errno-style error code. It is generally recommended to
- ignore the return value of this call.</para>
- </refsect1>
-
- <refsect1>
- <title>Notes</title>
-
- <para>This function is provided by the reference
- implementation of APIs for controlling boot-time
- read-ahead and distributed with the systemd
- package. The algorithm it implements is simple, and
- can easily be reimplemented in daemons if it is
- important to support this interface without using the
- reference implementation.</para>
-
- <para>Internally, this function creates a file in
- <filename>/run/systemd/readahead/</filename> which is
- then used as flag file to notify the read-ahead
- subsystem.</para>
-
- <para>For details about the algorithm check the
- liberally licensed reference implementation sources:
- <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/readahead/sd-readahead.c"/>
- and <ulink
- url="http://cgit.freedesktop.org/systemd/systemd/plain/src/systemd/sd-readahead.h"/></para>
-
- <para><function>sd_readahead()</function> is
- implemented in the reference implementation's drop-in
- <filename>sd-readahead.c</filename> and
- <filename>sd-readahead.h</filename> files. It is
- recommended that applications consuming this API copy
- the implementation into their source tree. For more
- details about the reference implementation, see
- <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
-
- <para>If -DDISABLE_SYSTEMD is set during compilation,
- this function will always return 0 and otherwise
- become a NOP.</para>
- </refsect1>
-
- <refsect1>
- <title>Examples</title>
-
- <example>
- <title>Cancelling all read-ahead operations</title>
-
- <para>During boots where SELinux has to
- relabel the file system hierarchy, it will
- create a large amount of disk accesses that
- are not necessary during normal boots. Hence
- it is a good idea to disable both read-ahead replay and read-ahead collection.
- </para>
-
- <programlisting>sd_readahead("cancel");
-sd_readahead("noreplay");</programlisting>
- </example>
-
- </refsect1>
-
- <refsect1>
- <title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>
- </para>
- </refsect1>
-
-</refentry>
diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml
index 69baae0dc..684f49009 100644
--- a/man/systemd-notify.xml
+++ b/man/systemd-notify.xml
@@ -141,17 +141,6 @@
<citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
- <varlistentry>
- <term><option>--readahead=</option></term>
-
- <listitem><para>Controls disk
- read-ahead operations. The argument
- must be a string, and either "cancel",
- "done" or "noreplay". For details
- about the semantics of this option see
- <citerefentry><refentrytitle>sd_readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
- </varlistentry>
-
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
diff --git a/man/systemd-readahead-replay.service.xml b/man/systemd-readahead-replay.service.xml
deleted file mode 100644
index 669fe7894..000000000
--- a/man/systemd-readahead-replay.service.xml
+++ /dev/null
@@ -1,203 +0,0 @@
-<?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 2010 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-readahead-replay.service" conditional='ENABLE_READAHEAD'
- xmlns:xi="http://www.w3.org/2001/XInclude">
-
- <refentryinfo>
- <title>systemd-readahead-replay.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-readahead-replay.service</refentrytitle>
- <manvolnum>8</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>systemd-readahead-replay.service</refname>
- <refname>systemd-readahead-collect.service</refname>
- <refname>systemd-readahead-done.service</refname>
- <refname>systemd-readahead-done.timer</refname>
- <refname>systemd-readahead</refname>
- <refpurpose>Disk read ahead logic</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <para><filename>systemd-readahead-replay.service</filename></para>
- <para><filename>systemd-readahead-collect.service</filename></para>
- <para><filename>systemd-readahead-done.service</filename></para>
- <para><filename>systemd-readahead-done.timer</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>
- <title>Description</title>
-
- <para><filename>systemd-readahead-collect.service</filename>
- is a service that collects disk usage patterns at boot
- time. <filename>systemd-readahead-replay.service</filename>
- is a service that replays this access data collected
- at the subsequent boot. Since disks tend to be
- magnitudes slower than RAM, this is intended to improve
- boot speeds by pre-loading early at boot all data on
- disk that is known to be read for the complete boot
- process.</para>
-
- <para><filename>systemd-readahead-done.service</filename>
- is executed a short while after boot completed and signals
- <filename>systemd-readahead-collect.service</filename>
- to end data collection. On this signal, this service
- will then sort the collected disk accesses and store
- information about them in
- <filename>/.readahead</filename>.</para>
-
- <para>Normally, both
- <filename>systemd-readahead-collect.service</filename>
- and
- <filename>systemd-readahead-replay.service</filename>
- are activated at boot so that access patterns from the
- 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
- <filename>systemd-readahead-collect.service</filename>.</para>
-
- <para>On rotating media, when replaying disk accesses
- at early boot,
- <filename>systemd-readahead-replay.service</filename>
- will order read requests by their location on disk. On
- non-rotating media, they will be ordered by their
- original access timestamp. If the file system supports
- it,
- <filename>systemd-readahead-collect.service</filename>
- will also defragment and rearrange files on disk to
- optimize subsequent boot times.</para>
- </refsect1>
-
- <refsect1>
- <title>Options</title>
-
- <para><filename>systemd-readahead</filename> understands
- the following options:</para>
-
- <variablelist>
- <varlistentry>
- <term><option>--files-max=</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 microseconds
- to spend collecting data. Only valid
- for the <command>collect</command>
- command.</para></listitem>
- </varlistentry>
-
- <xi:include href="standard-options.xml" xpointer="help" />
- <xi:include href="standard-options.xml" xpointer="version" />
- </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. For each file, the
- output lists approximately 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>
- </para>
- </refsect1>
-
-</refentry>