Regenerate
[samba.git] / docs / htmldocs / smbtar.1.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >smbtar</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.77+"></HEAD
9 ><BODY
10 CLASS="REFENTRY"
11 BGCOLOR="#FFFFFF"
12 TEXT="#000000"
13 LINK="#0000FF"
14 VLINK="#840084"
15 ALINK="#0000FF"
16 ><H1
17 ><A
18 NAME="SMBTAR.1"
19 ></A
20 >smbtar</H1
21 ><DIV
22 CLASS="REFNAMEDIV"
23 ><A
24 NAME="AEN5"
25 ></A
26 ><H2
27 >Name</H2
28 >smbtar&nbsp;--&nbsp;shell script for backing up SMB/CIFS shares 
29         directly to UNIX tape drives</DIV
30 ><DIV
31 CLASS="REFSYNOPSISDIV"
32 ><A
33 NAME="AEN8"
34 ></A
35 ><H2
36 >Synopsis</H2
37 ><P
38 ><B
39 CLASS="COMMAND"
40 >smbtar</B
41 >  {-s server} [-p password] [-x services] [-X] [-d directory] [-u user] [-t tape] [-t tape] [-b blocksize] [-N filename] [-i] [-r] [-l loglevel] [-v] {filenames}</P
42 ></DIV
43 ><DIV
44 CLASS="REFSECT1"
45 ><A
46 NAME="AEN26"
47 ></A
48 ><H2
49 >DESCRIPTION</H2
50 ><P
51 >This tool is part of the <SPAN
52 CLASS="CITEREFENTRY"
53 ><SPAN
54 CLASS="REFENTRYTITLE"
55 >Samba</SPAN
56 >(7)</SPAN
57 > suite.</P
58 ><P
59 ><B
60 CLASS="COMMAND"
61 >smbtar</B
62 > is a very small shell script on top 
63         of <SPAN
64 CLASS="CITEREFENTRY"
65 ><SPAN
66 CLASS="REFENTRYTITLE"
67 >smbclient</SPAN
68 >(1)</SPAN
69 > which dumps SMB shares directly to tape.</P
70 ></DIV
71 ><DIV
72 CLASS="REFSECT1"
73 ><A
74 NAME="AEN37"
75 ></A
76 ><H2
77 >OPTIONS</H2
78 ><P
79 ></P
80 ><DIV
81 CLASS="VARIABLELIST"
82 ><DL
83 ><DT
84 >-s server</DT
85 ><DD
86 ><P
87 >The SMB/CIFS server that the share resides 
88                 upon.</P
89 ></DD
90 ><DT
91 >-x service</DT
92 ><DD
93 ><P
94 >The share name on the server to connect to. 
95                 The default is "backup".</P
96 ></DD
97 ><DT
98 >-X</DT
99 ><DD
100 ><P
101 >Exclude mode. Exclude filenames... from tar 
102                 create or restore. </P
103 ></DD
104 ><DT
105 >-d directory</DT
106 ><DD
107 ><P
108 >Change to initial <TT
109 CLASS="PARAMETER"
110 ><I
111 >directory
112                 </I
113 ></TT
114 > before restoring / backing up files. </P
115 ></DD
116 ><DT
117 >-v</DT
118 ><DD
119 ><P
120 >Verbose mode.</P
121 ></DD
122 ><DT
123 >-p password</DT
124 ><DD
125 ><P
126 >The password to use to access a share. 
127                 Default: none </P
128 ></DD
129 ><DT
130 >-u user</DT
131 ><DD
132 ><P
133 >The user id to connect as. Default: 
134                 UNIX login name. </P
135 ></DD
136 ><DT
137 >-t tape</DT
138 ><DD
139 ><P
140 >Tape device. May be regular file or tape 
141                 device. Default: <TT
142 CLASS="PARAMETER"
143 ><I
144 >$TAPE</I
145 ></TT
146 > environmental 
147                 variable; if not set, a file called <TT
148 CLASS="FILENAME"
149 >tar.out
150                 </TT
151 >. </P
152 ></DD
153 ><DT
154 >-b blocksize</DT
155 ><DD
156 ><P
157 >Blocking factor. Defaults to 20. See
158                 <B
159 CLASS="COMMAND"
160 >tar(1)</B
161 > for a fuller explanation. </P
162 ></DD
163 ><DT
164 >-N filename</DT
165 ><DD
166 ><P
167 >Backup only files newer than filename. Could 
168                 be used (for example) on a log file to implement incremental
169                 backups. </P
170 ></DD
171 ><DT
172 >-i</DT
173 ><DD
174 ><P
175 >Incremental mode; tar files are only backed 
176                 up if they have the archive bit set. The archive bit is reset 
177                 after each file is read. </P
178 ></DD
179 ><DT
180 >-r</DT
181 ><DD
182 ><P
183 >Restore. Files are restored to the share 
184                 from the tar file. </P
185 ></DD
186 ><DT
187 >-l log level</DT
188 ><DD
189 ><P
190 >Log (debug) level. Corresponds to the 
191                 <TT
192 CLASS="PARAMETER"
193 ><I
194 >-d</I
195 ></TT
196 > flag of <SPAN
197 CLASS="CITEREFENTRY"
198 ><SPAN
199 CLASS="REFENTRYTITLE"
200 >smbclient</SPAN
201 >(1)</SPAN
202 >.</P
203 ></DD
204 ></DL
205 ></DIV
206 ></DIV
207 ><DIV
208 CLASS="REFSECT1"
209 ><A
210 NAME="AEN100"
211 ></A
212 ><H2
213 >ENVIRONMENT VARIABLES</H2
214 ><P
215 >The <TT
216 CLASS="PARAMETER"
217 ><I
218 >$TAPE</I
219 ></TT
220 > variable specifies the 
221         default tape device to write to. May be overridden
222         with the -t option. </P
223 ></DIV
224 ><DIV
225 CLASS="REFSECT1"
226 ><A
227 NAME="AEN104"
228 ></A
229 ><H2
230 >BUGS</H2
231 ><P
232 >The <B
233 CLASS="COMMAND"
234 >smbtar</B
235 > script has different 
236         options from ordinary tar and from smbclient's tar command. </P
237 ></DIV
238 ><DIV
239 CLASS="REFSECT1"
240 ><A
241 NAME="AEN108"
242 ></A
243 ><H2
244 >CAVEATS</H2
245 ><P
246 >Sites that are more careful about security may not like 
247         the way the script handles PC passwords. Backup and restore work 
248         on entire shares; should work on file lists. smbtar works best
249         with GNU tar and may not work well with other versions. </P
250 ></DIV
251 ><DIV
252 CLASS="REFSECT1"
253 ><A
254 NAME="AEN111"
255 ></A
256 ><H2
257 >DIAGNOSTICS</H2
258 ><P
259 >See the <SPAN
260 CLASS="emphasis"
261 ><I
262 CLASS="EMPHASIS"
263 >DIAGNOSTICS</I
264 ></SPAN
265 > section for the <SPAN
266 CLASS="CITEREFENTRY"
267 ><SPAN
268 CLASS="REFENTRYTITLE"
269 >smbclient</SPAN
270 >(1)</SPAN
271 > command.</P
272 ></DIV
273 ><DIV
274 CLASS="REFSECT1"
275 ><A
276 NAME="AEN118"
277 ></A
278 ><H2
279 >VERSION</H2
280 ><P
281 >This man page is correct for version 3.0 of 
282         the Samba suite.</P
283 ></DIV
284 ><DIV
285 CLASS="REFSECT1"
286 ><A
287 NAME="AEN121"
288 ></A
289 ><H2
290 >SEE ALSO</H2
291 ><P
292 ><SPAN
293 CLASS="CITEREFENTRY"
294 ><SPAN
295 CLASS="REFENTRYTITLE"
296 >smbd</SPAN
297 >(8)</SPAN
298 >, <SPAN
299 CLASS="CITEREFENTRY"
300 ><SPAN
301 CLASS="REFENTRYTITLE"
302 >smbclient</SPAN
303 >(1)</SPAN
304 >, <SPAN
305 CLASS="CITEREFENTRY"
306 ><SPAN
307 CLASS="REFENTRYTITLE"
308 >smb.conf</SPAN
309 >(5)</SPAN
310 >.</P
311 ></DIV
312 ><DIV
313 CLASS="REFSECT1"
314 ><A
315 NAME="AEN133"
316 ></A
317 ><H2
318 >AUTHOR</H2
319 ><P
320 >The original Samba software and related utilities 
321         were created by Andrew Tridgell. Samba is now developed
322         by the Samba Team as an Open Source project similar 
323         to the way the Linux kernel is developed.</P
324 ><P
325 ><A
326 HREF="mailto:poultenr@logica.co.uk"
327 TARGET="_top"
328 >Ricky Poulten</A
329 >  
330         wrote the tar extension and this man page. The <B
331 CLASS="COMMAND"
332 >smbtar</B
333
334         script was heavily rewritten and improved by <A
335 HREF="mailto:Martin.Kraemer@mch.sni.de"
336 TARGET="_top"
337 >Martin Kraemer</A
338 >. Many 
339         thanks to everyone who suggested extensions, improvements, bug 
340         fixes, etc. The man page sources were converted to YODL format (another 
341         excellent piece of Open Source software, available at <A
342 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
343 TARGET="_top"
344 >       ftp://ftp.icce.rug.nl/pub/unix/</A
345 >) and updated for the Samba 2.0 
346         release by Jeremy Allison.  The conversion to DocBook for 
347         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
348         Samba 3.0 was done by Alexander Bokovoy.</P
349 ></DIV
350 ></BODY
351 ></HTML
352 >