summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/printing/lppausecommand.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/printing/lppausecommand.xml')
-rw-r--r--docs/smbdotconf/printing/lppausecommand.xml35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/smbdotconf/printing/lppausecommand.xml b/docs/smbdotconf/printing/lppausecommand.xml
new file mode 100644
index 0000000000..9b2daed3e9
--- /dev/null
+++ b/docs/smbdotconf/printing/lppausecommand.xml
@@ -0,0 +1,35 @@
+<samba:parameter name="lppause command"
+ context="S"
+ type="string"
+ print="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <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>
+</description>
+
+<related>printing</related>
+
+<value type="default"><comment>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 : <command moreinfo="none">lp -i %p-%j -H hold</command> or if the value of the <parameter moreinfo="none">printing</parameter> parameter is <constant>SOFTQ</constant>, then the default is: <command moreinfo="none">qstat -s -j%j -h</command>. </comment></value>
+<value type="example">/usr/bin/lpalt %p-%j -p0</value>
+</samba:parameter>