Revert manifest to default one
[external/cups.git] / man / cupsaddsmb.man.in
1 .\"
2 .\" "$Id: cupsaddsmb.man.in 9771 2011-05-12 05:21:56Z mike $"
3 .\"
4 .\"   cupsaddsmb man page for CUPS.
5 .\"
6 .\"   Copyright 2007-2011 by Apple Inc.
7 .\"   Copyright 1997-2006 by Easy Software Products.
8 .\"
9 .\"   These coded instructions, statements, and computer programs are the
10 .\"   property of Apple Inc. and are protected by Federal copyright
11 .\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
12 .\"   which should have been included with this file.  If this file is
13 .\"   file is missing or damaged, see the license at "http://www.cups.org/".
14 .\"
15 .TH cupsaddsmb 8 "CUPS" "25 July 2007" "Apple Inc."
16 .SH NAME
17 cupsaddsmb \- export printers to samba for windows clients
18
19 .SH SYNOPSIS
20 .B cupsaddsmb
21 [ -H
22 .I samba-server
23 ] [ -U
24 .I samba-user[%samba-password]
25 ] [ -h
26 .I cups-server[:port]
27 ] [ -v ] -a
28 .br
29 .B cupsaddsmb
30 [ -H
31 .I samba-server
32 ] [ -U
33 .I samba-user[%samba-password]
34 ] [ -h
35 .I cups-server[:port]
36 ] [ -v ] printer [ ... printer ]
37
38 .SH DESCRIPTION
39 \fIcupsaddsmb\fR exports printers to the SAMBA software (version
40 2.2.0 or higher) for use with Windows clients. Depending on the
41 SAMBA configuration, you may need to provide a password to
42 export the printers. This program requires the Windows printer
43 driver files described below.
44
45 .SH OPTIONS
46 \fIcupsaddsmb\fR supports the following options:
47 .TP 5
48 -H samba-server
49 .br
50 Specifies the SAMBA server which defaults to the CUPS server.
51 .TP 5
52 -U samba-user[%samba-password]
53 .br
54 Specifies the SAMBA print admin username which defaults to your
55 current username. If the username contains a percent (%)
56 character, then the text following the percent is treated as the
57 SAMBA password to use.
58 .TP 5
59 -a
60 .br
61 Exports all known printers. Otherwise only the named printers are
62 exported.
63 .TP 5
64 -h cups-server[:port]
65 .br
66 Specifies a different CUPS server to use.
67 .TP 5
68 -v
69 .br
70 Specifies that verbose information should be shown. This is
71 useful for debugging SAMBA configuration problems.
72
73 .SH SAMBA CONFIGURATION
74 \fIcupsaddsmb\fR uses the new RPC-based printing support in
75 SAMBA 2.2.x to provide printer drivers and PPD files to Windows
76 client machines. In order to use this functionality, you must
77 first configure the SAMBA \fIsmb.conf(5)\fR file to support
78 printing through CUPS and provide a printer driver download
79 share, as follows:
80 .nf
81
82     [global]
83         load printers = yes
84         printing = cups
85         printcap name = cups
86
87     [printers]
88         comment = All Printers
89         path = /var/spool/samba
90         browseable = no
91         public = yes
92         guest ok = yes
93         writable = no
94         printable = yes
95
96     [print$]
97         comment = Printer Drivers
98         path = /etc/samba/drivers
99         browseable = yes
100         guest ok = no
101         read only = yes
102         write list = root
103 .fi
104 .LP
105 This configuration assumes a FHS-compliant installation of
106 SAMBA; adjust the [printers] and [print$] share paths
107 accordingly on your system as needed.
108
109 .SH MICROSOFT POSTSCRIPT DRIVERS FOR WINDOWS
110 The base driver for Windows 2000 and higher is the Microsoft
111 PostScript driver, which is available on any system running
112 Windows 2000 or higher in the
113 %WINDIR%\\SYSTEM32\\SPOOL\\DRIVERS\\W32X86\\3 folder for 32-bit
114 drivers and
115 %WINDIR%\\SYSTEM32\\SPOOL\\DRIVERS\\X64\\3 folder for 64-bit
116 drivers.
117 .LP
118 The CUPS printer driver is preferred over the Microsoft driver
119 since it supports the page-label, job-billing, and
120 job-hold-until options fully on all printers. However, currently
121 only Windows 2000 and higher is supported by the Microsoft
122 driver, so you will also need to get the Adobe driver to support
123 Windows 95, 98, and Me clients. The Adobe and Microsoft drivers
124 for Windows 2000 are identical.
125 .LP
126 Once you have extracted the driver files, copy the 32-bit drivers
127 to the \fI@CUPS_DATADIR@/drivers\fR directory and the 64-bit
128 drivers to the \fI@CUPS_DATADIR@/drivers/x64\fR directory exactly
129 as named below:
130 .nf
131
132     [Windows 2000 and higher]
133     ps5ui.dll
134     pscript.hlp
135     pscript.ntf
136     pscript5.dll
137 .fi
138 .LP
139 \fBNote:\fR Unlike Windows, case is significant - make sure that
140 you use the lowercase filenames shown above, otherwise
141 \fIcupsaddsmb\fR will fail to export the drivers.
142
143 .SH CUPS POSTSCRIPT DRIVERS FOR WINDOWS
144 \fIcupsaddsmb\fR can use the CUPS v6 PostScript printer driver
145 for Windows, which is available for download from the CUPS web
146 site.
147 .LP
148 The CUPS printer driver is preferred over the Adobe and
149 Microsoft drivers since it supports the page-label, job-billing,
150 and job-hold-until options fully on all printers. However,
151 currently only Windows 2000 and higher is supported by the CUPS
152 driver, so you will also need to get the Adobe driver to support
153 Windows 95, 98, and Me clients.
154 .LP
155 Once you have extracted the driver files, copy the 32-bit drivers
156 to the \fI@CUPS_DATADIR@/drivers\fR directory and the 64-bit
157 drivers to the \fI@CUPS_DATADIR@/drivers/x64\fR directory exactly
158 as named below:
159 .nf
160
161     [Windows 2000 and higher]
162     cups6.inf (from www.cups.org)
163     cups6.ini (from www.cups.org)
164     cupsps6.dll (from www.cups.org)
165     cupsui6.dll (from www.cups.org)
166     ps5ui.dll (from your Windows system)
167     pscript.hlp (from your Windows system)
168     pscript.ntf (from your Windows system)
169     pscript5.dll (from your Windows system)
170 .fi
171 .LP
172 \fBNote:\fR Unlike Windows, case is significant - make sure that
173 you use the lowercase filenames shown above, otherwise
174 \fIcupsaddsmb\fR will fail to export the drivers.
175
176 .SH ADOBE POSTSCRIPT DRIVERS FOR WINDOWS 95, 98, AND ME
177 \fIcupsaddsmb\fR can use the Adobe PostScript printer driver for
178 Windows 95, 98, and ME, which are available for download from the
179 Adobe web site (http://www.adobe.com).
180 .LP
181 The Adobe driver does not support the page-label, job-billing, or
182 job-hold-until options.
183 .LP
184 Once you have installed the driver on a Windows system, copy the
185 following files to the \fI@CUPS_DATADIR@/drivers\fR directory
186 exactly as named below:
187 .nf
188
189     [Windows 95, 98, and Me]
190     ADFONTS.MFM
191     ADOBEPS4.DRV
192     ADOBEPS4.HLP
193     ICONLIB.DLL
194     PSMON.DLL
195 .fi
196 .LP
197 \fBNote:\fR Unlike Windows, case is significant - make sure that
198 you use the UPPERCASE filenames shown above, otherwise
199 \fIcupsaddsmb\fR will fail to export the drivers.
200
201 .SH KNOWN ISSUES
202 Getting the full set of Windows driver files should be easier.
203
204 .SH SEE ALSO
205 \fIsmbd(8)\fR, \fIsmb.conf(5)\fR,
206 http://localhost:631/help
207 .br
208 http://www.cups.org/windows/
209
210 .SH COPYRIGHT
211 Copyright 2007-2011 by Apple Inc.
212 .\"
213 .\" End of "$Id: cupsaddsmb.man.in 9771 2011-05-12 05:21:56Z mike $".
214 .\"