2010-10-05 20:44:37 +02:00
|
|
|
<?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
|
2012-04-12 00:20:58 +02:00
|
|
|
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
|
2010-10-05 20:44:37 +02:00
|
|
|
(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
|
2012-04-12 00:20:58 +02:00
|
|
|
Lesser General Public License for more details.
|
2010-10-05 20:44:37 +02:00
|
|
|
|
2012-04-12 00:20:58 +02:00
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
2010-10-05 20:44:37 +02:00
|
|
|
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
-->
|
|
|
|
|
2013-03-07 15:12:44 +01:00
|
|
|
<refentry id="sd-readahead" conditional='ENABLE_READAHEAD'>
|
2010-10-05 20:44:37 +02:00
|
|
|
|
|
|
|
<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>
|
2012-07-13 01:50:05 +02:00
|
|
|
<manvolnum>3</manvolnum>
|
2010-10-05 20:44:37 +02:00
|
|
|
</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:
|
2012-02-13 17:46:46 +01:00
|
|
|
<ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/readahead/sd-readahead.c"/>
|
Reword sentences that contain psuedo-English "resp."
As you likely know, Arch Linux is in the process of moving to systemd.
So I was reading through the various systemd docs and quickly became
baffled by this new abbreviation "resp.", which I've never seen before
in my English-mother-tongue life.
Some quick Googling turned up a reference:
<http://www.transblawg.eu/index.php?/archives/870-Resp.-and-other-non-existent-English-wordsNicht-existente-englische-Woerter.html>
I guess it's a literal translation of the German "Beziehungsweise", but
English doesn't work the same way. The word "respectively" is used
exclusively to provide an ordering connection between two lists. E.g.
"the prefixes k, M, and G refer to kilo-, mega-, and giga-,
respectively." It is also never abbreviated to "resp." So the sentence
"Sets the default output resp. error output for all services and
sockets" makes no sense to a natural English speaker.
This patch removes all instances of "resp." in the man pages and
replaces them with sentences which are much more clear and, hopefully,
grammatically valid. In almost all instances, it was simply replacing
"resp." with "or," which the original author (Lennart?) could probably
just do in the future.
The only other instances of "resp." are in the src/ subtree, which I
don't feel privileged to correct.
Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
2012-10-15 20:59:12 +02:00
|
|
|
and <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/systemd/sd-readahead.h"/></para>
|
2010-10-05 20:44:37 +02:00
|
|
|
|
|
|
|
<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>,
|
2012-07-13 01:50:05 +02:00
|
|
|
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
2010-10-05 20:44:37 +02:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|