~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs-xml/smbdotconf/printing/addprintercommand.xml

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<samba:parameter name="addprinter command"
 
2
                 context="G"
 
3
                                 type="string"
 
4
                 advanced="1" developer="1"
 
5
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 
6
<description>
 
7
    <para>With the introduction of MS-RPC based printing
 
8
    support for Windows NT/2000 clients in Samba 2.2, The MS Add
 
9
    Printer Wizard (APW) icon is now also available in the 
 
10
    &quot;Printers...&quot; folder displayed a share listing.  The APW
 
11
    allows for printers to be add remotely to a Samba or Windows 
 
12
    NT/2000 print server.</para>
 
13
                
 
14
    <para>For a Samba host this means that the printer must be 
 
15
    physically added to the underlying printing system.
 
16
    The <parameter moreinfo="none">addprinter command</parameter>
 
17
    defines a script to be run which
 
18
    will perform the necessary operations for adding the printer
 
19
    to the print system and to add the appropriate service definition 
 
20
    to the  <filename moreinfo="none">smb.conf</filename> file in order that it can be 
 
21
    shared by <citerefentry><refentrytitle>smbd</refentrytitle>
 
22
    <manvolnum>8</manvolnum></citerefentry>.</para>
 
23
                
 
24
    <para>The <parameter moreinfo="none">addprinter command</parameter> is
 
25
    automatically invoked with the following parameter (in 
 
26
    order):</para>
 
27
                
 
28
    <itemizedlist>
 
29
        <listitem><para><parameter moreinfo="none">printer name</parameter></para></listitem>
 
30
        <listitem><para><parameter moreinfo="none">share name</parameter></para></listitem>
 
31
        <listitem><para><parameter moreinfo="none">port name</parameter></para></listitem>
 
32
        <listitem><para><parameter moreinfo="none">driver name</parameter></para></listitem>
 
33
        <listitem><para><parameter moreinfo="none">location</parameter></para></listitem>
 
34
        <listitem><para><parameter moreinfo="none">Windows 9x driver location</parameter></para></listitem>
 
35
    </itemizedlist>
 
36
                
 
37
    <para>All parameters are filled in from the PRINTER_INFO_2 structure sent 
 
38
    by the Windows NT/2000 client with one exception.  The &quot;Windows 9x
 
39
    driver location&quot; parameter is included for backwards compatibility
 
40
    only.  The remaining fields in the structure are generated from answers
 
41
    to the APW questions.</para>
 
42
 
 
43
    <para>Once the <parameter moreinfo="none">addprinter command</parameter> has 
 
44
    been executed, <command moreinfo="none">smbd</command> will reparse the <filename moreinfo="none">
 
45
    smb.conf</filename> to determine if the share defined by the APW
 
46
    exists.  If the sharename is still invalid, then <command moreinfo="none">smbd
 
47
    </command> will return an ACCESS_DENIED error to the client.</para>
 
48
 
 
49
    <para>
 
50
    The <parameter moreinfo="none">addprinter command</parameter> program
 
51
    can output a single line of text,
 
52
    which Samba will set as the port the new printer is connected to. 
 
53
    If this line isn't output, Samba won't reload its printer shares.
 
54
    </para>
 
55
                
 
56
</description>
 
57
 
 
58
<related>deleteprinter command</related>
 
59
<related>printing</related>
 
60
<related>show add printer wizard</related>
 
61
 
 
62
<value type="default"></value>
 
63
<value type="example">/usr/bin/addprinter</value>
 
64
</samba:parameter>