source: branches/samba-3.3.x/docs/manpages/smbspool.8@ 216

Last change on this file since 216 was 216, checked in by Herwig Bauernfeind, 16 years ago

Import Samba 3.3 branch at 3.3.0 level docs (psmedley's port)

File size: 7.5 KB
Line 
1.\" Title: smbspool
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 01/27/2009
5.\" Manual: System Administration tools
6.\" Source: Samba 3.3
7.\" Language: English
8.\"
9.TH "SMBSPOOL" "8" "01/27/2009" "Samba 3\&.3" "System Administration tools"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170smbspool \- send a print file to an SMB printer
171.SH "Synopsis"
172.fam C
173.HP \w'\ 'u
174\FCsmbspool\F[] {job} {user} {title} {copies} {options} [filename]
175.fam
176.SH "DESCRIPTION"
177.PP
178This tool is part of the
179\fBsamba\fR(7)
180suite\&.
181.PP
182smbspool 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\&.
183.PP
184\fIDEVICE URI\fR
185.PP
186smbspool specifies the destination using a Uniform Resource Identifier ("URI") with a method of "smb"\&. This string can take a number of forms:
187.sp
188.RS 4
189.ie n \{\
190\h'-04'\(bu\h'+03'\c
191.\}
192.el \{\
193.sp -1
194.IP \(bu 2.3
195.\}
196smb://server[:port]/printer
197.RE
198.sp
199.RS 4
200.ie n \{\
201\h'-04'\(bu\h'+03'\c
202.\}
203.el \{\
204.sp -1
205.IP \(bu 2.3
206.\}
207smb://workgroup/server[:port]/printer
208.RE
209.sp
210.RS 4
211.ie n \{\
212\h'-04'\(bu\h'+03'\c
213.\}
214.el \{\
215.sp -1
216.IP \(bu 2.3
217.\}
218smb://username:password@server[:port]/printer
219.RE
220.sp
221.RS 4
222.ie n \{\
223\h'-04'\(bu\h'+03'\c
224.\}
225.el \{\
226.sp -1
227.IP \(bu 2.3
228.\}
229smb://username:password@workgroup/server[:port]/printer
230.sp
231.RE
232.PP
233smbspool tries to get the URI from the environment variable
234\fBDEVICE_URI\fR\&. If
235\fBDEVICE_URI\fR
236is not present, smbspool will use argv[0] if that starts with
237\(lqsmb://\(rq
238or argv[1] if that is not the case\&.
239.PP
240Programs using the
241\FCexec(2)\F[]
242functions can pass the URI in argv[0], while shell scripts must set the
243\fBDEVICE_URI\fR
244environment variable prior to running smbspool\&.
245.SH "OPTIONS"
246.sp
247.RS 4
248.ie n \{\
249\h'-04'\(bu\h'+03'\c
250.\}
251.el \{\
252.sp -1
253.IP \(bu 2.3
254.\}
255The job argument (argv[1]) contains the job ID number and is presently not used by smbspool\&.
256.RE
257.sp
258.RS 4
259.ie n \{\
260\h'-04'\(bu\h'+03'\c
261.\}
262.el \{\
263.sp -1
264.IP \(bu 2.3
265.\}
266The user argument (argv[2]) contains the print user\'s name and is presently not used by smbspool\&.
267.RE
268.sp
269.RS 4
270.ie n \{\
271\h'-04'\(bu\h'+03'\c
272.\}
273.el \{\
274.sp -1
275.IP \(bu 2.3
276.\}
277The title argument (argv[3]) contains the job title string and is passed as the remote file name when sending the print job\&.
278.RE
279.sp
280.RS 4
281.ie n \{\
282\h'-04'\(bu\h'+03'\c
283.\}
284.el \{\
285.sp -1
286.IP \(bu 2.3
287.\}
288The 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\&.
289.RE
290.sp
291.RS 4
292.ie n \{\
293\h'-04'\(bu\h'+03'\c
294.\}
295.el \{\
296.sp -1
297.IP \(bu 2.3
298.\}
299The options argument (argv[5]) contains the print options in a single string and is currently not used by smbspool\&.
300.RE
301.sp
302.RS 4
303.ie n \{\
304\h'-04'\(bu\h'+03'\c
305.\}
306.el \{\
307.sp -1
308.IP \(bu 2.3
309.\}
310The 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\&.
311.SH "VERSION"
312.PP
313This man page is correct for version 3 of the Samba suite\&.
314.SH "SEE ALSO"
315.PP
316\fBsmbd\fR(8)
317and
318\fBsamba\fR(7)\&.
319.SH "AUTHOR"
320.PP
321\FCsmbspool\F[]
322was written by Michael Sweet at Easy Software Products\&.
323.PP
324The 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\&.
325.PP
326The 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
327ftp://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.