This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[samba.git] / docs / docbook / manpages / smbspool.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
3                                   
4 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
5 ]>
6 <refentry id="smbspool.8">
7
8 <refmeta>
9         <refentrytitle>smbspool</refentrytitle>
10         <manvolnum>8</manvolnum>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>smbspool</refname>
16         <refpurpose>send a print file to an SMB printer</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>smbspool</command>
22                 <arg choice="req">job</arg> 
23                 <arg choice="req">user</arg> 
24                 <arg choice="req">title</arg> 
25                 <arg choice="req">copies</arg> 
26                 <arg choice="req">options</arg> 
27                 <arg choice="opt">filename</arg> 
28         </cmdsynopsis>
29 </refsynopsisdiv>
30
31 <refsect1>
32         <title>DESCRIPTION</title>
33
34         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
35         <manvolnum>7</manvolnum></citerefentry> suite.</para>
36
37         <para>smbspool is a very small print spooling program that 
38         sends a print file to an SMB printer. The command-line arguments 
39         are position-dependent for compatibility with the Common UNIX 
40         Printing System, but you can use smbspool with any printing system 
41         or from a program or script.</para>
42
43         <para><emphasis>DEVICE URI</emphasis></para>
44
45         <para>smbspool specifies the destination using a Uniform Resource 
46         Identifier ("URI") with a method of "smb". This string can take 
47         a number of forms:</para>
48
49         <itemizedlist>
50                 <listitem><para>smb://server/printer</para></listitem>
51                 <listitem><para>smb://workgroup/server/printer</para></listitem>
52                 <listitem><para>smb://username:password@server/printer</para></listitem>
53                 <listitem><para>smb://username:password@workgroup/server/printer</para></listitem>
54         </itemizedlist>
55
56         <para>smbspool tries to get the URI from argv[0]. If argv[0] 
57         contains the name of the program then it looks in the <envar>
58         DEVICE_URI</envar> environment variable.</para>
59
60         <para>Programs using the <command>exec(2)</command> functions can 
61         pass the URI in argv[0], while shell scripts must set the 
62         <envar>DEVICE_URI</envar> environment variable prior to
63         running smbspool.</para>
64 </refsect1>
65
66 <refsect1>
67         <title>OPTIONS</title>
68
69         <itemizedlist>
70                 <listitem><para>The job argument (argv[1]) contains the 
71                 job ID number and is presently not used by smbspool.
72                 </para></listitem>
73
74                 <listitem><para>The user argument (argv[2]) contains the 
75                 print user's name and is presently not used by smbspool.
76                 </para></listitem>
77
78                 <listitem><para>The title argument (argv[3]) contains the 
79                 job title string and is passed as the remote file name 
80                 when sending the print job.</para></listitem>
81
82                 <listitem><para>The copies argument (argv[4]) contains 
83                 the number of copies to be printed of the named file. If 
84                 no filename is provided then this argument is not used by 
85                 smbspool.</para></listitem>
86
87                 <listitem><para>The options argument (argv[5]) contains 
88                 the print options in a single string and is currently 
89                 not used by smbspool.</para></listitem>
90
91                 <listitem><para>The filename argument (argv[6]) contains the 
92                 name of the file to print. If this argument is not specified 
93                 then the print file is read from the standard input.</para>
94                 </listitem>
95         </itemizedlist>
96 </refsect1>
97
98
99 <refsect1>
100         <title>VERSION</title>
101
102         <para>This man page is correct for version 3.0 of the Samba suite.</para>
103 </refsect1>
104
105 <refsect1>
106         <title>SEE ALSO</title>
107         <para><citerefentry><refentrytitle>smbd</refentrytitle>
108         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>Samba</refentrytitle>
109         <manvolnum>7</manvolnum></citerefentry>.</para>
110 </refsect1>
111
112 <refsect1>
113         <title>AUTHOR</title>
114
115         <para><command>smbspool</command> was written by Michael Sweet 
116         at Easy Software Products.</para>
117         
118         <para>The original Samba software and related utilities 
119         were created by Andrew Tridgell. Samba is now developed
120         by the Samba Team as an Open Source project similar 
121         to the way the Linux kernel is developed.</para>
122         
123         <para>The original Samba man pages were written by Karl Auer. 
124         The man page sources were converted to YODL format (another 
125         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
126         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
127         release by Jeremy Allison.  The conversion to DocBook for 
128         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
129         for Samba 3.0 was done by Alexander Bokovoy.</para>
130 </refsect1>
131
132 </refentry>