xorg-server-1.4/hw/xprint/doc/Xprt.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 'http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd'>
   2
   3 <!-- Process this file with docbook-to-man to generate an nroff manual
   4      page: 'docbook-to-man manpage.sgml > manpage.1'.  You may view
   5      the manual page with: 'docbook-to-man manpage.sgml | nroff -man | less'.
   6      A typical entry in a Makefile or Makefile.am is:
   7
   8 manpage.1: manpage.sgml
   9         docbook-to-man $< > $@
  10
  11 HTML generation can be done like this:
  12 % xsltproc ==docbook /usr/share/sgml/docbook/docbook-xsl-stylesheets-1.60.1/html/docbook.xsl Xprint.sgml >Xprint.html
  13   -->
  14
  15 <refentry id="Xprt">
  16   <refmeta>
  17     <refentrytitle>Xprt</refentrytitle>
  18     <manvolnum>__appmansuffix__</manvolnum>
  19   </refmeta>
  20   <refnamediv>
  21     <refname>Xprt</refname>
  22
  23     <refpurpose>Print server for X Version 11</refpurpose>
  24   </refnamediv>
  25   <refsynopsisdiv>
  26     <cmdsynopsis>
  27       <command>Xprt</command>
  28
  29       <arg><option>-ac</option></arg>
  30
  31       <arg><option>-audit <replaceable>level</replaceable></option></arg>
  32
  33       <arg><option>-pn</option></arg>
  34
  35       <arg><option>-fp <replaceable>fontpath</replaceable></option></arg>
  36
  37       <arg><option>-XpFile <replaceable>file</replaceable></option></arg>
  38
  39       <arg><option>-XpSpoolerType <replaceable>spoolername</replaceable></option></arg>
  40
  41       <arg><option>:<replaceable>display</replaceable></option></arg>
  42
  43     </cmdsynopsis>
  44   </refsynopsisdiv>
  45   <refsect1>
  46     <title>DESCRIPTION</title>
  47
  48     <para><command>Xprt</command> is the Xprint print server
  49       for version 11 of the X Window system for non display devices
  50       such as printers and fax machines.</para>
  51
  52     <para>Xprint is an advanced printing system which enables X11
  53       applications to use devices like printers, FAX or create
  54       documents in formats like PostScript, PCL or PDF.  It may be used by
  55       clients such as <application>mozilla</application>.
  56     </para>
  57
  58     <para>Xprint is a very flexible, extensible, scalable, client/server
  59      print system based on ISO 10175 (and some other specs) and the X11
  60      rendering protocol.
  61      Using Xprint an application can search, query and use devices like
  62      printers, FAX machines or create documents in formats like PDF.
  63      In particular, an application can seek a printer, query supported
  64      attributes (like paper size, trays, fonts etc.), configure the printer
  65      device to match it's needs and print on it like on any other X device
  66      reusing parts of the code which is used for the video card Xserver.
  67     </para>
  68   </refsect1>
  69
  70   <refsect1>
  71     <title>USAGE</title>
  72
  73     <para>
  74       Although Xprt may be invoked from the command line, it is
  75       preferable to run it as a daemon via the init script
  76       <filename>/etc/init.d/xprint</filename> (where this script exists).
  77     </para>
  78
  79     <para>Client programs such as mozilla will require environment
  80       variable <envar>${XPSERVERLIST}</envar> to be set, identifying the
  81       "display" on which Xprt is running.  This variable may be set
  82       for all users via <filename>/etc/profile</filename> (or similar), using
  83       <userinput>/etc/init.d/xprint get_xpserverlist</userinput>:
  84       <informalexample>
  85         <programlisting>export XPSERVERLIST=`/etc/init.d/xprint get_xpserverlist`</programlisting>
  86       </informalexample>
  87     </para>
  88   </refsect1>
  89
  90   <refsect1>
  91     <title>OPTIONS</title>
  92
  93     <para>Many of Xprt's command line options are shared in common
  94     with the usual X servers (see <citerefentry><refentrytitle>Xserver</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry>).
  95     Commonly used options include:</para>
  96
  97     <variablelist>
  98       <varlistentry>
  99         <term><option>:<replaceable>display</replaceable></option>
 100         </term>
 101         <listitem>
 102           <para> The X server runs on the given display. If multiple X
 103                servers are to run simultaneously on a host, each must
 104                have a unique display number.  Note that the standard X
 105                server (for video displays) typically runs on display
 106                :0.  If <filename>/etc/init.d/xprint</filename> is used
 107                to invoke Xprt, it may be configured to automatically assign an available
 108                display number.</para>
 109         </listitem>
 110       </varlistentry>
 111       <varlistentry>
 112         <term><option>-ac</option>
 113         </term>
 114         <listitem>
 115           <para>disables host-based access control mechanisms.  Enables  access
 116                by  any host, and permits any host to modify the access control
 117                list.  Use with extreme caution.  This option exists  primarily
 118                for running test suites remotely.</para>
 119         </listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term><option>-audit <replaceable>level</replaceable></option>
 123         </term>
 124         <listitem>
 125           <para>sets  the  audit  trail level.  The default level is 1, meaning
 126                only connection rejections are reported.  Level 2  additionally
 127                reports  all  successful  connections and disconnects.  Level 4
 128                enables messages  from  the  SECURITY  extension,  if  present,
 129                including  generation  and  revocation  of  authorizations  and
 130                violations of the security policy.  Level 0 turns off the audit
 131                trail.  Audit lines are sent as standard error output.</para>
 132         </listitem>
 133       </varlistentry>
 134       <varlistentry>
 135         <term><option>-fp <replaceable>fontpath</replaceable></option>
 136         </term>
 137         <listitem>
 138           <para>sets the search path for fonts.  This path is a comma
 139                separated list of directories which Xprt searches for
 140                font databases.</para>
 141         </listitem>
 142       </varlistentry>
 143       <varlistentry>
 144         <term><option>-pn</option>
 145         </term>
 146         <listitem>
 147           <para>permits the server to continue running if it fails to
 148                establish all of its well-known sockets (connection
 149                points for clients), but establishes at least
 150                one.</para>
 151         </listitem>
 152       </varlistentry>
 153
 154       <varlistentry>
 155         <term><option>-XpFile <replaceable>file</replaceable></option>
 156         </term>
 157         <listitem>
 158           <para>Sets an alternate Xprinters file (see section FILES).</para>
 159         </listitem>
 160       </varlistentry>
 161       <varlistentry>
 162         <term><option>-XpSpoolerType <replaceable>spoolername</replaceable></option>
 163         </term>
 164         <listitem>
 165           <para>
 166             Defines the spooler system to be used for print job spooling.
 167             Supported values in xprint.mozdev.org release 009 are:
 168             <simplelist type="vert">
 169               <member>aix</member>
 170               <member>aix4</member>
 171               <member>bsd</member>
 172               <member>osf</member>
 173               <member>solaris</member>
 174               <member>sysv</member>
 175               <member>uxp</member>
 176               <member>cups</member>
 177               <member>lprng</member>
 178               <member>other</member>
 179               <member>none</member>
 180             </simplelist>
 181             (multiple values can be specified, separated by ':', the first active spooler will be chosen).
 182             The default value is platform-specific and can be obtained via
 183             <programlisting>Xprt -h</programlisting>.
 184           </para>
 185         </listitem>
 186       </varlistentry>
 187     </variablelist>
 188   </refsect1>
 189
 190   <refsect1>
 191     <title>ENVIRONMENT</title>
 192     <para>
 193       The following environment variables are recognized by the X print server
 194       (environment variables recognized by Xprint clients are described in
 195       <citerefentry><refentrytitle>Xprint</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry>):
 196
 197       <variablelist>
 198         <varlistentry>
 199           <term><envar>${XPCONFIGDIR}</envar></term>
 200           <listitem>
 201             <para> This environment variable points to the  root
 202               of  the Xprint server configuration directory hierarchy.
 203               If the variable is not defined,  the  default
 204               path  is be assumed.  The default path may be
 205               <filename>/usr/X11R6/lib/X11/xserver/</filename>,
 206               <filename>/usr/lib/X11/xserver/</filename>,
 207               <filename>/usr/share/Xprint/xserver/</filename> or
 208               <filename>/usr/openwin/server/etc/XpConfig</filename>, depending on the
 209               system, and may be configured in <filename>/etc/init.d/xprint</filename>.</para>
 210           </listitem>
 211         </varlistentry>
 212
 213         <varlistentry>
 214           <term><envar>${LANG}</envar></term>
 215           <listitem>
 216             <para>
 217               This environment variable selects the locale settings used by the Xprint server.
 218               Xprt allows language-specific settings (stored in <filename>${XPCONFIGDIR}/${LANG}/print/</filename>)
 219               which will override the default settings (stored in <filename>${XPCONFIGDIR}/C/print/</filename>).
 220               If <envar>${LANG}</envar> is not set "C" is assumed.
 221             </para>
 222           </listitem>
 223         </varlistentry>
 224       </variablelist>
 225     </para>
 226   </refsect1>
 227
 228   <refsect1>
 229     <title>FILES</title>
 230
 231     <variablelist>
 232       <varlistentry>
 233         <term><filename>${XPCONFIGDIR}/${LANG}/print/Xprinters</filename></term>
 234         <term><filename>${XPCONFIGDIR}/C/print/Xprinters</filename></term>
 235         <listitem>
 236           <para>
 237             `Xprinters' is the top most configuration file.  It tells
 238             Xprt which specific printer names (e.g.  mylaser) should
 239             be supported, and whether <citerefentry><refentrytitle>lpstat</refentrytitle><manvolnum>1</manvolnum></citerefentry> or other commands
 240             should be used to automatically supplement the list of
 241             printers.
 242           </para>
 243         </listitem>
 244       </varlistentry>
 245
 246       <varlistentry>
 247         <term><filename>${XPCONFIGDIR}/${LANG}/print/attributes/printer</filename></term>
 248         <term><filename>${XPCONFIGDIR}/C/print/attributes/printer</filename></term>
 249         <listitem>
 250           <para>
 251             The `printer' file maps printer names to model
 252             configurations (see `model-config' below).  For example,
 253             "mylaser" could be mapped to a "HPDJ1600C", and all other
 254             arbitrary printers could be mapped to a default, such as
 255             "HPLJ4SI".  When depending on <citerefentry><refentrytitle>lpstat</refentrytitle><manvolnum>1</manvolnum></citerefentry> in the Xprinters
 256             file, setting up defaults in `printer' becomes all the
 257             more important.
 258           </para>
 259         </listitem>
 260       </varlistentry>
 261
 262       <varlistentry>
 263         <term><filename>${XPCONFIGDIR}/${LANG}/print/attributes/document</filename></term>
 264         <term><filename>${XPCONFIGDIR}/C/print/attributes/document</filename></term>
 265         <listitem>
 266           <para>
 267             The `document' file specifies the initial document values
 268             for any print jobs.  For example, which paper tray to
 269             use, what default resolution, etc.
 270           </para>
 271         </listitem>
 272       </varlistentry>
 273
 274       <varlistentry>
 275         <term><filename>${XPCONFIGDIR}/${LANG}/print/attributes/job</filename></term>
 276         <term><filename>${XPCONFIGDIR}/C/print/attributes/job</filename></term>
 277         <listitem>
 278           <para>
 279             The `job' file specifies the initial job values for any
 280             print jobs.  For example, "notification-profile" can be
 281             set so that when a print job is successfully sent to a
 282             printer, e-mail is sent to the user.
 283           </para>
 284         </listitem>
 285       </varlistentry>
 286
 287       <varlistentry>
 288         <term><filename>${XPCONFIGDIR}/C/print/models/PSdefault/model-config</filename></term>
 289         <term><filename>${XPCONFIGDIR}/C/print/models/PSdefault/fonts/fonts.dir</filename></term>
 290         <term><filename>${XPCONFIGDIR}/C/print/models/PSdefault/fonts/9nb00051.pmf</filename></term>
 291         <term><filename>${XPCONFIGDIR}/C/print/models/PSdefault/fonts/9nb00093.pmf</filename></term>
 292
 293         <listitem>
 294           <para>
 295             The `model-config' file has attributes that describe the
 296             printer model's capabilities and default settings.
 297             Printer model fonts may also be present.  The model-config
 298             file also identifies the print ddx driver to be used.
 299
 300             For each printer model supported, a complete hierarchy of
 301             files should exist.  In most cases, these files do not
 302             need to be modified.
 303           </para>
 304         </listitem>
 305       </varlistentry>
 306
 307       <varlistentry>
 308         <term><filename>${XPCONFIGDIR}/C/print/ddx-config/raster/pdf</filename></term>
 309         <term><filename>${XPCONFIGDIR}/C/print/ddx-config/raster/pcl</filename></term>
 310         <term><filename>${XPCONFIGDIR}/C/print/ddx-config/raster/postscript</filename></term>
 311
 312         <listitem>
 313           <para>
 314             The print ddx drivers can have highly specific
 315             configuration files to control their behavior.  In most
 316             cases, these files do not need to be modified.
 317           </para>
 318         </listitem>
 319       </varlistentry>
 320
 321     </variablelist>
 322   </refsect1>
 323
 324   <refsect1>
 325     <title>SEE ALSO</title>
 326     <para>
 327       <simplelist type="inline">
 328         <!-- specific references -->
 329         <!-- none -->
 330
 331         <!-- Xprint general references -->
 332         <member><citerefentry><refentrytitle>Xprint</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry></member>
 333         <member><citerefentry><refentrytitle>X11</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry></member>
 334         <member><citerefentry><refentrytitle>xplsprinters</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 335         <member><citerefentry><refentrytitle>xprehashprinterlist</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 336         <member><citerefentry><refentrytitle>xphelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 337         <member><citerefentry><refentrytitle>xpxmhelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 338         <member><citerefentry><refentrytitle>xpawhelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 339         <member><citerefentry><refentrytitle>xpxthelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 340         <member><citerefentry><refentrytitle>xpsimplehelloworld</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 341         <member><citerefentry><refentrytitle>Xserver</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 342 <!--
 343         <member><citerefentry><refentrytitle>Xprt</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
 344 -->
 345         <!-- ToDO: Add manual pages for the single Xprint DDX implementations (PostScript/PDF/PCL/PCL-MONO/Raster/etc.) -->
 346         <member><citerefentry><refentrytitle>libXp</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
 347         <member><citerefentry><refentrytitle>libXprintUtils</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
 348         <member><citerefentry><refentrytitle>libXprintAppUtils</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
 349         <member><citerefentry><refentrytitle>XmPrintShell</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
 350         <member><citerefentry><refentrytitle>XawPrintShell</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
 351         <member>Xprint FAQ (<ulink url="http://xprint.mozdev.org/docs/Xprint_FAQ.html">http://xprint.mozdev.org/docs/Xprint_FAQ.html</ulink>)</member>
 352         <member>Xprint main site (<ulink url="http://xprint.mozdev.org/">http://xprint.mozdev.org/</ulink>)</member>
 353       </simplelist>
 354     </para>
 355   </refsect1>
 356
 357   <refsect1>
 358     <title>AUTHORS</title>
 359     <para>
 360       This manual page was written by
 361       Drew Parsons <email>dparsons@debian.org</email> and
 362       Roland Mainz <email>roland.mainz@nrubsig.org</email>,
 363       with some help from the man page at
 364       <ulink url="http://www.sins.com.au/unix/manpages/Xprt.html">http://www.sins.com.au/unix/manpages/Xprt.html</ulink> and the XFree86
 365       man page for <citerefentry><refentrytitle>Xserver</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 366     </para>
 367   </refsect1>
 368 </refentry>
 369
 370
 371