diff options
Diffstat (limited to 'docs/manpages/smbtar.1')
| -rw-r--r-- | docs/manpages/smbtar.1 | 279 |
1 files changed, 116 insertions, 163 deletions
diff --git a/docs/manpages/smbtar.1 b/docs/manpages/smbtar.1 index 0f1c38c271f..8e70d75fd81 100644 --- a/docs/manpages/smbtar.1 +++ b/docs/manpages/smbtar.1 @@ -1,167 +1,120 @@ -.TH SMBTAR 1 18/2/96 smbtar smbtar +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "SMBTAR" "1" "06 December 2001" "" "" .SH NAME -smbtar \- shell script for backing up SMB shares directly to UNIX tape drive +smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives .SH SYNOPSIS -.B smbtar -.B \-s -.I server -.B [ \-p -.I password -.B ] -.B [ \-x -.I service -.B ] -.B [ \-X ] -.B [ \-d -.I directory -.B ] -.B [ \-u -.I user -.B ] -.B [ \-t -.I tape -.B ] -.B [ \-b -.I blocksize -.B ] -.B [ \-N -.I filename -.B ] -.B [ \-i ] -.B [ \-r ] -.B [ \-l ] -.B [ \-v ] -.I filenames... - -.SH DESCRIPTION -This program is an extension to the Samba suite. - -.B smbtar -is a very small shell script on top of smbclient, which dumps SMB -shares directly to tape. - -.SH OPTIONS -.B \-s -.I server -.RS 3 -The PC that the share resides upon. -.RE - -.B \-x -.I service -.RS 3 -The share name on the PC to connect to. Default: -.I backup. -.RE - -.B \-X -.RS 3 -Exclude mode. Exclude -.I filenames... -from tar create or restore. -.RE - -.B \-d -.I directory -.RS 3 -Change to initial -.I directory -before restoring / backing up files. -.RE - -.B \-v -.RS 3 +.sp +\fBsmbtar\fR \fB-s server\fR [ \fB-p password\fR ] [ \fB-x services\fR ] [ \fB-X\fR ] [ \fB-d directory\fR ] [ \fB-u user\fR ] [ \fB-t tape\fR ] [ \fB-t tape\fR ] [ \fB-b blocksize\fR ] [ \fB-N filename\fR ] [ \fB-i\fR ] [ \fB-r\fR ] [ \fB-l loglevel\fR ] [ \fB-v\fR ] \fBfilenames\fR +.SH "DESCRIPTION" +.PP +This tool is part of the Sambasuite. +.PP +\fBsmbtar\fR is a very small shell script on top +of \fBsmbclient(1)\fR +which dumps SMB shares directly to tape. +.SH "OPTIONS" +.TP +\fB-s server\fR +The SMB/CIFS server that the share resides +upon. +.TP +\fB-x service\fR +The share name on the server to connect to. +The default is "backup". +.TP +\fB-X\fR +Exclude mode. Exclude filenames... from tar +create or restore. +.TP +\fB-d directory\fR +Change to initial \fIdirectory +\fRbefore restoring / backing up files. +.TP +\fB-v\fR Verbose mode. -.RE - -.B \-p -.I password - -.RS 3 -The password to use to access a share. Default: none -.RE - -.B \-u -.I user -.RS 3 -The user id to connect as. Default: UNIX login name. -.RE - -.B \-t -.I tape -.RS 3 -Tape device. May be regular file or tape device. Default: Tape environmental -variable; if not set, a file called -.I tar.out. -.RE - -.B \-b -.I blocksize -.RS 3 -Blocking factor. Defaults to 20. See tar(1) for a fuller explanation. -.RE - -.B \-N -.I filename -.RS 3 -Backup only files newer than filename. Could be used (for example) on a log -file to implement incremental backups. -.RE - -.B \-i -.RS 3 -Incremental mode; tar files are only backed up if they have the -archive bit set. The archive bit is reset after each file is read. -.RE - -.B \-r -.RS 3 -Restore. Files are restored to the share from the tar file. -.RE - -.B \-l -.RS 3 -Debug level. Corresponds to -d flag on smbclient(1). -.RE - -.SH ENVIRONMENT VARIABLES -The TAPE variable specifies the default tape device to write to. May -be overidden with the -t option. - -.SH BUGS -The smbtar script has different options from ordinary tar and tar -called from smbclient. - -.SH CAVEATS -Sites 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. - -.SH VERSION -This man page is correct for version 1.9.15p8 of the Samba suite. - -.SH SEE ALSO -.B smbclient -(8), -.B smb.conf -(8) -.SH DIAGNOSTICS -See diagnostics for -.B smbclient +.TP +\fB-p password\fR +The password to use to access a share. +Default: none +.TP +\fB-u user\fR +The user id to connect as. Default: +UNIX login name. +.TP +\fB-t tape\fR +Tape device. May be regular file or tape +device. Default: \fI$TAPE\fR environmental +variable; if not set, a file called \fItar.out +\fR\&. +.TP +\fB-b blocksize\fR +Blocking factor. Defaults to 20. See +\fBtar(1)\fR for a fuller explanation. +.TP +\fB-N filename\fR +Backup only files newer than filename. Could +be used (for example) on a log file to implement incremental +backups. +.TP +\fB-i\fR +Incremental mode; tar files are only backed +up if they have the archive bit set. The archive bit is reset +after each file is read. +.TP +\fB-r\fR +Restore. Files are restored to the share +from the tar file. +.TP +\fB-l log level\fR +Log (debug) level. Corresponds to the +\fI-d\fR flag of \fBsmbclient(1) +\fR\&. +.SH "ENVIRONMENT VARIABLES" +.PP +The \fI$TAPE\fR variable specifies the +default tape device to write to. May be overridden +with the -t option. +.SH "BUGS" +.PP +The \fBsmbtar\fR script has different +options from ordinary tar and tar called from smbclient. +.SH "CAVEATS" +.PP +Sites 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. +.SH "DIAGNOSTICS" +.PP +See the \fBDIAGNOSTICS\fR section for the +\fBsmbclient(1)\fR command. - -.SH CREDITS -The original Samba software and related utilities were created by -Andrew Tridgell (samba-bugs@anu.edu.au). Andrew is also the Keeper -of the Source for this project. - -Ricky Poulten (poultenr@logica.co.uk) wrote the tar extension and this -man page. The smbtar script was heavily rewritten and improved by -Martin Kraemer <Martin.Kraemer@mch.sni.de>. Many thanks to everyone -who suggested extensions, improvements, bug fixes, etc. - -See -.B smb.conf -(5) for a full list of contributors and details of how to submit bug reports, -comments etc. - +.SH "VERSION" +.PP +This man page is correct for version 2.2 of +the Samba suite. +.SH "SEE ALSO" +.PP +\fBsmbd(8)\fR, +\fBsmbclient(1)\fR, +smb.conf(5), +.SH "AUTHOR" +.PP +The 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. +.PP +Ricky Poulten <URL:mailto:poultenr@logica.co.uk> +wrote the tar extension and this man page. The \fBsmbtar\fR +script was heavily rewritten and improved by Martin Kraemer <URL:mailto:Martin.Kraemer@mch.sni.de>. 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 +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://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. |