source: pst/printing/cups-browsed.xml@ 8bb1591

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 cups-browsed-download-http
  "https://github.com/OpenPrinting/cups-browsed/releases/download/&cups-browsed-version;/cups-browsed-&cups-browsed-version;.tar.xz">
  <!ENTITY cups-browsed-download-ftp  " ">
  <!ENTITY cups-browsed-md5sum        "1f8dc0c5a08d8a410df0713c5adbaee9">
  <!ENTITY cups-browsed-size          "416 KB">
  <!ENTITY cups-browsed-buildsize     "6.3 MB">
  <!ENTITY cups-browsed-time          "less than 0.1 SBU (Using parallelism=4)">
]>

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


  <title>cups-browsed-&cups-browsed-version;</title>

  <indexterm zone="cups-browsed">
    <primary sortas="a-cups-browsed">cups-browsed</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to cups-browsed</title>

    <para>
      The <application>cups-browsed</application> daemon is used to
      browse the network for remote CUPS queues and IPP network printers
      and automatically create local queues pointing to them.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">cups-browsed Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libcupsfilters"/> and
      <xref linkend="libppd"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="avahi"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="openldap"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of cups-browsed</title>

    <para>
      Install <application>cups-browsed</application> by running the
      following commands:
    </para>

<screen><userinput>./configure --prefix=/usr                   \
            --with-cups-rundir=/run/cups    \
            --without-rcdir                 \
            --disable-static                \
            --docdir=/usr/share/doc/cups-browsed-&cups-browsed-version; &amp;&amp;
make</userinput></screen>
<!-- Tests seem to hang, not sure why
    <para>
      To test the results, issue <command>make check</command>.
    </para>
    -->
    <para>
      This package does not come with a functional test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

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

    <para revision="systemd">
      Install the systemd unit by running the following command as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root" revision="systemd"><userinput>install -v -m644 daemon/cups-browsed.service /lib/systemd/system/cups-browsed.service</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>--with-cups-rundir=/run/cups</parameter>: Defines the
      directory containing transcient printing data. The default
      <filename class="directory">/var/run/cups</filename> is obsolete.
    </para>

    <para>
      <parameter>--without-rcdir</parameter>: This switch disables
      installation of the bundled bootscript which is not compatible with BLFS.
    </para>

  </sect2>

<!-- TODO: Write a bootscript for cups-browsed -->

  <sect2 role="configuration" revision="systemd">
    <title>Configuring cups-browsed</title>

    <sect3 id="cups-browsed-init">
      <title>Systemd Unit</title>

      <para>
        To start the <command>cups-browsed</command> daemon at boot, enable
        the previously installed systemd unit by running the following command
        as the <systemitem class="username">root</systemitem> user:
      </para>

      <indexterm zone="cups-browsed cups-browsed-init">
        <primary sortas="f-cups-browsed">cups-browsed</primary>
      </indexterm>

<screen role="root"><userinput>systemctl enable cups-browsed</userinput></screen>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>
          cups-browsed
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="cups-browsed-prog">
        <term><command>cups-browsed</command></term>
        <listitem>
          <para>
            is a daemon for browsing the Bonjour and CUPS broadcasts of
            shared, remote CUPS printers
          </para>
          <indexterm zone="cups-browsed cups-browsed-prog">
            <primary sortas="b-cups-browsed">cups-browsed</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>