summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/printing/lppausecommand.xml
blob: 34d7c7f800fdad2053f19888177980e56e61e289 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<samba:parameter xmlns:samba="http://samba.org/common">
		<term><anchor id="LPPAUSECOMMAND"/>lppause command (S)</term>
		<listitem><para>This parameter specifies the command to be 
		executed on the server host in order to stop printing or spooling 
		a specific print job.</para>

		<para>This command should be a program or script which takes 
		a printer name and job number to pause the print job. One way 
		of implementing this is by using job priorities, where jobs 
		having a too low priority won't be sent to the printer.</para>

		<para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
		is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with 
		the job number (an integer).  On HPUX (see <parameter moreinfo="none">printing=hpux
		</parameter>), if the <parameter moreinfo="none">-p%p</parameter> option is added 
		to the lpq command, the job will show up with the correct status, i.e. 
		if the job priority is lower than the set fence priority it will 
		have the PAUSED status, whereas if  the priority is equal or higher it 
		will have the SPOOLED or PRINTING status.</para>

		<para>Note that it is good practice to include the absolute path 
		in the lppause command as the PATH may not be available to the server.</para>

		<para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing
		</parameter></link> parameter.</para>

		<para>Default: Currently no default value is given to 
		this string, unless the value of the <parameter moreinfo="none">printing</parameter> 
		parameter is <constant>SYSV</constant>, in which case the default is :</para>

		<para><command moreinfo="none">lp -i %p-%j -H hold</command></para>

		<para>or if the value of the <parameter moreinfo="none">printing</parameter> parameter 
		is <constant>SOFTQ</constant>, then the default is:</para>

		<para><command moreinfo="none">qstat -s -j%j -h</command></para>
 
		<para>Example for HPUX: <command moreinfo="none">lppause command = /usr/bin/lpalt 	
		%p-%j -p0</command></para>
		</listitem>
		</samba:parameter>