source: general/genlib/libpaper.xml@ e53161d

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libpaper-download-http "https://github.com/rrthomas/libpaper/releases/download/v&libpaper-version;/libpaper-&libpaper-version;.tar.gz">
  <!ENTITY libpaper-download-ftp  " ">
  <!ENTITY libpaper-md5sum        "4b914c3ca6d8277260fce418e12bae6b">
  <!ENTITY libpaper-size          "1.1 MB">
  <!ENTITY libpaper-buildsize     "11 MB (with tests)">
  <!ENTITY libpaper-time          "0.1 SBU (with tests)">
]>

<sect1 id="libpaper" xreflabel="libpaper-&libpaper-version;">
  <?dbhtml filename="libpaper.html"?>


  <title>libpaper-&libpaper-version;</title>

  <indexterm zone="libpaper">
    <primary sortas="a-libpaper">libpaper</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libpaper</title>

    <para>
      This package is intended to provide a simple way for applications to take
      actions based on a system or user-specified paper size.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libpaper-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libpaper-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libpaper-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libpaper-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libpaper-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libpaper-time;
        </para>
      </listitem>
    </itemizedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libpaper</title>

    <para>
      Install <application>libpaper</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --disable-static     \
            --docdir=/usr/share/doc/libpaper-&libpaper-version; &amp;&amp;
make</userinput></screen>

    <!-- All tests "PASS" but the log just contains:
         "sysconfdir does not start with prefix, cannot run test!"
    <para>
      To test the results, issue: <command>make check</command>.
    </para> -->

    <para>
      The test suite of this package does not work with a configuration
      using the standard installation location.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>
    <!--
    <para>
      <parameter>- -enable-relocatable</parameter>:
      This switch is needed to run the tests.
    </para>
    -->
  </sect2>

  <sect2 role="configuration">
    <title>Configuring libpaper</title>

    <sect3>
      <title>Configuration Information</title>

      <para>
        The paper size is automatically determined from the system locale;
        see <literal>LC_PAPER</literal> in <ulink role='man'
        url='&man;locale.7'>locale(7)</ulink>.
        If you want to override it, create a <filename>papersize</filename>
        file in the user configuration directory.  For example:
      </para>

<screen role="nodump"><userinput>mkdir -pv ~/.config &amp;&amp;
echo "a4" &gt; ~/.config/papersize</userinput></screen>

      <para>
        If you want to override the paper size globally (for all users),
        set up the <envar>PAPERSIZE</envar> environment variable.  For
        example:
      </para>

<screen role="nodump"><userinput>echo "PAPERSIZE=a4" &gt; /etc/profile.d/libpaper.sh</userinput></screen>

      <para>
        You may use a different paper size, such as
        <quote><literal>letter</literal></quote>.
      </para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          paper and
          paperconf
        </seg>
        <seg>
          libpaper.so
        </seg>
        <seg>
          /usr/share/doc/libpaper-&libpaper-version;
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="paper">
        <term><command>paper</command></term>
        <listitem>
          <para>
            prints paper configuration information
          </para>
          <indexterm zone="libpaper paper">
            <primary sortas="b-paper">paper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="paperconf">
        <term><command>paperconf</command></term>
        <listitem>
          <para>
            prints paper configuration information in a compatibility mode
          </para>
          <indexterm zone="libpaper paperconf">
            <primary sortas="b-paperconf">paperconf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpaper-lib">
        <term><filename class="libraryfile">libpaper.so</filename></term>
        <listitem>
          <para>
            contains functions for interrogating the paper library
          </para>
          <indexterm zone="libpaper libpaper-lib">
            <primary sortas="c-libpaper">libpaper.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>