summaryrefslogtreecommitdiff
path: root/docs/manpages/smbtar.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/smbtar.1')
-rw-r--r--docs/manpages/smbtar.1245
1 files changed, 120 insertions, 125 deletions
diff --git a/docs/manpages/smbtar.1 b/docs/manpages/smbtar.1
index f7979b76b1..ab9f95fcbe 100644
--- a/docs/manpages/smbtar.1
+++ b/docs/manpages/smbtar.1
@@ -1,125 +1,120 @@
-.TH "smbtar " "1" "23 Oct 1998" "Samba" "SAMBA"
-.PP
-.SH "NAME"
-smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives
-.PP
-.SH "SYNOPSIS"
-.PP
-\fBsmbtar\fP -s server [-p password] [-x service] [-X] [-d directory] [-u user] [-t tape] [-b blocksize] [-N filename] [-i] [-r] [-l log level] [-v] filenames
-.PP
-.SH "DESCRIPTION"
-.PP
-This program is part of the \fBSamba\fP suite\&.
-.PP
-\fBsmbtar\fP is a very small shell script on top of
-\fBsmbclient\fP which dumps SMB shares directly
-to tape\&.
-.PP
-.SH "OPTIONS"
-.PP
-.IP
-.IP "\fB-s server\fP"
-The SMB/CIFS server that the share resides upon\&.
-.IP
-.IP "\fB-x service\fP"
-The share name on the server to connect
-to\&. The default is \f(CWbackup\fP\&.
-.IP
-.IP "\fB-X\fP"
-Exclude mode\&. Exclude filenames\&.\&.\&. from tar create or
-restore\&.
-.IP
-.IP "\fB-d directory\fP"
-Change to initial \fIdirectory\fP before restoring
-/ backing up files\&.
-.IP
-.IP "\fB-v\fP"
-Verbose mode\&.
-.IP
-.IP "\fB-p password\fP"
-The password to use to access a share\&. Default:
-none
-.IP
-.IP "\fB-u user\fP"
-The user id to connect as\&. Default: UNIX login name\&.
-.IP
-.IP "\fB-t tape\fP"
-Tape device\&. May be regular file or tape
-device\&. Default: \fITAPE\fP environmental variable; if not set, a file
-called \f(CWtar\&.out\fP\&.
-.IP
-.IP "\fB-b blocksize\fP"
-Blocking factor\&. Defaults to 20\&. See \fBtar (1)\fP
-for a fuller explanation\&.
-.IP
-.IP "\fB-N filename\fP"
-Backup only files newer than filename\&. Could be
-used (for example) on a log file to implement incremental backups\&.
-.IP
-.IP "\fB-i\fP"
-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\&.
-.IP
-.IP "\fB-r\fP"
-Restore\&. Files are restored to the share from the tar
-file\&.
-.IP
-.IP "\fB-l log level\fP"
-Log (debug) level\&. Corresponds to the
-\fB-d\fP flag of \fBsmbclient
-(1)\fP\&.
-.IP
-.PP
-.SH "ENVIRONMENT VARIABLES"
-.PP
-The TAPE variable specifies the default tape device to write to\&. May
-be overridden with the \fB-t\fP option\&.
-.PP
-.SH "BUGS"
-.PP
-The \fBsmbtar\fP script has different options from ordinary tar and tar
-called from \fBsmbclient\fP\&.
-.PP
-.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\&. \fBsmbtar\fP works best with GNU tar and may
-not work well with other versions\&.
-.PP
-.SH "VERSION"
-.PP
-This man page is correct for version 2\&.0 of the Samba suite\&.
-.PP
-.SH "SEE ALSO"
-.PP
-\fBsmbclient (1)\fP, \fBsmb\&.conf
-(5)\fP
-.PP
-.SH "DIAGNOSTICS"
-.PP
-See the \fBDIAGNOSTICS\fP section for
-the \fBsmbclient\fP command\&.
-.PP
-.SH "AUTHOR"
-.PP
-The original Samba software and related utilities were created by
-Andrew Tridgell samba@samba\&.org\&. 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 poultenr@logica\&.co\&.uk wrote the tar extension and
-this man page\&. The \fBsmbtar\fP 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\&. The man page sources were converted to YODL format (another
-excellent piece of Open Source software available at
-\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
-and updated for the Samba2\&.0 release by Jeremy Allison,
-samba@samba\&.org\&.
-.PP
-See \fBsamba (7)\fP to find out how to get a full
-list of contributors and details on how to submit bug reports,
-comments etc\&.
-.PP
+.\" 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" "22 February 2001" "" ""
+.SH NAME
+smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives
+.SH SYNOPSIS
+.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 Samba <URL:samba.7.html> suite.
+.PP
+\fBsmbtar\fR is a very small shell script on top
+of \fBsmbclient(1)\fR <URL:smbclient.1.html>
+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.
+.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
+ <URL:smbclient.1.html> command.
+.SH "VERSION"
+.PP
+This man page is correct for version 2.2 of
+the Samba suite.
+.SH "SEE ALSO"
+.PP
+\fBsmbd(8)\fR <URL:smbd.8.html>,
+\fBsmbclient(1)\fR <URL:smbclient.1.html>,
+smb.conf(5) <URL:smb.conf.5.html>,
+.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.