Added internal cross references for all man pages.
[samba.git] / docs / yodldocs / smbtar.1.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(smbtar)(1)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(smbtar)(shell script for backing up SMB/CIFS shares directly to UNIX tape drives)
7
8 label(SYNOPSIS)
9 manpagesynopsis()
10
11 bf(smbtar) link(-s server)(minuss) [link(-p password)(minusp)] [link(-x service)(minusx)] [link(-X)(minusX)] [link(-d directory)(minusd)] [link(-u user)(minusu)] [link(-t tape)(minust)] [link(-b blocksize)(minusb)] [link(-N filename)(minusN)] [link(-i)(minusi)] [link(-r)(minusr)] [link(-l log level)(minusl)] [link(-v)(minusv)] filenames
12
13 label(DESCRIPTION)
14 manpagedescription()
15
16 This program is part of the bf(Samba) suite.
17
18 bf(smbtar) is a very small shell script on top of
19 url(bf(smbclient))(smbclient.1.html) which dumps SMB shares directly
20 to tape.
21
22 label(OPTIONS)
23 manpageoptions()
24
25 startdit()
26
27 label(minuss)
28 dit(bf(-s server)) The SMB/CIFS server that the share resides upon.
29
30 label(minusx)
31 dit(bf(-x service)) The share name on the server to connect
32 to. The default is tt(backup).
33
34 label(minusX)
35 dit(bf(-X)) Exclude mode. Exclude filenames... from tar create or
36 restore.
37
38 label(minusd)
39 dit(bf(-d directory)) Change to initial em(directory) before restoring
40 / backing up files.
41
42 label(minusv)
43 dit(bf(-v)) Verbose mode.
44
45 label(minusp)
46 dit(bf(-p password)) The password to use to access a share. Default:
47 none
48
49 label(minusu)
50 dit(bf(-u user)) The user id to connect as. Default: UNIX login name.
51
52 label(minust)
53 dit(bf(-t tape)) Tape device. May be regular file or tape
54 device. Default: em(TAPE) environmental variable; if not set, a file
55 called tt(tar.out).
56
57 label(minusb)
58 dit(bf(-b blocksize)) Blocking factor. Defaults to 20. See bf(tar (1))
59 for a fuller explanation.
60
61 label(minusN)
62 dit(bf(-N filename)) Backup only files newer than filename. Could be
63 used (for example) on a log file to implement incremental backups.
64
65 label(minusi)
66 dit(bf(-i)) Incremental mode; tar files are only backed up if they
67 have the archive bit set. The archive bit is reset after each file is
68 read.
69
70 label(minusr)
71 dit(bf(-r)) Restore. Files are restored to the share from the tar
72 file.
73
74 label(minusl)
75 dit(bf(-l log level)) Log (debug) level. Corresponds to the
76 url(bf(-d))(smbclient.1.html#minusd) flag of url(bf(smbclient
77 (1)))(smbclient.1.html).
78
79 enddit()
80
81 label(ENVIRONMENTVARIABLES)
82 manpagesection(ENVIRONMENT VARIABLES)
83
84 The TAPE variable specifies the default tape device to write to. May
85 be overridden with the link(bf(-t))(minust) option.
86
87 label(BUGS)
88 manpagesection(BUGS)
89
90 The bf(smbtar) script has different options from ordinary tar and tar
91 called from url(bf(smbclient))(smbclient.1.html).
92
93 label(CAVEATS)
94 manpagesection(CAVEATS)
95
96 Sites that are more careful about security may not like the way the
97 script handles PC passwords. Backup and restore work on entire shares,
98 should work on file lists. bf(smbtar) works best with GNU tar and may
99 not work well with other versions.
100
101 label(VERSION)
102 manpagesection(VERSION)
103
104 This man page is correct for version 2.0 of the Samba suite.
105
106 label(SEEALSO)
107 manpageseealso()
108
109 url(bf(smbclient (1)))(smbclient.1.html), url(bf(smb.conf
110 (5)))(smb.conf.5.html)
111
112 label(DIAGNOSTICS)
113 manpagesection(DIAGNOSTICS)
114
115 See the url(bf(DIAGNOSTICS))(smbclient.1.html#DIAGNOSTICS) section for
116 the url(bf(smbclient))(smbclient.1.html) command.
117
118 label(AUTHOR)
119 manpageauthor()
120
121 The original Samba software and related utilities were created by
122 Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
123 by the Samba Team as an Open Source project similar to the way the
124 Linux kernel is developed.
125
126 Ricky Poulten email(poultenr@logica.co.uk) wrote the tar extension and
127 this man page. The bf(smbtar) script was heavily rewritten and
128 improved by Martin Kraemer email(Martin.Kraemer@mch.sni.de). Many
129 thanks to everyone who suggested extensions, improvements, bug fixes,
130 etc. The man page sources were converted to YODL format (another
131 excellent piece of Open Source software) and updated for the Samba2.0
132 release by Jeremy Allison, email(samba-bugs@samba.anu.edu.au).
133  
134 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
135 list of contributors and details on how to submit bug reports,
136 comments etc.
137
138