Add new framework for smb.conf(5). Please read README before trying to compile.
[Samba/gebeck_regimport.git] / docs / docbook / smbdotconf / printing / lppausecommand.xml
blob34d7c7f800fdad2053f19888177980e56e61e289
1 <samba:parameter xmlns:samba="http://samba.org/common">
2                 <term><anchor id="LPPAUSECOMMAND"/>lppause command (S)</term>
3                 <listitem><para>This parameter specifies the command to be 
4                 executed on the server host in order to stop printing or spooling 
5                 a specific print job.</para>
7                 <para>This command should be a program or script which takes 
8                 a printer name and job number to pause the print job. One way 
9                 of implementing this is by using job priorities, where jobs 
10                 having a too low priority won't be sent to the printer.</para>
12                 <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
13                 is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with 
14                 the job number (an integer).  On HPUX (see <parameter moreinfo="none">printing=hpux
15                 </parameter>), if the <parameter moreinfo="none">-p%p</parameter> option is added 
16                 to the lpq command, the job will show up with the correct status, i.e. 
17                 if the job priority is lower than the set fence priority it will 
18                 have the PAUSED status, whereas if  the priority is equal or higher it 
19                 will have the SPOOLED or PRINTING status.</para>
21                 <para>Note that it is good practice to include the absolute path 
22                 in the lppause command as the PATH may not be available to the server.</para>
24                 <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing
25                 </parameter></link> parameter.</para>
27                 <para>Default: Currently no default value is given to 
28                 this string, unless the value of the <parameter moreinfo="none">printing</parameter> 
29                 parameter is <constant>SYSV</constant>, in which case the default is :</para>
31                 <para><command moreinfo="none">lp -i %p-%j -H hold</command></para>
33                 <para>or if the value of the <parameter moreinfo="none">printing</parameter> parameter 
34                 is <constant>SOFTQ</constant>, then the default is:</para>
36                 <para><command moreinfo="none">qstat -s -j%j -h</command></para>
38                 <para>Example for HPUX: <command moreinfo="none">lppause command = /usr/bin/lpalt       
39                 %p-%j -p0</command></para>
40                 </listitem>
41                 </samba:parameter>