Added fixes for become_user braindamage.
[kai/samba.git] / docs / manpages / smbtar.1
1 .TH SMBTAR 1 smbtar smbtar
2 .SH NAME
3 smbtar \- shell script for backing up SMB shares directly to UNIX tape drive
4 .SH SYNOPSIS
5 .B smbtar
6 .B \-s
7 .I server
8 [
9 .B \-p
10 .I password
11 ] [
12 .B \-x
13 .I service
14 ] [
15 .B \-X
16 ] [
17 .B \-d
18 .I directory
19 ] [
20 .B \-u
21 .I user
22 ] [
23 .B \-t
24 .I tape
25 ] [
26 .B \-b
27 .I blocksize
28 ] [
29 .B \-N
30 .I filename
31 ] [
32 .B \-i
33 ] [
34 .B \-r
35 ] [
36 .B \-l
37 .I log level
38 ] [
39 .B \-v
40 ]
41 .I filenames...
42 .SH DESCRIPTION
43 This program is an extension to the Samba suite.
44
45 .B smbtar
46 is a very small shell script on top of
47 .BR smbclient ,
48 which dumps SMB shares directly to tape.
49 .SH OPTIONS
50 .B \-s
51 .I server
52 .RS 3
53 The PC that the share resides upon.
54 .RE
55
56 .B \-x
57 .I service
58 .RS 3
59 The share name on the PC to connect to. Default:
60 .I backup.
61 .RE
62
63 .B \-X
64 .RS 3
65 Exclude mode. Exclude
66 .I filenames...
67 from tar create or restore.
68 .RE
69
70 .B \-d
71 .I directory
72 .RS 3
73 Change to initial
74 .I directory
75 before restoring / backing up files.
76 .RE
77
78 .B \-v
79 .RS 3
80 Verbose mode.
81 .RE
82
83 .B \-p
84 .I password
85
86 .RS 3
87 The password to use to access a share. Default: none
88 .RE
89
90 .B \-u
91 .I user
92 .RS 3
93 The user id to connect as. Default: UNIX login name.
94 .RE
95
96 .B \-t
97 .I tape
98 .RS 3
99 Tape device. May be regular file or tape device. Default: Tape environmental
100 variable; if not set, a file called
101 .IR tar.out .
102 .RE
103
104 .B \-b
105 .I blocksize
106 .RS 3
107 Blocking factor. Defaults to 20. See
108 .BR tar (1)
109 for a fuller explanation.
110 .RE
111
112 .B \-N
113 .I filename
114 .RS 3
115 Backup only files newer than filename. Could be used (for example) on a log
116 file to implement incremental backups.
117 .RE
118
119 .B \-i
120 .RS 3
121 Incremental mode; tar files are only backed up if they have the
122 archive bit set. The archive bit is reset after each file is read.
123 .RE
124
125 .B \-r
126 .RS 3
127 Restore. Files are restored to the share from the tar file.
128 .RE
129
130 .B \-l
131 .I log level
132 .RS 3
133 Log (debug) level. Corresponds to
134 .B \-d
135 flag of
136 .BR smbclient (1).
137 .RE
138 .SH ENVIRONMENT VARIABLES
139 The TAPE variable specifies the default tape device to write to. May
140 be overridden with the
141 .B \-t
142 option.
143 .SH BUGS
144 The
145 .B smbtar
146 script has different options from ordinary tar and tar
147 called from
148 .BR smbclient .
149 .SH CAVEATS
150 Sites that are more careful about security may not like the way
151 the script handles PC passwords. Backup and restore work on entire shares,
152 should work on file lists. smbtar works best with GNU tar and may
153 not work well with other versions.
154 .SH VERSION
155 This man page is correct for version 1.9.15p8 of the Samba suite.
156 .SH SEE ALSO
157 .BR smbclient (8), 
158 .BR smb.conf (8) 
159 .SH DIAGNOSTICS
160 See diagnostics for 
161 .B smbclient
162 command.
163 .SH CREDITS
164 The original Samba software and related utilities were created by 
165 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
166 of the Source for this project.
167
168 Ricky Poulten (poultenr@logica.co.uk) wrote the tar extension and this
169 man page. The
170 .B smbtar
171 script was heavily rewritten and improved by
172 Martin Kraemer <Martin.Kraemer@mch.sni.de>. Many thanks to everyone
173 who suggested extensions, improvements, bug fixes, etc.
174
175 See
176 .BR smb.conf (5)
177 for a full list of contributors and details of how to submit bug reports,
178 comments etc.
179