source: branches/samba-3.5.x/docs/manpages/smbtar.1@ 717

Last change on this file since 717 was 620, checked in by Herwig Bauernfeind, 14 years ago

Samba 3.5: Update trunk to 3.5.11

File size: 4.3 KB
Line 
1'\" t
2.\" Title: smbtar
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 08/02/2011
6.\" Manual: User Commands
7.\" Source: Samba 3.5
8.\" Language: English
9.\"
10.TH "SMBTAR" "1" "08/02/2011" "Samba 3\&.5" "User Commands"
11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
21.SH "NAME"
22smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives
23.SH "SYNOPSIS"
24.HP \w'\ 'u
25smbtar [\-r] [\-i] [\-a] [\-v] {\-s\ server} [\-p\ password] [\-x\ services] [\-X] [\-N\ filename] [\-b\ blocksize] [\-d\ directory] [\-l\ loglevel] [\-u\ user] [\-t\ tape] {filenames}
26.SH "DESCRIPTION"
27.PP
28This tool is part of the
29\fBsamba\fR(7)
30suite\&.
31.PP
32smbtar
33is a very small shell script on top of
34\fBsmbclient\fR(1)
35which dumps SMB shares directly to tape\&.
36.SH "OPTIONS"
37.PP
38\-s server
39.RS 4
40The SMB/CIFS server that the share resides upon\&.
41.RE
42.PP
43\-x service
44.RS 4
45The share name on the server to connect to\&. The default is "backup"\&.
46.RE
47.PP
48\-X
49.RS 4
50Exclude mode\&. Exclude filenames\&.\&.\&. from tar create or restore\&.
51.RE
52.PP
53\-d directory
54.RS 4
55Change to initial
56\fIdirectory \fR
57before restoring / backing up files\&.
58.RE
59.PP
60\-v
61.RS 4
62Verbose mode\&.
63.RE
64.PP
65\-p password
66.RS 4
67The password to use to access a share\&. Default: none
68.RE
69.PP
70\-u user
71.RS 4
72The user id to connect as\&. Default: UNIX login name\&.
73.RE
74.PP
75\-a
76.RS 4
77Reset DOS archive bit mode to indicate file has been archived\&.
78.RE
79.PP
80\-t tape
81.RS 4
82Tape device\&. May be regular file or tape device\&. Default:
83\fI$TAPE\fR
84environmental variable; if not set, a file called
85tar\&.out\&.
86.RE
87.PP
88\-b blocksize
89.RS 4
90Blocking factor\&. Defaults to 20\&. See
91tar(1)
92for a fuller explanation\&.
93.RE
94.PP
95\-N filename
96.RS 4
97Backup only files newer than filename\&. Could be used (for example) on a log file to implement incremental backups\&.
98.RE
99.PP
100\-i
101.RS 4
102Incremental mode; tar files are only backed up if they have the archive bit set\&. The archive bit is reset after each file is read\&.
103.RE
104.PP
105\-r
106.RS 4
107Restore\&. Files are restored to the share from the tar file\&.
108.RE
109.PP
110\-l log level
111.RS 4
112Log (debug) level\&. Corresponds to the
113\fI\-d\fR
114flag of
115\fBsmbclient\fR(1)\&.
116.RE
117.SH "ENVIRONMENT VARIABLES"
118.PP
119The
120\fI$TAPE\fR
121variable specifies the default tape device to write to\&. May be overridden with the \-t option\&.
122.SH "BUGS"
123.PP
124The
125smbtar
126script has different options from ordinary tar and from smbclient\'s tar command\&.
127.SH "CAVEATS"
128.PP
129Sites that are more careful about security may not like the way the script handles PC passwords\&. Backup and restore work on entire shares; should work on file lists\&. smbtar works best with GNU tar and may not work well with other versions\&.
130.SH "DIAGNOSTICS"
131.PP
132See the
133\fIDIAGNOSTICS\fR
134section for the
135\fBsmbclient\fR(1)
136command\&.
137.SH "VERSION"
138.PP
139This man page is correct for version 3 of the Samba suite\&.
140.SH "SEE ALSO"
141.PP
142\fBsmbd\fR(8),
143\fBsmbclient\fR(1),
144\fBsmb.conf\fR(5)\&.
145.SH "AUTHOR"
146.PP
147The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
148.PP
149Ricky Poulten
150wrote the tar extension and this man page\&. The
151smbtar
152script was heavily rewritten and improved by
153Martin Kraemer\&. Many thanks to everyone who suggested extensions, improvements, bug fixes, etc\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at
154ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
Note: See TracBrowser for help on using the repository browser.