xenocara/app/xplsprinters/xplsprinters.sgml

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 'http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd'>

<!-- Process this file with DocBook tools to generate the output format
(such as manual pages or HTML documents).

Note that strings like __appmansuffix__, __filemansuffix__, __libmansuffix__,
__miscmansuffix__ etc. have to be replaced first (in theory that's the
job of ENTITIES but some XML tools are highly allergic to such stuff... ;-().
A quick way to do that is to filter this document via
/usr/bin/sed "s/__appmansuffix__/${MANSUFFIX}/g;s/__filemansuffix__/${FILEMANSUFFIX}/g;s/__libmansuffix__/${LIBMANSUFFIX}/g;s/__miscmansuffix__/${MISCMANSUFFIX}/g"
assuming that env vars like MANSUFFIX etc. have been set to the matching
manual volume numbers.
  -->

<refentry>
  <refmeta>
    <refentrytitle>xplsprinters</refentrytitle>
    <manvolnum>__appmansuffix__</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>xplsprinters</refname>
    <refpurpose>shows a list of Xprint printers and it's attributes</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>xplsprinters</command>

      <arg><option>-printer <replaceable>printername</replaceable></option></arg>

      <arg><option>-d</option></arg>

      <arg><option>-l</option></arg>

      <arg><option>-dump</option></arg>

      <arg><option>-h</option></arg>
      
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>
      <command>xplsprinters</command> is a utility for Xprint, the
      printing system for the X Window system. It can deliver both a list
      of printers and attributes supported for a specific list of
      printers.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-printer <replaceable>printername</replaceable></option>
        </term>
        <listitem>
          <para>printer to use</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-dump</option>
        </term>
        <listitem>
          <para>dump all available printer attributes</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h | -?</option>
        </term>
        <listitem>
          <para>print usage</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option>
        </term>
        <listitem>
          <para>print description for each printer</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l</option>
        </term>
        <listitem>
          <para>list detailed printer attribute information</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>ENVIRONMENT</title>

    <variablelist>
      <varlistentry>
        <term><envar>XPSERVERLIST</envar>
        </term>
        <listitem>
	    <para><envar>${XPSERVERLIST}</envar> must be set,
	    identifying the available Xprint servers.
            See <citerefentry><refentrytitle>Xprint</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry>
	    for more details.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>EXAMPLES</title>

    <example role="example">
      <title>List all available "X Print Specifiers" (printer names)</title>
      <para><screen>% <userinput>xplsprinters</userinput></screen></para>
      <para>would print:
<screen><computeroutput>printer: hplaserjet001@puck:33
printer: hpcolor4550_004@puck:33
printer: laser19@meridian:19
printer: xp_ps_spooldir_tmp_Xprintjobs@meridian:19
printer: xp_pdf_spooldir_tmp_Xprintjobs@meridian:19</computeroutput></screen>
      </para>
    </example>

    <example role="example">
      <title>Get information about the supported attributes of printer "ps002":</title>
      <para><screen>% <userinput>xplsprinters -printer ps002 -l</userinput></screen></para>
      <para>would print:
<screen><computeroutput>
printer: ps002@castor:18
        description=
        model-identifier=HPDJ1600C
        default-medium=iso-a4
        default-input-tray=
        medium-source-sizes-supported=iso-a4 false 6.35 203.65 6.35 290.65
        medium-source-sizes-supported=na-letter false 6.35 209.55 6.35 273.05
        default-printer-resolution=300
        resolution=300
        default_orientation=
        orientation=portrait
        orientation=landscape
        default_plex=
        plex=simplex
</computeroutput></screen>
      </para>
    </example>
  </refsect1>

  <refsect1>
    <title>NOTES</title>
    <para>
      The list of builtin fonts supported by a printer can be obtained
      using the <command>xlsfonts</command> command.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <simplelist type="inline">
        <!-- specific references -->
        <!-- none -->
        
        <!-- Xprint general references -->
        <member><citerefentry><refentrytitle>Xprint</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>X11</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry></member>
<!--
        <member><citerefentry><refentrytitle>xplsprinters</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
-->
        <member><citerefentry><refentrytitle>xprehashprinterlist</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>xphelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>xpxmhelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>xpawhelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>xpxthelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>xpsimplehelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>xlsfonts</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>Xserver</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>Xprt</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
        <!-- ToDO: Add manual pages for the single Xprint DDX implementations (PostScript/PDF/PCL/PCL-MONO/Raster/etc.) -->
        <member><citerefentry><refentrytitle>libXp</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>libXprintUtils</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>libXprintAppUtils</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>XmPrintShell</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>XawPrintShell</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member>Xprint FAQ (<ulink url="http://xprint.mozdev.org/docs/Xprint_FAQ.html">http://xprint.mozdev.org/docs/Xprint_FAQ.html</ulink>)</member>
        <member>Xprint main site (<ulink url="http://xprint.mozdev.org/">http://xprint.mozdev.org/</ulink>)</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>