docs:smbdotconf: remove swat-specific flags.
[samba.git] / docs-xml / smbdotconf / printing / lppausecommand.xml
1 <samba:parameter name="lppause command"
2                  context="S"
3                                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>This parameter specifies the command to be 
7     executed on the server host in order to stop printing or spooling 
8     a specific print job.</para>
9
10     <para>This command should be a program or script which takes 
11     a printer name and job number to pause the print job. One way 
12     of implementing this is by using job priorities, where jobs 
13     having a too low priority won't be sent to the printer.</para>
14
15     <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
16     is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with 
17     the job number (an integer).  On HPUX (see <parameter moreinfo="none">printing=hpux
18     </parameter>), if the <parameter moreinfo="none">-p%p</parameter> option is added 
19     to the lpq command, the job will show up with the correct status, i.e. 
20     if the job priority is lower than the set fence priority it will 
21     have the PAUSED status, whereas if  the priority is equal or higher it 
22     will have the SPOOLED or PRINTING status.</para>
23
24     <para>Note that it is good practice to include the absolute path 
25     in the lppause command as the PATH may not be available to the server.</para>
26
27     <para>Currently no default value is given to
28     this string, unless the value of the <smbconfoption name="printing"/> 
29     parameter is <constant>SYSV</constant>, in which case the default is : 
30     <command moreinfo="none">lp -i %p-%j -H hold</command> or if the value of the 
31     <parameter moreinfo="none">printing</parameter> parameter is 
32     <constant>SOFTQ</constant>, then the default is: 
33     <command moreinfo="none">qstat -s -j%j -h</command>. </para>
34
35 </description>
36
37 <related>printing</related>
38
39 <value type="default"><comment>determined by printing parameter</comment></value>
40 <value type="example">/usr/bin/lpalt %p-%j -p0</value>
41 </samba:parameter>