Next update of VFS modules development guide
[bbaumbach/samba-autobuild/.git] / docs-xml / smbdotconf / printing / lprmcommand.xml
1 <samba:parameter name="lprm 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 delete a print job.</para>
9
10     <para>This command should be a program or script which takes 
11     a printer name and job number, and deletes the print job.</para>
12
13     <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
14     is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with 
15     the job number (an integer).</para>
16
17     <para>Note that it is good practice to include the absolute 
18     path in the <parameter moreinfo="none">lprm command</parameter> as the PATH may not be 
19     available to the server.</para>
20
21         <para>
22         Examples of use are:
23 <programlisting>
24 lprm command = /usr/bin/lprm -P%p %j
25
26 or
27
28 lprm command = /usr/bin/cancel %p-%j
29 </programlisting>
30         </para>
31
32 </description>
33 <related>printing</related>
34
35 <value type="default"> determined by printing parameter</value>
36 </samba:parameter>