large sync up with 2.2
[ira/wip.git] / docs / manpages / smbtar.1
1 .\" This manpage has been automatically generated by docbook2man-spec
2 .\" from a DocBook document.  docbook2man-spec can be found at:
3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH SMBTAR 1 "24 Mar 2001" "smbtar 2.2.0-alpha3"
7 .SH NAME
8 smbtar \- shell script for backing up SMB/CIFS shares  directly to UNIX tape drives
9 .SH SYNOPSIS
10 .sp
11 \fBsmbtar\fR \fB-s server\fR [ \fB-p password\fR ]  [ \fB-x services\fR ]  [ \fB-X\fR ]  [ \fB-d directory\fR ]  [ \fB-u user\fR ]  [ \fB-t tape\fR ]  [ \fB-t tape\fR ]  [ \fB-b blocksize\fR ]  [ \fB-N filename\fR ]  [ \fB-i\fR ]  [ \fB-r\fR ]  [ \fB-l loglevel\fR ]  [ \fB-v\fR ]  \fBfilenames\fR
12 .SH "DESCRIPTION"
13 .PP
14 This tool is part of the  Sambasuite.
15 .PP
16 \fBsmbtar\fR is a very small shell script on top 
17 of \fBsmbclient(1)\fRwhich dumps SMB shares directly to tape. 
18 .SH "OPTIONS"
19 .TP
20 \fB-s server\fR
21 The SMB/CIFS server that the share resides 
22 upon.
23 .TP
24 \fB-x service\fR
25 The share name on the server to connect to. 
26 The default is "backup".
27 .TP
28 \fB-X\fR
29 Exclude mode. Exclude filenames... from tar 
30 create or restore. 
31 .TP
32 \fB-d directory\fR
33 Change to initial \fIdirectory
34 \fRbefore restoring / backing up files. 
35 .TP
36 \fB-v\fR
37 Verbose mode.
38 .TP
39 \fB-p password\fR
40 The password to use to access a share. 
41 Default: none 
42 .TP
43 \fB-u user\fR
44 The user id to connect as. Default: 
45 UNIX login name. 
46 .TP
47 \fB-t tape\fR
48 Tape device. May be regular file or tape 
49 device. Default: \fI$TAPE\fR environmental 
50 variable; if not set, a file called \fItar.out
51 \fR\&. 
52 .TP
53 \fB-b blocksize\fR
54 Blocking factor. Defaults to 20. See
55 \fBtar(1)\fR for a fuller explanation. 
56 .TP
57 \fB-N filename\fR
58 Backup only files newer than filename. Could 
59 be used (for example) on a log file to implement incremental
60 backups. 
61 .TP
62 \fB-i\fR
63 Incremental mode; tar files are only backed 
64 up if they have the archive bit set. The archive bit is reset 
65 after each file is read. 
66 .TP
67 \fB-r\fR
68 Restore. Files are restored to the share 
69 from the tar file. 
70 .TP
71 \fB-l log level\fR
72 Log (debug) level. Corresponds to the 
73 \fI-d\fR flag of \fBsmbclient(1)
74 \fR\&. 
75 .SH "ENVIRONMENT VARIABLES"
76 .PP
77 The \fI$TAPE\fR variable specifies the 
78 default tape device to write to. May be overridden
79 with the -t option. 
80 .SH "BUGS"
81 .PP
82 The \fBsmbtar\fR script has different 
83 options from ordinary tar and tar called from smbclient. 
84 .SH "CAVEATS"
85 .PP
86 Sites that are more careful about security may not like 
87 the way the script handles PC passwords. Backup and restore work 
88 on entire shares, should work on file lists. smbtar works best
89 with GNU tar and may not work well with other versions. 
90 .SH "DIAGNOSTICS"
91 .PP
92 See the \fBDIAGNOSTICS\fR section for the 
93 \fBsmbclient(1)\fR 
94 command.
95 .SH "VERSION"
96 .PP
97 This man page is correct for version 2.2 of 
98 the Samba suite.
99 .SH "SEE ALSO"
100 .PP
101 \fBsmbd(8)\fR, 
102 \fBsmbclient(1)\fR, 
103 smb.conf(5),
104 .SH "AUTHOR"
105 .PP
106 The original Samba software and related utilities 
107 were created by Andrew Tridgell. Samba is now developed
108 by the Samba Team as an Open Source project similar 
109 to the way the Linux kernel is developed.
110 .PP
111 Ricky Poulten <URL:mailto:poultenr@logica.co.uk> 
112 wrote the tar extension and this man page. The \fBsmbtar\fR 
113 script was heavily rewritten and improved by Martin Kraemer <URL:mailto:Martin.Kraemer@mch.sni.de>. Many 
114 thanks to everyone who suggested extensions, improvements, bug 
115 fixes, etc. The man page sources were converted to YODL format (another 
116 excellent piece of Open Source software, available at
117 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
118 release by Jeremy Allison. The conversion to DocBook for 
119 Samba 2.2 was done by Gerald Carter.