Merge branch 'master' of ctdb into 'master' of samba
[samba.git] / docs-xml / smbdotconf / printing / lpqcommand.xml
1 <samba:parameter name="lpq command"
2                  context="S"
3                                  type="string"
4                  print="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6  <description>
7     <para>This parameter specifies the command to be 
8     executed on the server host in order to obtain <command moreinfo="none">lpq
9     </command>-style printer status information.</para>
10
11     <para>This command should be a program or script which 
12     takes a printer name as its only parameter and outputs printer 
13     status information.</para>
14
15     <para>Currently nine styles of printer status information 
16     are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. 
17     This covers most UNIX systems. You control which type is expected 
18     using the <parameter moreinfo="none">printing =</parameter> option.</para>
19
20     <para>Some clients (notably Windows for Workgroups) may not 
21     correctly send the connection number for the printer they are 
22     requesting status information about. To get around this, the 
23     server reports on the first printer service connected to by the 
24     client. This only happens if the connection number sent is invalid.</para>
25
26     <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
27     is put in its place. Otherwise it is placed at the end of the 
28     command.</para>
29
30     <para>Note that it is good practice to include the absolute path 
31     in the <parameter moreinfo="none">lpq command</parameter> as the <envar>$PATH
32     </envar> may not be available to the server.  When compiled with
33     the CUPS libraries, no <parameter moreinfo="none">lpq command</parameter> is
34     needed because smbd will make a library call to obtain the 
35         print queue listing.</para>
36 </description>
37
38 <related>printing</related>
39
40 <value type="example">/usr/bin/lpq -P%p</value>
41 <value type="default"></value>
42 </samba:parameter>