summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/printing/addprintercommand.xml
blob: 63b3f567b1b9b7ff61d8d7a0d2c57b5416519a91 (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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<samba:parameter name="addprinter command"
                 context="G"
		 advanced="1" developer="1"
                 xmlns:samba="http://samba.org/common">
<listitem>
    <para>With the introduction of MS-RPC based printing
    support for Windows NT/2000 clients in Samba 2.2, The MS Add
    Printer Wizard (APW) icon is now also available in the 
    &quot;Printers...&quot; folder displayed a share listing.  The APW
    allows for printers to be add remotely to a Samba or Windows 
    NT/2000 print server.</para>
		
    <para>For a Samba host this means that the printer must be 
    physically added to the underlying printing system.  The <parameter moreinfo="none">add 
    printer command</parameter> defines a script to be run which 
    will perform the necessary operations for adding the printer
    to the print system and to add the appropriate service definition 
    to the  <filename moreinfo="none">smb.conf</filename> file in order that it can be 
    shared by <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry>.</para>
		
    <para>The <parameter moreinfo="none">addprinter command</parameter> is
    automatically invoked with the following parameter (in 
    order):</para>
		
    <itemizedlist>
	<listitem><para><parameter moreinfo="none">printer name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">share name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">port name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">driver name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">location</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">Windows 9x driver location</parameter></para></listitem>
    </itemizedlist>
		
    <para>All parameters are filled in from the PRINTER_INFO_2 structure sent 
    by the Windows NT/2000 client with one exception.  The &quot;Windows 9x
    driver location&quot; parameter is included for backwards compatibility
    only.  The remaining fields in the structure are generated from answers
    to the APW questions.</para>

    <para>Once the <parameter moreinfo="none">addprinter command</parameter> has 
    been executed, <command moreinfo="none">smbd</command> will reparse the <filename moreinfo="none">
    smb.conf</filename> to determine if the share defined by the APW
    exists.  If the sharename is still invalid, then <command moreinfo="none">smbd
    </command> will return an ACCESS_DENIED error to the client.</para>

    <para>
    The &quot;add printer command&quot; program can output a single line of text,
    which Samba will set as the port the new printer is connected to. 
    If this line isn't output, Samba won't reload its printer shares.
    </para>
		
    <para>See also <link linkend="DELETEPRINTERCOMMAND"><parameter moreinfo="none">
    deleteprinter command</parameter></link>, <link linkend="PRINTING">
    <parameter moreinfo="none">printing</parameter></link>,
    <link linkend="SHOWADDPRINTERWIZARD"><parameter moreinfo="none">show add
    printer wizard</parameter></link></para>
		
    <para>Default: <emphasis>none</emphasis></para>

    <para>Example: <command moreinfo="none">addprinter command = /usr/bin/addprinter</command></para>
</listitem>
</samba:parameter>