source: vendor/current/docs/manpages/smbspool.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 5.1 KB
Line 
1'\" t
2.\" Title: smbspool
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "SMBSPOOL" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31smbspool \- send a print file to an SMB printer
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34smbspool {job} {user} {title} {copies} {options} [filename]
35.SH "DESCRIPTION"
36.PP
37This tool is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41smbspool is a very small print spooling program that sends a print file to an SMB printer\&. The command\-line arguments are position\-dependent for compatibility with the Common UNIX Printing System, but you can use smbspool with any printing system or from a program or script\&.
42.PP
43\fIDEVICE URI\fR
44.PP
45smbspool specifies the destination using a Uniform Resource Identifier ("URI") with a method of "smb"\&. This string can take a number of forms:
46.sp
47.RS 4
48.ie n \{\
49\h'-04'\(bu\h'+03'\c
50.\}
51.el \{\
52.sp -1
53.IP \(bu 2.3
54.\}
55smb://server[:port]/printer
56.RE
57.sp
58.RS 4
59.ie n \{\
60\h'-04'\(bu\h'+03'\c
61.\}
62.el \{\
63.sp -1
64.IP \(bu 2.3
65.\}
66smb://workgroup/server[:port]/printer
67.RE
68.sp
69.RS 4
70.ie n \{\
71\h'-04'\(bu\h'+03'\c
72.\}
73.el \{\
74.sp -1
75.IP \(bu 2.3
76.\}
77smb://username:password@server[:port]/printer
78.RE
79.sp
80.RS 4
81.ie n \{\
82\h'-04'\(bu\h'+03'\c
83.\}
84.el \{\
85.sp -1
86.IP \(bu 2.3
87.\}
88smb://domain\eusername:password@server[:port]/printer
89.RE
90.sp
91.RS 4
92.ie n \{\
93\h'-04'\(bu\h'+03'\c
94.\}
95.el \{\
96.sp -1
97.IP \(bu 2.3
98.\}
99smb://username:password@workgroup/server[:port]/printer
100.RE
101.sp
102.RE
103.PP
104smbspool tries to get the URI from the environment variable
105\fBDEVICE_URI\fR\&. If
106\fBDEVICE_URI\fR
107is not present, smbspool will use argv[0] if that starts with
108\(lqsmb://\(rq
109or argv[1] if that is not the case\&.
110.PP
111Programs using the
112exec(2)
113functions can pass the URI in argv[0], while shell scripts must set the
114\fBDEVICE_URI\fR
115environment variable prior to running smbspool\&.
116.PP
117smbspool will accept URI escaped characters\&. This allows setting a domain in the username, or space in the printer name\&. For example smb://domain%5Cusername/printer%20name
118.SH "OPTIONS"
119.sp
120.RS 4
121.ie n \{\
122\h'-04'\(bu\h'+03'\c
123.\}
124.el \{\
125.sp -1
126.IP \(bu 2.3
127.\}
128The job argument (argv[1]) contains the job ID number and is presently not used by smbspool\&.
129.RE
130.sp
131.RS 4
132.ie n \{\
133\h'-04'\(bu\h'+03'\c
134.\}
135.el \{\
136.sp -1
137.IP \(bu 2.3
138.\}
139The user argument (argv[2]) contains the print user\*(Aqs name and is presently not used by smbspool\&.
140.RE
141.sp
142.RS 4
143.ie n \{\
144\h'-04'\(bu\h'+03'\c
145.\}
146.el \{\
147.sp -1
148.IP \(bu 2.3
149.\}
150The title argument (argv[3]) contains the job title string and is passed as the remote file name when sending the print job\&.
151.RE
152.sp
153.RS 4
154.ie n \{\
155\h'-04'\(bu\h'+03'\c
156.\}
157.el \{\
158.sp -1
159.IP \(bu 2.3
160.\}
161The copies argument (argv[4]) contains the number of copies to be printed of the named file\&. If no filename is provided then this argument is not used by smbspool\&.
162.RE
163.sp
164.RS 4
165.ie n \{\
166\h'-04'\(bu\h'+03'\c
167.\}
168.el \{\
169.sp -1
170.IP \(bu 2.3
171.\}
172The options argument (argv[5]) contains the print options in a single string and is currently not used by smbspool\&.
173.RE
174.sp
175.RS 4
176.ie n \{\
177\h'-04'\(bu\h'+03'\c
178.\}
179.el \{\
180.sp -1
181.IP \(bu 2.3
182.\}
183The filename argument (argv[6]) contains the name of the file to print\&. If this argument is not specified then the print file is read from the standard input\&.
184.RE
185.SH "VERSION"
186.PP
187This man page is correct for version 3 of the Samba suite\&.
188.SH "SEE ALSO"
189.PP
190\fBsmbd\fR(8)
191and
192\fBsamba\fR(7)\&.
193.SH "AUTHOR"
194.PP
195smbspool
196was written by Michael Sweet at Easy Software Products\&.
197.PP
198The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
199.PP
200The original Samba man pages were written by Karl Auer\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at
201ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
Note: See TracBrowser for help on using the repository browser.