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