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