Next update of VFS modules development guide
[tprouty/samba.git] / docs / smbdotconf / printing / queuepausecommand.xml
1 <samba:parameter name="queuepause 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 pause the printer queue.</para>
9
10     <para>This command should be a program or script which takes 
11     a printer name as its only parameter and stops the printer queue, 
12     such that no longer jobs are submitted to the printer.</para>
13
14     <para>This command is not supported by Windows for Workgroups, 
15     but can be issued from the Printers window under Windows 95 
16     and NT.</para>
17                 
18     <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
19     is put in its place. Otherwise it is placed at the end of the command.
20     </para>
21
22     <para>Note that it is good practice to include the absolute 
23     path in the command as the PATH may not be available to the 
24         server.</para>
25 </description>
26
27 <value type="example">disable %p</value>
28 </samba:parameter>