Next update of VFS modules development guide
[sfrench/samba-autobuild/.git] / docs / smbdotconf / printing / cupsoptions.xml
1 <samba:parameter name="cups options"
2                  context="S"
3                  type="string"
4                  print="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7     <para>
8     This parameter is only applicable if <smbconfoption name="printing"/> is 
9     set to <constant>cups</constant>.  Its value is a free form string of options
10     passed directly to the cups library.  
11     </para>
12
13    <para>
14    You can pass any generic print option known to CUPS (as listed
15    in the CUPS "Software Users' Manual").  You can also pass any printer
16    specific option (as listed in "lpoptions -d printername -l")
17    valid for the target queue.
18    Multiple parameters should be space-delimited name/value pairs according to
19    the PAPI text option ABNF specification. Collection values
20    ("name={a=... b=... c=...}") are stored with the curley brackets intact.
21    </para>
22
23    <para>
24    You should set this parameter to <constant>raw</constant> if your CUPS server 
25    <filename>error_log</filename> file contains messages such as
26    "Unsupported format 'application/octet-stream'" when printing from a Windows client 
27    through Samba.  It is no longer necessary to enable
28    system wide raw printing in <filename>/etc/cups/mime.{convs,types}</filename>.
29    </para>
30
31 </description>
32
33 <value type="default">""</value>
34 <value type="example">"raw media=a4"</value>
35 </samba:parameter>