27b4466777951ff6435e80fbd23c3f43a65d404f
[samba.git] / docs / yodldocs / smbtar.1.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(smbtar)(1)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(smbtar)(shell script for backing up SMB/CIFS shares directly to UNIX tape drives)
7
8 label(SYNOPSIS)
9 manpagesynopsis()
10
11 bf(smbtar) -s server [-p password] [-x service] [-X] [-d directory] [-u user] [-t tape] [-b blocksize] [-N filename] [-i] [-r] [-l log level] [-v] filenames
12
13 label(DESCRIPTION)
14 manpagedescription()
15
16 This program is part of the bf(Samba) suite.
17
18 bf(smbtar) is a very small shell script on top of
19 url(bf(smbclient))(smbclient.1.html) which dumps SMB shares directly
20 to tape.
21
22 label(OPTIONS)
23 manpageoptions()
24
25 startdit()
26
27 dit(bf(-s server)) The SMB/CIFS server that the share resides upon.
28
29 dit(bf(-x service)) The share name on the server to connect
30 to. The default is tt(backup).
31
32 dit(bf(-X)) Exclude mode. Exclude filenames... from tar create or
33 restore.
34
35 dit(bf(-d directory)) Change to initial em(directory) before restoring
36 / backing up files.
37
38 dit(bf(-v)) Verbose mode.
39
40 dit(bf(-p password)) The password to use to access a share. Default:
41 none
42
43 dit(bf(-u user)) The user id to connect as. Default: UNIX login name.
44
45 label(minust)
46 dit(bf(-t tape)) Tape device. May be regular file or tape
47 device. Default: em(TAPE) environmental variable; if not set, a file
48 called tt(tar.out).
49
50 dit(bf(-b blocksize)) Blocking factor. Defaults to 20. See bf(tar (1))
51 for a fuller explanation.
52
53 dit(bf(-N filename)) Backup only files newer than filename. Could be
54 used (for example) on a log file to implement incremental backups.
55
56 dit(bf(-i)) Incremental mode; tar files are only backed up if they
57 have the archive bit set. The archive bit is reset after each file is
58 read.
59
60 dit(bf(-r)) Restore. Files are restored to the share from the tar
61 file.
62
63 dit(bf(-l log level)) Log (debug) level. Corresponds to the
64 url(bf(-d))(smbclient.1.html#minusd) flag of url(bf(smbclient
65 (1)))(smbclient.1.html).
66
67 enddit()
68
69 label(ENVIRONMENTVARIABLES)
70 manpagesection(ENVIRONMENT VARIABLES)
71
72 The TAPE variable specifies the default tape device to write to. May
73 be overridden with the link(bf(-t))(minust) option.
74
75 label(BUGS)
76 manpagesection(BUGS)
77
78 The bf(smbtar) script has different options from ordinary tar and tar
79 called from url(bf(smbclient))(smbclient.1.html).
80
81 label(CAVEATS)
82 manpagesection(CAVEATS)
83
84 Sites that are more careful about security may not like the way the
85 script handles PC passwords. Backup and restore work on entire shares,
86 should work on file lists. bf(smbtar) works best with GNU tar and may
87 not work well with other versions.
88
89 label(VERSION)
90 manpagesection(VERSION)
91
92 This man page is correct for version 2.0 of the Samba suite.
93
94 label(SEEALSO)
95 manpageseealso()
96
97 url(bf(smbclient (1)))(smbclient.1.html), url(bf(smb.conf
98 (5)))(smb.conf.5.html)
99
100 label(DIAGNOSTICS)
101 manpagesection(DIAGNOSTICS)
102
103 See the url(bf(DIAGNOSTICS))(smbclient.1.html#DIAGNOSTICS) section for
104 the url(bf(smbclient))(smbclient.1.html) command.
105
106 label(AUTHOR)
107 manpageauthor()
108
109 The original Samba software and related utilities were created by
110 Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
111 by the Samba Team as an Open Source project similar to the way the
112 Linux kernel is developed.
113
114 Ricky Poulten email(poultenr@logica.co.uk) wrote the tar extension and
115 this man page. The bf(smbtar) script was heavily rewritten and
116 improved by Martin Kraemer email(Martin.Kraemer@mch.sni.de). Many
117 thanks to everyone who suggested extensions, improvements, bug fixes,
118 etc. The man page sources were converted to YODL format (another
119 excellent piece of Open Source software) and updated for the Samba2.0
120 release by Jeremy Allison, email(samba-bugs@samba.anu.edu.au).
121  
122 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
123 list of contributors and details on how to submit bug reports,
124 comments etc.
125
126