update docs for "password server" and regenerate
[samba.git] / docs / manpages / smbspool.8
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "SMBSPOOL" "8" "01 October 2002" "" ""
7 .SH NAME
8 smbspool \- send a print file to an SMB printer
9 .SH SYNOPSIS
10
11 \fBsmbspool\fR [ \fBjob\fR ] [ \fBuser\fR ] [ \fBtitle\fR ] [ \fBcopies\fR ] [ \fBoptions\fR ] [ \fBfilename\fR ]
12
13 .SH "DESCRIPTION"
14 .PP
15 This tool is part of the  Samba suite.
16 .PP
17 smbspool is a very small print spooling program that 
18 sends a print file to an SMB printer. The command-line arguments 
19 are position-dependent for compatibility with the Common UNIX 
20 Printing System, but you can use smbspool with any printing system 
21 or from a program or script.
22 .PP
23 \fBDEVICE URI\fR
24 .PP
25 smbspool specifies the destination using a Uniform Resource 
26 Identifier ("URI") with a method of "smb". This string can take 
27 a number of forms:
28 .TP 0.2i
29 \(bu
30 smb://server/printer
31 .TP 0.2i
32 \(bu
33 smb://workgroup/server/printer
34 .TP 0.2i
35 \(bu
36 smb://username:password@server/printer
37 .TP 0.2i
38 \(bu
39 smb://username:password@workgroup/server/printer
40 .PP
41 smbspool tries to get the URI from argv[0]. If argv[0] 
42 contains the name of the program then it looks in the \fB DEVICE_URI\fR environment variable.
43 .PP
44 Programs using the \fBexec(2)\fR functions can 
45 pass the URI in argv[0], while shell scripts must set the 
46 \fBDEVICE_URI\fR environment variable prior to
47 running smbspool.
48 .SH "OPTIONS"
49 .TP 0.2i
50 \(bu
51 The job argument (argv[1]) contains the 
52 job ID number and is presently not used by smbspool.
53 .TP 0.2i
54 \(bu
55 The user argument (argv[2]) contains the 
56 print user's name and is presently not used by smbspool.
57 .TP 0.2i
58 \(bu
59 The title argument (argv[3]) contains the 
60 job title string and is passed as the remote file name 
61 when sending the print job.
62 .TP 0.2i
63 \(bu
64 The copies argument (argv[4]) contains 
65 the number of copies to be printed of the named file. If 
66 no filename is provided then this argument is not used by 
67 smbspool.
68 .TP 0.2i
69 \(bu
70 The options argument (argv[5]) contains 
71 the print options in a single string and is currently 
72 not used by smbspool.
73 .TP 0.2i
74 \(bu
75 The filename argument (argv[6]) contains the 
76 name of the file to print. If this argument is not specified 
77 then the print file is read from the standard input.
78 .SH "VERSION"
79 .PP
80 This man page is correct for version 2.2 of 
81 the Samba suite.
82 .SH "SEE ALSO"
83 .PP
84 \fBsmbd(8)\fR 
85 and samba(7)
86 .SH "AUTHOR"
87 .PP
88 \fBsmbspool\fR was written by Michael Sweet 
89 at Easy Software Products.
90 .PP
91 The original Samba software and related utilities 
92 were created by Andrew Tridgell. Samba is now developed
93 by the Samba Team as an Open Source project similar 
94 to the way the Linux kernel is developed.
95 .PP
96 The original Samba man pages were written by Karl Auer. 
97 The man page sources were converted to YODL format (another 
98 excellent piece of Open Source software, available at
99 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
100 release by Jeremy Allison.  The conversion to DocBook for 
101 Samba 2.2 was done by Gerald Carter