Fix smb.conf.5.xml and friends:
[abartlet/samba.git/.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.7"></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 >  [-r] [-i] [-a] [-v] {-s server} [-p password] [-x services] [-X] [-N filename] [-b blocksize] [-d directory] [-l loglevel] [-u user] [-t tape] {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 <VAR
109 CLASS="PARAMETER"
110 >directory
111                 </VAR
112 > before restoring / backing up files. </P
113 ></DD
114 ><DT
115 >-v</DT
116 ><DD
117 ><P
118 >Verbose mode.</P
119 ></DD
120 ><DT
121 >-p password</DT
122 ><DD
123 ><P
124 >The password to use to access a share. 
125                 Default: none </P
126 ></DD
127 ><DT
128 >-u user</DT
129 ><DD
130 ><P
131 >The user id to connect as. Default: 
132                 UNIX login name. </P
133 ></DD
134 ><DT
135 >-a</DT
136 ><DD
137 ><P
138 >Reset DOS archive bit mode to 
139                 indicate file has been archived. </P
140 ></DD
141 ><DT
142 >-t tape</DT
143 ><DD
144 ><P
145 >Tape device. May be regular file or tape 
146                 device. Default: <VAR
147 CLASS="PARAMETER"
148 >$TAPE</VAR
149 > environmental 
150                 variable; if not set, a file called <TT
151 CLASS="FILENAME"
152 >tar.out
153                 </TT
154 >. </P
155 ></DD
156 ><DT
157 >-b blocksize</DT
158 ><DD
159 ><P
160 >Blocking factor. Defaults to 20. See
161                 <B
162 CLASS="COMMAND"
163 >tar(1)</B
164 > for a fuller explanation. </P
165 ></DD
166 ><DT
167 >-N filename</DT
168 ><DD
169 ><P
170 >Backup only files newer than filename. Could 
171                 be used (for example) on a log file to implement incremental
172                 backups. </P
173 ></DD
174 ><DT
175 >-i</DT
176 ><DD
177 ><P
178 >Incremental mode; tar files are only backed 
179                 up if they have the archive bit set. The archive bit is reset 
180                 after each file is read. </P
181 ></DD
182 ><DT
183 >-r</DT
184 ><DD
185 ><P
186 >Restore. Files are restored to the share 
187                 from the tar file. </P
188 ></DD
189 ><DT
190 >-l log level</DT
191 ><DD
192 ><P
193 >Log (debug) level. Corresponds to the 
194                 <VAR
195 CLASS="PARAMETER"
196 >-d</VAR
197 > flag of <SPAN
198 CLASS="CITEREFENTRY"
199 ><SPAN
200 CLASS="REFENTRYTITLE"
201 >smbclient</SPAN
202 >(1)</SPAN
203 >.</P
204 ></DD
205 ></DL
206 ></DIV
207 ></DIV
208 ><DIV
209 CLASS="REFSECT1"
210 ><A
211 NAME="AEN104"
212 ></A
213 ><H2
214 >ENVIRONMENT VARIABLES</H2
215 ><P
216 >The <VAR
217 CLASS="PARAMETER"
218 >$TAPE</VAR
219 > variable specifies the 
220         default tape device to write to. May be overridden
221         with the -t option. </P
222 ></DIV
223 ><DIV
224 CLASS="REFSECT1"
225 ><A
226 NAME="AEN108"
227 ></A
228 ><H2
229 >BUGS</H2
230 ><P
231 >The <B
232 CLASS="COMMAND"
233 >smbtar</B
234 > script has different 
235         options from ordinary tar and from smbclient's tar command. </P
236 ></DIV
237 ><DIV
238 CLASS="REFSECT1"
239 ><A
240 NAME="AEN112"
241 ></A
242 ><H2
243 >CAVEATS</H2
244 ><P
245 >Sites that are more careful about security may not like 
246         the way the script handles PC passwords. Backup and restore work 
247         on entire shares; should work on file lists. smbtar works best
248         with GNU tar and may not work well with other versions. </P
249 ></DIV
250 ><DIV
251 CLASS="REFSECT1"
252 ><A
253 NAME="AEN115"
254 ></A
255 ><H2
256 >DIAGNOSTICS</H2
257 ><P
258 >See the <SPAN
259 CLASS="emphasis"
260 ><I
261 CLASS="EMPHASIS"
262 >DIAGNOSTICS</I
263 ></SPAN
264 > section for the <SPAN
265 CLASS="CITEREFENTRY"
266 ><SPAN
267 CLASS="REFENTRYTITLE"
268 >smbclient</SPAN
269 >(1)</SPAN
270 > command.</P
271 ></DIV
272 ><DIV
273 CLASS="REFSECT1"
274 ><A
275 NAME="AEN122"
276 ></A
277 ><H2
278 >VERSION</H2
279 ><P
280 >This man page is correct for version 3.0 of 
281         the Samba suite.</P
282 ></DIV
283 ><DIV
284 CLASS="REFSECT1"
285 ><A
286 NAME="AEN125"
287 ></A
288 ><H2
289 >SEE ALSO</H2
290 ><P
291 ><SPAN
292 CLASS="CITEREFENTRY"
293 ><SPAN
294 CLASS="REFENTRYTITLE"
295 >smbd</SPAN
296 >(8)</SPAN
297 >, <SPAN
298 CLASS="CITEREFENTRY"
299 ><SPAN
300 CLASS="REFENTRYTITLE"
301 >smbclient</SPAN
302 >(1)</SPAN
303 >, <SPAN
304 CLASS="CITEREFENTRY"
305 ><SPAN
306 CLASS="REFENTRYTITLE"
307 >smb.conf</SPAN
308 >(5)</SPAN
309 >.</P
310 ></DIV
311 ><DIV
312 CLASS="REFSECT1"
313 ><A
314 NAME="AEN137"
315 ></A
316 ><H2
317 >AUTHOR</H2
318 ><P
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
323 ><P
324 ><A
325 HREF="mailto:poultenr@logica.co.uk"
326 TARGET="_top"
327 >Ricky Poulten</A
328 >  
329         wrote the tar extension and this man page. The <B
330 CLASS="COMMAND"
331 >smbtar</B
332
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 <A
341 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
342 TARGET="_top"
343 >       ftp://ftp.icce.rug.nl/pub/unix/</A
344 >) and updated for the Samba 2.0 
345         release by Jeremy Allison.  The conversion to DocBook for 
346         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
347         Samba 3.0 was done by Alexander Bokovoy.</P
348 ></DIV
349 ></BODY
350 ></HTML
351 >