man pages: "printcap name" is a global parameter, not a share specific one.
[tprouty/samba.git] / docs-xml / smbdotconf / printing / printcapname.xml
1 <samba:parameter name="printcap name"
2         context="G"
3         type="string"
4                  print="1" developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <synonym>printcap</synonym>
7 <description>
8     <para>
9         This parameter may be used to override the compiled-in default printcap name used by the server (usually
10         <filename moreinfo="none"> /etc/printcap</filename>). See the discussion of the <link
11         linkend="PRINTERSSECT">[printers]</link> section above for reasons why you might want to do this.
12         </para>
13
14     <para>
15         To use the CUPS printing interface set <command moreinfo="none">printcap name = cups </command>. This should
16         be supplemented by an addtional setting <smbconfoption name="printing">cups</smbconfoption> in the [global]
17         section.  <command moreinfo="none">printcap name = cups</command> will use the  &quot;dummy&quot; printcap
18         created by CUPS, as specified in your CUPS configuration file.
19     </para>
20
21     <para>
22         On System V systems that use <command moreinfo="none">lpstat</command> to 
23     list available printers you can use <command moreinfo="none">printcap name = lpstat
24     </command> to automatically obtain lists of available printers. This 
25     is the default for systems that define SYSV at configure time in 
26     Samba (this includes most System V based systems). If <parameter moreinfo="none">
27     printcap name</parameter> is set to <command moreinfo="none">lpstat</command> on 
28     these systems then Samba will launch <command moreinfo="none">lpstat -v</command> and 
29     attempt to parse the output to obtain a printer list.
30         </para>
31
32     <para>
33         A minimal printcap file would look something like this:
34 <programlisting format="linespecific">
35 print1|My Printer 1
36 print2|My Printer 2
37 print3|My Printer 3
38 print4|My Printer 4
39 print5|My Printer 5
40 </programlisting>
41     where the '|' separates aliases of a printer. The fact that the second alias has a space in
42         it gives a hint to Samba that it's a comment.
43         </para>
44
45     <note><para>
46         Under AIX the default printcap name is <filename moreinfo="none">/etc/qconfig</filename>. Samba will
47         assume the file is in AIX <filename moreinfo="none">qconfig</filename> format if the string <filename
48         moreinfo="none">qconfig</filename> appears in the printcap filename.
49         </para></note>
50
51 </description>
52         
53 <value type="default">/etc/printcap</value>
54 <value type="example">/etc/myprintcap</value>
55 </samba:parameter>