summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/printing/lprmcommand.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/printing/lprmcommand.xml')
-rw-r--r--docs/smbdotconf/printing/lprmcommand.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/smbdotconf/printing/lprmcommand.xml b/docs/smbdotconf/printing/lprmcommand.xml
new file mode 100644
index 0000000000..508b52775b
--- /dev/null
+++ b/docs/smbdotconf/printing/lprmcommand.xml
@@ -0,0 +1,27 @@
+<samba:parameter name="lprm 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 delete a print job.</para>
+
+ <para>This command should be a program or script which takes
+ a printer name and job number, and deletes the print job.</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).</para>
+
+ <para>Note that it is good practice to include the absolute
+ path in the <parameter moreinfo="none">lprm command</parameter> as the PATH may not be
+ available to the server.</para>
+
+</description>
+<related>printing</related>
+
+<value type="default"><comment>depends on the setting of <parameter moreinfo="none">printing</parameter></comment></value>
+<value type="example">/usr/bin/lprm -P%p %j</value>
+<value type="example">/usr/bin/cancel %p-%j</value>
+</samba:parameter>