xorg-server-1.4/hw/xprint/doc/Xprt.man.pre

   1 .\" -*- coding: us-ascii -*-
   2 .TH Xprt __appmansuffix__ "25 November 2004"
   3 .SH NAME
   4 Xprt \- Print server for X Version 11
   5 .SH SYNOPSIS
   6 .ad l
   7 \fBXprt\fR \kx
   8 .if (\nxu > (\n(.lu / 2)) .nr x (\n(.lu / 5)
   9 'in \n(.iu+\nxu
  10 [\fB\-ac\fR] [\fB\-audit \fBlevel\fR\fR] [\fB\-pn\fR] [\fB\-fp \fBfontpath\fR\fR] [\fB\-XpFile \fBfile\fR\fR] [\fB\-XpSpoolerType \fBspoolername\fR\fR] [\fB:\fBdisplay\fR\fR]
  11 'in \n(.iu-\nxu
  12 .ad b
  13 .SH DESCRIPTION
  14 Xprt is the Xprint print server
  15 for version 11 of the X Window system for non display devices
  16 such as printers and fax machines.
  17 .PP
  18 Xprint is an advanced printing system which enables X11
  19 applications to use devices like printers, FAX or create
  20 documents in formats like PostScript, PCL or PDF. It may be used by
  21 clients such as mozilla.
  22 .PP
  23 Xprint is a very flexible, extensible, scalable, client/server
  24 print system based on ISO 10175 (and some other specs) and the X11
  25 rendering protocol.
  26 Using Xprint an application can search, query and use devices like
  27 printers, FAX machines or create documents in formats like PDF.
  28 In particular, an application can seek a printer, query supported
  29 attributes (like paper size, trays, fonts etc.), configure the printer
  30 device to match it's needs and print on it like on any other X device
  31 reusing parts of the code which is used for the video card Xserver.
  32 .SH USAGE
  33 Although Xprt may be invoked from the command line, it is
  34 preferable to run it as a daemon via the init script
  35 \fB/etc/init.d/xprint\fR (where this script exists).
  36 .PP
  37 Client programs such as mozilla will require environment
  38 variable \fB${XPSERVERLIST}\fR to be set, identifying the
  39 "display" on which Xprt is running. This variable may be set
  40 for all users via \fB/etc/profile\fR (or similar), using
  41 \fB/etc/init.d/xprint get_xpserverlist\fR:
  42
  43 .nf
  44 export XPSERVERLIST=`/etc/init.d/xprint get_xpserverlist`
  45 .fi
  46
  47 .SH OPTIONS
  48 Many of Xprt's command line options are shared in common
  49 with the usual X servers (see \fBXserver\fR(__appmansuffix__)).
  50 Commonly used options include:
  51 .TP
  52 \fB:\fIdisplay\fB\fR
  53 The X server runs on the given display. If multiple X
  54 servers are to run simultaneously on a host, each must
  55 have a unique display number. Note that the standard X
  56 server (for video displays) typically runs on display
  57 :0. If \fB/etc/init.d/xprint\fR is used
  58 to invoke Xprt, it may be configured to automatically assign an available
  59 display number.
  60 .TP
  61 \fB\-ac\fR
  62 disables host-based access control mechanisms. Enables access
  63 by any host, and permits any host to modify the access control
  64 list. Use with extreme caution. This option exists primarily
  65 for running test suites remotely.
  66 .TP
  67 \fB\-audit \fIlevel\fB\fR
  68 sets the audit trail level. The default level is 1, meaning
  69 only connection rejections are reported. Level 2 additionally
  70 reports all successful connections and disconnects. Level 4
  71 enables messages from the SECURITY extension, if present,
  72 including generation and revocation of authorizations and
  73 violations of the security policy. Level 0 turns off the audit
  74 trail. Audit lines are sent as standard error output.
  75 .TP
  76 \fB\-fp \fIfontpath\fB\fR
  77 sets the search path for fonts. This path is a comma
  78 separated list of directories which Xprt searches for
  79 font databases.
  80 .TP
  81 \fB\-pn\fR
  82 permits the server to continue running if it fails to
  83 establish all of its well-known sockets (connection
  84 points for clients), but establishes at least
  85 one.
  86 .TP
  87 \fB\-XpFile \fIfile\fB\fR
  88 Sets an alternate Xprinters file (see section FILES).
  89 .TP
  90 \fB\-XpSpoolerType \fIspoolername\fB\fR
  91 Defines the spooler system to be used for print job spooling.
  92 Supported values in xprint.mozdev.org release 009 are:
  93
  94 aix
  95
  96 aix4
  97
  98 bsd
  99
 100 osf
 101
 102 solaris
 103
 104 sysv
 105
 106 uxp
 107
 108 cups
 109
 110 lprng
 111
 112 other
 113
 114 none
 115
 116 (multiple values can be specified, separated by ':', the first active spooler will be chosen).
 117 The default value is platform-specific and can be obtained via
 118
 119 .nf
 120 Xprt \-h
 121 .fi
 122
 123 \&.
 124 .SH ENVIRONMENT
 125 The following environment variables are recognized by the X print server
 126 (environment variables recognized by Xprint clients are described in
 127 \fBXprint\fR(__miscmansuffix__)):
 128 .TP
 129 \fB${XPCONFIGDIR}\fR
 130 This environment variable points to the root
 131 of the Xprint server configuration directory hierarchy.
 132 If the variable is not defined, the default
 133 path is be assumed. The default path may be
 134 \fB/usr/X11R6/lib/X11/xserver/\fR,
 135 \fB/usr/lib/X11/xserver/\fR,
 136 \fB/usr/share/Xprint/xserver/\fR or
 137 \fB/usr/openwin/server/etc/XpConfig\fR, depending on the
 138 system, and may be configured in \fB/etc/init.d/xprint\fR.
 139 .TP
 140 \fB${LANG}\fR
 141 This environment variable selects the locale settings used by the Xprint server.
 142 Xprt allows language-specific settings (stored in \fB${XPCONFIGDIR}/${LANG}/print/\fR)
 143 which will override the default settings (stored in \fB${XPCONFIGDIR}/C/print/\fR).
 144 If \fB${LANG}\fR is not set "C" is assumed.
 145 .PP
 146 .SH FILES
 147 .TP
 148 \fB${XPCONFIGDIR}/${LANG}/print/Xprinters\fR, \fB${XPCONFIGDIR}/C/print/Xprinters\fR
 149 `Xprinters' is the top most configuration file. It tells
 150 Xprt which specific printer names (e.g. mylaser) should
 151 be supported, and whether \fBlpstat\fR(1) or other commands
 152 should be used to automatically supplement the list of
 153 printers.
 154 .TP
 155 \fB${XPCONFIGDIR}/${LANG}/print/attributes/printer\fR, \fB${XPCONFIGDIR}/C/print/attributes/printer\fR
 156 The `printer' file maps printer names to model
 157 configurations (see `model-config' below). For example,
 158 "mylaser" could be mapped to a "HPDJ1600C", and all other
 159 arbitrary printers could be mapped to a default, such as
 160 "HPLJ4SI". When depending on \fBlpstat\fR(1) in the Xprinters
 161 file, setting up defaults in `printer' becomes all the
 162 more important.
 163 .TP
 164 \fB${XPCONFIGDIR}/${LANG}/print/attributes/document\fR, \fB${XPCONFIGDIR}/C/print/attributes/document\fR
 165 The `document' file specifies the initial document values
 166 for any print jobs. For example, which paper tray to
 167 use, what default resolution, etc.
 168 .TP
 169 \fB${XPCONFIGDIR}/${LANG}/print/attributes/job\fR, \fB${XPCONFIGDIR}/C/print/attributes/job\fR
 170 The `job' file specifies the initial job values for any
 171 print jobs. For example, "notification-profile" can be
 172 set so that when a print job is successfully sent to a
 173 printer, e-mail is sent to the user.
 174 .TP
 175 \fB${XPCONFIGDIR}/C/print/models/PSdefault/model\-config\fR, \fB${XPCONFIGDIR}/C/print/models/PSdefault/fonts/fonts.dir\fR, \fB${XPCONFIGDIR}/C/print/models/PSdefault/fonts/9nb00051.pmf\fR, \fB${XPCONFIGDIR}/C/print/models/PSdefault/fonts/9nb00093.pmf\fR
 176 The `model-config' file has attributes that describe the
 177 printer model's capabilities and default settings.
 178 Printer model fonts may also be present. The model-config
 179 file also identifies the print ddx driver to be used.
 180 For each printer model supported, a complete hierarchy of
 181 files should exist. In most cases, these files do not
 182 need to be modified.
 183 .TP
 184 \fB${XPCONFIGDIR}/C/print/ddx\-config/raster/pdf\fR, \fB${XPCONFIGDIR}/C/print/ddx\-config/raster/pcl\fR, \fB${XPCONFIGDIR}/C/print/ddx\-config/raster/postscript\fR
 185 The print ddx drivers can have highly specific
 186 configuration files to control their behavior. In most
 187 cases, these files do not need to be modified.
 188 .SH "SEE ALSO"
 189 \fBXprint\fR(__miscmansuffix__), \fBX11\fR(__miscmansuffix__), \fBxplsprinters\fR(__appmansuffix__), \fBxprehashprinterlist\fR(__appmansuffix__), \fBxphelloworld\fR(__appmansuffix__), \fBxpxmhelloworld\fR(__appmansuffix__), \fBxpawhelloworld\fR(__appmansuffix__), \fBxpxthelloworld\fR(__appmansuffix__), \fBxpsimplehelloworld\fR(__appmansuffix__), \fBXserver\fR(__appmansuffix__), \fBlibXp\fR(__libmansuffix__), \fBlibXprintUtils\fR(__libmansuffix__), \fBlibXprintAppUtils\fR(__libmansuffix__), \fBXmPrintShell\fR(__libmansuffix__), \fBXawPrintShell\fR(__libmansuffix__), Xprint FAQ (http://xprint.mozdev.org/docs/Xprint_FAQ.html), Xprint main site (http://xprint.mozdev.org/)
 190 .SH AUTHORS
 191 This manual page was written by
 192 Drew Parsons <dparsons@debian.org> and
 193 Roland Mainz <roland.mainz@nrubsig.org>,
 194 with some help from the man page at
 195 http://www.sins.com.au/unix/manpages/Xprt.html and the XFree86
 196 man page for \fBXserver\fR(1).