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