man/man5/papd.conf.5.tmpl

   1 .TH papd.conf 5 "06 Sep 2004" 2.0.0 Netatalk
   2 .SH NAME
   3 papd.conf \- Configuration file used by papd(8) to determine the configuration of printers used by the Netatalk printing daemon
   4 .SH DESCRIPTION
   5 \fI:ETCDIR:/papd.conf\fR is the
   6 configuration file used by papd to configure the printing services offered
   7 by netatalk. Please note that papd must be enabled in \fI:ETCDIR:/netatalk.conf\fR for this to take any effect.
   8 \fIpapd\fR shares the same defaults as lpd on
   9 many systems, but not Solaris.
  10 .PP
  11 Any line not prefixed with \fI#\fR is
  12 interpreted. The configuration lines are composed like:
  13 .PP
  14 \fIprintername:[options]\fR
  15 .PP
  16 On systems running a System V printing system the simplest case is
  17 to have either no papd.conf, or to have one that has no active lines. In
  18 this case, atalkd should auto\-discover the local printers on the machine.
  19 Please note that you can split lines by using \fI\\\\fR.\fR
  20 .PP
  21 printername may be just a name (\fIPrinter
  22 1\fR), or it may be a full name in nbp_name format (\fIPrinter 1:LaserWriter@My Zone\fR).
  23 .PP
  24 Systems using a BSD printing system should make use of a pipe to the
  25 printing command in question within the \fIpr\fR
  26 option (eg. \fIpr=|/usr/bin/lpr \-J%J \-u%U\fR).
  27 Note: When printing using a pipe, papd recognizes several wildcards: %F
  28 will be replaced by the name present in the "%%For:" comment in the
  29 PostScript stream, same with %J for the "%%Title:" comment. %U will be
  30 substituted with the login name (the latter applies only when
  31 authenticated printing is in effect).
  32 .PP
  33 When CUPS support is compiled in, then \fIcupsautoadd \fRas the first entry in papd.conf will
  34 automagically share all CUPS printers by papd utilizing the PPDs assigned
  35 in CUPS (customizable \-\- see below). This can be overwritten for individal
  36 printers by subsequently adding individual entries using the CUPS queue
  37 name as \fIpr \fRentry. Note: CUPS support is
  38 mutually exclusive with System V support described above.
  39 .PP
  40 The possible options are colon delimited (\fI:\fR), and lines must be terminated with colons. The
  41 possible options and flags are:
  42 .TP
  43 \fIam=(uams list)\fR
  44 The \fIam\fR option allows specific
  45 UAMs to be specified for a particular printer. It has no effect if
  46 the \fIau\fR flag is not present or if papd
  47 authentication was not built into netatalk. Note: possible values
  48 are \fIuams_guest.so\fR and \fIuams_clrtxt.so\fR only. The first method requires
  49 a valid username, but no password. The second requires both a valid
  50 username and the correct password.
  51 .TP
  52 \fIau\fR
  53 If present, this flag enables authentication for the printer.
  54 Please note that papd authentication must be built into netatalk for
  55 this to take effect.
  56 .TP
  57 \fIco=(CUPS options)\fR
  58 The \fIco\fR option allows options to
  59 be passed through to CUPS (eg. \fIco="protocol=TBCP" \fRor \fIco="raw"\fR).
  60 .TP
  61 \fIcupsautoadd[:type][@zone]\fR
  62 If used as the first entry in papd.conf this will share all
  63 CUPS printers via papd. type/zone settings as well as other
  64 parameters assigned to this special printer share will apply to all
  65 CUPS printers. Unless the \fIpd\fR option
  66 is set, the CUPS PPDs will be used. To overwrite these global
  67 settings for individual printers simply add them subsequently to
  68 papd.conf and assign different settings.
  69 .TP
  70 \fIfo\fR
  71 If present, this flag enables a hack to translate line endings
  72 originating from pre Mac OS X LaserWriter drivers to let \fIfoomatic\-rip\fR recognize foomatic PPD options set
  73 in the printer dialog. Attention: Use with caution since this might
  74 corrupt binary print jobs!
  75 .TP
  76 \fIop=(operator)\fR
  77 This specifies the operator name, for lpd spooling.
  78 .TP
  79 \fIpa=(appletalk address)\fR
  80 Allows specification of Appletalk addresses. Usually not
  81 needed.
  82 .TP
  83 \fIpd=(path to ppd file)\fR
  84 Specifies a particular PPD (printer description file) to
  85 associate with the selected printer.
  86 .TP
  87 \fIpr=(lpd/CUPS printer name or pipe command)\fR
  88 Sets the \fIlpd\fR or \fICUPS\fR printer that this is spooled to.
  89 .SH EXAMPLES
  90 Unless CUPS support has been compiled in (which is default from
  91 Netatalk 2.0 on) one simply defines the lpd queue in question by setting
  92 the \fBpr\fR parameter to the queue name, in the following
  93 example "ps". If no \fBpr\fR parameter is set, the default
  94 printer will be used.
  95 .PP
  96 \fBpapd.conf System V printing system examples\fR
  97 .PP
  98 The first spooler is known by the AppleTalk name Mac Printer
  99 Spooler, and uses a PPD file located in
 100 \fB/usr/share/lib/ppd\fR. In addition, the user mcs will
 101 be the owner of all jobs that are spooled. The second spooler is known
 102 as HP Printer and all options are the default.
 103
 104 .nf
 105 Mac Printer Spooler:\\
 106    :pr=ps:\\
 107    :pd=/usr/share/lib/ppd/HPLJ_4M.PPD:\\
 108    :op=mcs:
 109
 110 HP Printer:\\
 111    :
 112 .fi
 113 .PP
 114 An alternative to the technique outlined above is to direct papd's
 115 output via a pipe into another program. Using this mechanism almost all
 116 printing systems can be driven. Netatalk supplies three "wildcards" that
 117 get substituted with values of the already printed job:
 118 \fB%F\fR, \fB%U\fR and \fB%J\fR. Using
 119 these wildcards, one can pass those parameters directly to programs or
 120 implement small wrapper scripts to call the printing system in
 121 question.
 122 .PP
 123 \fBpapd.conf examples using pipes\fR
 124 .PP
 125 The first spooler is known as HP 8100. It pipes the print job to
 126 /usr/bin/lpr for printing using the value of the
 127 \fI%%Title: \fRcomment as job name. PSSP authenticated
 128 printing is enabled, as is CAP\-style authenticated printing. Both
 129 methods support guest and cleartext authentication as specified by the
 130 \&'\fBam\fR' option. The PPD used is
 131 \fB/etc/atalk/ppds/hp8100.ppd\fR. The second spooler is
 132 called "Dump PostScript" and uses a pipe to cat to
 133 send the raw PostScript code into the user's home directory into a file
 134 called like the printjob.
 135
 136 .nf
 137 HP 8100:\\
 138    :pr=|/usr/bin/lpr \-Plp \-J"%J":\\
 139    :sp:\\
 140    :ca=/tmp/print:\\
 141    :am=uams_guest.so,uams_pam.so:\\
 142    :pd=/etc/atalk/ppds/hp8100.ppd:
 143
 144 Dump PostScript:LaserWriter@Server:\\
 145    :pr=|cat >/home/%U/%J\-prn.out:\\
 146    :pd=/usr/share/lib/ppd/mooralana.ppd:\\
 147    :sp:au:op=lp:\\
 148    :am=uams_clrtxt.so:
 149 .fi
 150 .PP
 151 Starting with Netatalk 2.0 direct CUPS integration is available. In
 152 this case, defining only a queue name as \fBpr\fR parameter
 153 won't invoke the SysV lpd daemon but uses CUPS instead. Unless a specific
 154 PPD has been assigned using the \fBpd\fR switch, the PPD
 155 configured in CUPS will be used by papd, too.
 156 .PP
 157 There exists one special share named "cupsautoadd". If this is
 158 present as the first entry then all available CUPS queues will be served
 159 automagically using the parameters assigned to this global share. But
 160 subsequent printer definitions can be used to override these global
 161 settings for individual spoolers.
 162 .PP
 163 \fBpapd.conf CUPS examples\fR
 164 .PP
 165 The first entry sets up automatic sharing of all CUPS printers.
 166 All those shares appear in the zone "1st floor" and since no additional
 167 settings have been made, they use the CUPS printer name as NBP name and
 168 use the PPD configured in CUPS. The second entry defines different
 169 settings for one single CUPS printer. It's NBP name is differing from
 170 the printer's name and the registration happens in another zone.
 171
 172 .nf
 173 cupsautoadd@1st floor:op=root:
 174
 175 Boss' LaserWriter@2nd floor:\\
 176    :pr=laserwriter\-chief:
 177 .fi
 178 .SH "SEE ALSO"
 179 \fBpapd\fR(8), \fBatalkd.conf\fR(5), \fBlpd\fR(8), \fBlpoptions\fR(8)
 180