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