source: vendor/current/docs/manpages/smbtar.1

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 4.6 KB
Line 
1'\" t
2.\" Title: smbtar
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: User Commands
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "SMBTAR" "1" "10/25/2016" "Samba 4\&.4" "User Commands"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34smbtar [\-r] [\-i] [\-a] [\-v] {\-s\ server} [\-p\ password] [\-x\ services] [\-X] [\-N\ filename] [\-b\ blocksize] [\-d\ directory] [\-l\ loglevel] [\-u\ user] [\-t\ tape] {filenames}
35.SH "DESCRIPTION"
36.PP
37This tool is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41smbtar
42is a very small shell script on top of
43\fBsmbclient\fR(1)
44which dumps SMB shares directly to tape\&.
45.SH "OPTIONS"
46.PP
47\-s server
48.RS 4
49The SMB/CIFS server that the share resides upon\&.
50.RE
51.PP
52\-x service
53.RS 4
54The share name on the server to connect to\&. The default is "backup"\&.
55.RE
56.PP
57\-X
58.RS 4
59Exclude mode\&. Exclude filenames\&.\&.\&. from tar create or restore\&.
60.RE
61.PP
62\-d directory
63.RS 4
64Change to initial
65\fIdirectory \fR
66before restoring / backing up files\&.
67.RE
68.PP
69\-v
70.RS 4
71Verbose mode\&.
72.RE
73.PP
74\-p password
75.RS 4
76The password to use to access a share\&. Default: none
77.RE
78.PP
79\-u user
80.RS 4
81The user id to connect as\&. Default: UNIX login name\&.
82.RE
83.PP
84\-a
85.RS 4
86Reset DOS archive bit mode to indicate file has been archived\&.
87.RE
88.PP
89\-t tape
90.RS 4
91Tape device\&. May be regular file or tape device\&. Default:
92\fI$TAPE\fR
93environmental variable; if not set, a file called
94tar\&.out\&.
95.RE
96.PP
97\-b blocksize
98.RS 4
99Blocking factor\&. Defaults to 20\&. See
100tar(1)
101for a fuller explanation\&.
102.RE
103.PP
104\-N filename
105.RS 4
106Backup only files newer than filename\&. Could be used (for example) on a log file to implement incremental backups\&.
107.RE
108.PP
109\-i
110.RS 4
111Incremental mode; tar files are only backed up if they have the archive bit set\&. The archive bit is reset after each file is read\&.
112.RE
113.PP
114\-r
115.RS 4
116Restore\&. Files are restored to the share from the tar file\&.
117.RE
118.PP
119\-l log level
120.RS 4
121Log (debug) level\&. Corresponds to the
122\fI\-d\fR
123flag of
124\fBsmbclient\fR(1)\&.
125.RE
126.SH "ENVIRONMENT VARIABLES"
127.PP
128The
129\fI$TAPE\fR
130variable specifies the default tape device to write to\&. May be overridden with the \-t option\&.
131.SH "BUGS"
132.PP
133The
134smbtar
135script has different options from ordinary tar and from smbclient\*(Aqs tar command\&.
136.SH "CAVEATS"
137.PP
138Sites 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\&.
139.SH "DIAGNOSTICS"
140.PP
141See the
142\fIDIAGNOSTICS\fR
143section for the
144\fBsmbclient\fR(1)
145command\&.
146.SH "VERSION"
147.PP
148This man page is correct for version 3 of the Samba suite\&.
149.SH "SEE ALSO"
150.PP
151\fBsmbd\fR(8),
152\fBsmbclient\fR(1),
153\fBsmb.conf\fR(5)\&.
154.SH "AUTHOR"
155.PP
156The 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\&.
157.PP
158Ricky Poulten
159wrote the tar extension and this man page\&. The
160smbtar
161script was heavily rewritten and improved by
162Martin 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
163ftp://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.