Changeset 231 for branches/samba-3.2.x/docs/manpages/smbtar.1

Timestamp:

May 27, 2009, 9:08:03 AM (16 years ago)

Author:

Herwig Bauernfeind

Message:

Update 3.2 branch to 3.2.8 docs

File:

• branches/samba-3.2.x/docs/manpages/smbtar.1 (modified) (4 diffs)

branches/samba-3.2.x/docs/manpages/smbtar.1

@@ -1 +1 @@
 .\"     Title: smbtar
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
-.\"      Date: 12/19/2008
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 02/03/2009
 .\"    Manual: User Commands
 .\"    Source: Samba 3.2
+.\"  Language: English
 .\"
-.TH "SMBTAR" "1" "12/19/2008" "Samba 3\.2" "User Commands"
+.TH "SMBTAR" "1" "02/03/2009" "Samba 3\&.2" "User Commands"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
-.SH "NAME"
-smbtar - shell script for backing up SMB/CIFS shares directly to UNIX tape drives
-.SH "SYNOPSIS"
-.HP 1
-smbtar [\-r] [\-i] [\-a] [\-v] {\-s\ server} [\-p\ password] [\-x\ services] [\-X] [\-N\ filename] [\-b\ blocksize] [\-d\ directory] [\-l\ loglevel] [\-u\ user] [\-t\ tape] {filenames}
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives
+.SH "Synopsis"
+.fam C
+.HP \w'\ 'u
+\FCsmbtar\F[] [\-r] [\-i] [\-a] [\-v] {\-s\ server} [\-p\ password] [\-x\ services] [\-X] [\-N\ filename] [\-b\ blocksize] [\-d\ directory] [\-l\ loglevel] [\-u\ user] [\-t\ tape] {filenames}
+.fam
 .SH "DESCRIPTION"
 .PP
 This tool is part of the
 \fBsamba\fR(7)
-suite\.
-.PP
-smbtar
+suite\&.
+.PP
+\FCsmbtar\F[]
 is a very small shell script on top of
 \fBsmbclient\fR(1)
-which dumps SMB shares directly to tape\.
+which dumps SMB shares directly to tape\&.
 .SH "OPTIONS"
 .PP
 \-s server
 .RS 4
-The SMB/CIFS server that the share resides upon\.
+The SMB/CIFS server that the share resides upon\&.
 .RE
 .PP
 \-x service
 .RS 4
-The share name on the server to connect to\. The default is "backup"\.
+The share name on the server to connect to\&. The default is "backup"\&.
 .RE
 .PP
 \-X
 .RS 4
-Exclude mode\. Exclude filenames\.\.\. from tar create or restore\.
+Exclude mode\&. Exclude filenames\&.\&.\&. from tar create or restore\&.
 .RE
 .PP
@@ -47 +205 @@
 Change to initial
 \fIdirectory \fR
-before restoring / backing up files\.
+before restoring / backing up files\&.
 .RE
 .PP
 \-v
 .RS 4
-Verbose mode\.
+Verbose mode\&.
 .RE
 .PP
 \-p password
 .RS 4
-The password to use to access a share\. Default: none
+The password to use to access a share\&. Default: none
 .RE
 .PP
 \-u user
 .RS 4
-The user id to connect as\. Default: UNIX login name\.
+The user id to connect as\&. Default: UNIX login name\&.
 .RE
 .PP
 \-a
 .RS 4
-Reset DOS archive bit mode to indicate file has been archived\.
+Reset DOS archive bit mode to indicate file has been archived\&.
 .RE
 .PP
 \-t tape
 .RS 4
-Tape device\. May be regular file or tape device\. Default:
+Tape device\&. May be regular file or tape device\&. Default:
 \fI$TAPE\fR
 environmental variable; if not set, a file called
-\fItar\.out \fR\.
+\FCtar\&.out \F[]\&.
 .RE
 .PP
 \-b blocksize
 .RS 4
-Blocking factor\. Defaults to 20\. See
-tar(1)
-for a fuller explanation\.
+Blocking factor\&. Defaults to 20\&. See
+\FCtar(1)\F[]
+for a fuller explanation\&.
 .RE
 .PP
 \-N filename
 .RS 4
-Backup only files newer than filename\. Could be used (for example) on a log file to implement incremental backups\.
+Backup only files newer than filename\&. Could be used (for example) on a log file to implement incremental backups\&.
 .RE
 .PP
 \-i
 .RS 4
-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\.
+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
 .PP
 \-r
 .RS 4
-Restore\. Files are restored to the share from the tar file\.
+Restore\&. Files are restored to the share from the tar file\&.
 .RE
 .PP
 \-l log level
 .RS 4
-Log (debug) level\. Corresponds to the
+Log (debug) level\&. Corresponds to the
 \fI\-d\fR
 flag of
-\fBsmbclient\fR(1)\.
+\fBsmbclient\fR(1)\&.
 .RE
 .SH "ENVIRONMENT VARIABLES"
@@ -111 +269 @@
 The
 \fI$TAPE\fR
-variable specifies the default tape device to write to\. May be overridden with the \-t option\.
+variable specifies the default tape device to write to\&. May be overridden with the \-t option\&.
 .SH "BUGS"
 .PP
 The
-smbtar
-script has different options from ordinary tar and from smbclient\'s tar command\.
+\FCsmbtar\F[]
+script has different options from ordinary tar and from smbclient\'s tar command\&.
 .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\.
+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
@@ -126 +284 @@
 section for the
 \fBsmbclient\fR(1)
-command\.
+command\&.
 .SH "VERSION"
 .PP
-This man page is correct for version 3 of the Samba suite\.
+This man page is correct for version 3 of the Samba suite\&.
 .SH "SEE ALSO"
 .PP
 \fBsmbd\fR(8),
 \fBsmbclient\fR(1),
-\fBsmb.conf\fR(5)\.
+\fBsmb.conf\fR(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\.
+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
-wrote the tar extension and this man page\. The
-smbtar
+wrote the tar extension and this man page\&. The
+\FCsmbtar\F[]
 script was heavily rewritten and improved by
-Martin Kraemer\. 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/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\.
+Martin Kraemer\&. 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/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.