trying to get HEAD building again. If you want the code
[kai/samba-autobuild/.git] / docs / htmldocs / smbtar.1.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbtar</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbtar.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbtar &#8212; shell script for backing up SMB/CIFS shares 
2         directly to UNIX tape drives</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbtar</tt>  [-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></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">smbtar</b> is a very small shell script on top 
3         of <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a> which dumps SMB shares directly to tape.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s server</span></dt><dd><p>The SMB/CIFS server that the share resides 
4                 upon.</p></dd><dt><span class="term">-x service</span></dt><dd><p>The share name on the server to connect to. 
5                 The default is &quot;backup&quot;.</p></dd><dt><span class="term">-X</span></dt><dd><p>Exclude mode. Exclude filenames... from tar 
6                 create or restore. </p></dd><dt><span class="term">-d directory</span></dt><dd><p>Change to initial <i class="parameter"><tt>directory
7                 </tt></i> before restoring / backing up files. </p></dd><dt><span class="term">-v</span></dt><dd><p>Verbose mode.</p></dd><dt><span class="term">-p password</span></dt><dd><p>The password to use to access a share. 
8                 Default: none </p></dd><dt><span class="term">-u user</span></dt><dd><p>The user id to connect as. Default: 
9                 UNIX login name. </p></dd><dt><span class="term">-a</span></dt><dd><p>Reset DOS archive bit mode to 
10                 indicate file has been archived. </p></dd><dt><span class="term">-t tape</span></dt><dd><p>Tape device. May be regular file or tape 
11                 device. Default: <i class="parameter"><tt>$TAPE</tt></i> environmental 
12                 variable; if not set, a file called <tt class="filename">tar.out
13                 </tt>. </p></dd><dt><span class="term">-b blocksize</span></dt><dd><p>Blocking factor. Defaults to 20. See
14                 <b class="command">tar(1)</b> for a fuller explanation. </p></dd><dt><span class="term">-N filename</span></dt><dd><p>Backup only files newer than filename. Could 
15                 be used (for example) on a log file to implement incremental
16                 backups. </p></dd><dt><span class="term">-i</span></dt><dd><p>Incremental mode; tar files are only backed 
17                 up if they have the archive bit set. The archive bit is reset 
18                 after each file is read. </p></dd><dt><span class="term">-r</span></dt><dd><p>Restore. Files are restored to the share 
19                 from the tar file. </p></dd><dt><span class="term">-l log level</span></dt><dd><p>Log (debug) level. Corresponds to the 
20                 <i class="parameter"><tt>-d</tt></i> flag of <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>ENVIRONMENT VARIABLES</h2><p>The <i class="parameter"><tt>$TAPE</tt></i> variable specifies the 
21         default tape device to write to. May be overridden
22         with the -t option. </p></div><div class="refsect1" lang="en"><h2>BUGS</h2><p>The <b class="command">smbtar</b> script has different 
23         options from ordinary tar and from smbclient's tar command. </p></div><div class="refsect1" lang="en"><h2>CAVEATS</h2><p>Sites that are more careful about security may not like 
24         the way the script handles PC passwords. Backup and restore work 
25         on entire shares; should work on file lists. smbtar works best
26         with GNU tar and may not work well with other versions. </p></div><div class="refsect1" lang="en"><h2>DIAGNOSTICS</h2><p>See the <span class="emphasis"><em>DIAGNOSTICS</em></span> section for the <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a> command.</p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of 
27         the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities 
28         were created by Andrew Tridgell. Samba is now developed
29         by the Samba Team as an Open Source project similar 
30         to the way the Linux kernel is developed.</p><p><a href="mailto:poultenr@logica.co.uk" target="_top">Ricky Poulten</a>  
31         wrote the tar extension and this man page. The <b class="command">smbtar</b> 
32         script was heavily rewritten and improved by <a href="mailto:Martin.Kraemer@mch.sni.de" target="_top">Martin Kraemer</a>. Many 
33         thanks to everyone who suggested extensions, improvements, bug 
34         fixes, etc. The man page sources were converted to YODL format (another 
35         excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
36         ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 
37         release by Jeremy Allison.  The conversion to DocBook for 
38         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
39         Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>