set version string
[Samba.git] / docs / htmldocs / smbtar.1.html
blobd3215c6901369b25c91c866b2e1511f311d1853e
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"
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 <A
52 HREF="samba.7.html"
53 TARGET="_top"
54 > Samba</A
55 > suite.</P
56 ><P
57 ><B
58 CLASS="COMMAND"
59 >smbtar</B
60 > is a very small shell script on top
61 of <A
62 HREF="smbclient.1.html"
63 TARGET="_top"
64 ><B
65 CLASS="COMMAND"
66 >smbclient(1)</B
67 ></A
69 which dumps SMB shares directly to tape. </P
70 ></DIV
71 ><DIV
72 CLASS="REFSECT1"
73 ><A
74 NAME="AEN34"
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
101 >Exclude mode. Exclude filenames... from tar
102 create or restore. </P
103 ></DD
104 ><DT
105 >-d directory</DT
106 ><DD
108 >Change to initial <TT
109 CLASS="PARAMETER"
111 >directory
113 ></TT
114 > before restoring / backing up files. </P
115 ></DD
116 ><DT
117 >-v</DT
118 ><DD
120 >Verbose mode.</P
121 ></DD
122 ><DT
123 >-p password</DT
124 ><DD
126 >The password to use to access a share.
127 Default: none </P
128 ></DD
129 ><DT
130 >-u user</DT
131 ><DD
133 >The user id to connect as. Default:
134 UNIX login name. </P
135 ></DD
136 ><DT
137 >-t tape</DT
138 ><DD
140 >Tape device. May be regular file or tape
141 device. Default: <TT
142 CLASS="PARAMETER"
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
157 >Blocking factor. Defaults to 20. See
159 CLASS="COMMAND"
160 >tar(1)</B
161 > for a fuller explanation. </P
162 ></DD
163 ><DT
164 >-N filename</DT
165 ><DD
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
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
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
190 >Log (debug) level. Corresponds to the
192 CLASS="PARAMETER"
194 >-d</I
195 ></TT
196 > flag of <B
197 CLASS="COMMAND"
198 >smbclient(1)
200 >. </P
201 ></DD
202 ></DL
203 ></DIV
204 ></DIV
205 ><DIV
206 CLASS="REFSECT1"
208 NAME="AEN95"
209 ></A
210 ><H2
211 >ENVIRONMENT VARIABLES</H2
213 >The <TT
214 CLASS="PARAMETER"
216 >$TAPE</I
217 ></TT
218 > variable specifies the
219 default tape device to write to. May be overridden
220 with the -t option. </P
221 ></DIV
222 ><DIV
223 CLASS="REFSECT1"
225 NAME="AEN99"
226 ></A
227 ><H2
228 >BUGS</H2
230 >The <B
231 CLASS="COMMAND"
232 >smbtar</B
233 > script has different
234 options from ordinary tar and from smbclient's tar command. </P
235 ></DIV
236 ><DIV
237 CLASS="REFSECT1"
239 NAME="AEN103"
240 ></A
241 ><H2
242 >CAVEATS</H2
244 >Sites that are more careful about security may not like
245 the way the script handles PC passwords. Backup and restore work
246 on entire shares; should work on file lists. smbtar works best
247 with GNU tar and may not work well with other versions. </P
248 ></DIV
249 ><DIV
250 CLASS="REFSECT1"
252 NAME="AEN106"
253 ></A
254 ><H2
255 >DIAGNOSTICS</H2
257 >See the <SPAN
258 CLASS="emphasis"
260 CLASS="EMPHASIS"
261 >DIAGNOSTICS</I
262 ></SPAN
263 > section for the
265 HREF="smbclient.1.html"
266 TARGET="_top"
268 CLASS="COMMAND"
269 >smbclient(1)</B
272 > command.</P
273 ></DIV
274 ><DIV
275 CLASS="REFSECT1"
277 NAME="AEN112"
278 ></A
279 ><H2
280 >VERSION</H2
282 >This man page is correct for version 3.0 of
283 the Samba suite.</P
284 ></DIV
285 ><DIV
286 CLASS="REFSECT1"
288 NAME="AEN115"
289 ></A
290 ><H2
291 >SEE ALSO</H2
294 HREF="smbd.8.html"
295 TARGET="_top"
297 CLASS="COMMAND"
298 >smbd(8)</B
299 ></A
302 HREF="smbclient.1.html"
303 TARGET="_top"
305 CLASS="COMMAND"
306 >smbclient(1)</B
307 ></A
310 HREF="smb.conf.5.html"
311 TARGET="_top"
312 >smb.conf(5)</A
315 ></DIV
316 ><DIV
317 CLASS="REFSECT1"
319 NAME="AEN123"
320 ></A
321 ><H2
322 >AUTHOR</H2
324 >The original Samba software and related utilities
325 were created by Andrew Tridgell. Samba is now developed
326 by the Samba Team as an Open Source project similar
327 to the way the Linux kernel is developed.</P
330 HREF="mailto:poultenr@logica.co.uk"
331 TARGET="_top"
332 >Ricky Poulten</A
334 wrote the tar extension and this man page. The <B
335 CLASS="COMMAND"
336 >smbtar</B
338 script was heavily rewritten and improved by <A
339 HREF="mailto:Martin.Kraemer@mch.sni.de"
340 TARGET="_top"
341 >Martin Kraemer</A
342 >. Many
343 thanks to everyone who suggested extensions, improvements, bug
344 fixes, etc. The man page sources were converted to YODL format (another
345 excellent piece of Open Source software, available at
347 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
348 TARGET="_top"
349 > ftp://ftp.icce.rug.nl/pub/unix/</A
350 >) and updated for the Samba 2.0
351 release by Jeremy Allison. The conversion to DocBook for
352 Samba 2.2 was done by Gerald Carter.</P
353 ></DIV
354 ></BODY
355 ></HTML