Changeset 231 for branches/samba-3.2.x/docs/manpages/tdbbackup.8

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/tdbbackup.8 (modified) (7 diffs)

branches/samba-3.2.x/docs/manpages/tdbbackup.8

@@ -1 +1 @@
 .\"     Title: tdbbackup
-.\"    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: System Administration tools
 .\"    Source: Samba 3.2
+.\"  Language: English
 .\"
-.TH "TDBBACKUP" "8" "12/19/2008" "Samba 3\.2" "System Administration tools"
+.TH "TDBBACKUP" "8" "02/03/2009" "Samba 3\&.2" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * (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"
-tdbbackup - tool for backing up and for validating the integrity of samba .tdb files
-.SH "SYNOPSIS"
-.HP 1
-tdbbackup [\-s\ suffix] [\-v] [\-h]
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+tdbbackup \- tool for backing up and for validating the integrity of samba \&.tdb files
+.SH "Synopsis"
+.fam C
+.HP \w'\ 'u
+\FCtdbbackup\F[] [\-s\ suffix] [\-v] [\-h]
+.fam
 .SH "DESCRIPTION"
 .PP
 This tool is part of the
 \fBsamba\fR(1)
-suite\.
-.PP
-tdbbackup
-is a tool that may be used to backup samba \.tdb files\. This tool may also be used to verify the integrity of the \.tdb files prior to samba startup or during normal operation\. If it finds file damage and it finds a prior backup the backup file will be restored\.
+suite\&.
+.PP
+\FCtdbbackup\F[]
+is a tool that may be used to backup samba \&.tdb files\&. This tool may also be used to verify the integrity of the \&.tdb files prior to samba startup or during normal operation\&. If it finds file damage and it finds a prior backup the backup file will be restored\&.
 .SH "OPTIONS"
 .PP
 \-h
 .RS 4
-Get help information\.
+Get help information\&.
 .RE
 .PP
@@ -34 +192 @@
 .RS 4
 The
-\-s
-option allows the adminisistrator to specify a file backup extension\. This way it is possible to keep a history of tdb backup files by using a new suffix for each backup\.
+\FC\-s\F[]
+option allows the adminisistrator to specify a file backup extension\&. This way it is possible to keep a history of tdb backup files by using a new suffix for each backup\&.
 .RE
 .PP
@@ -41 +199 @@
 .RS 4
 The
-\-v
-will check the database for damages (currupt data) which if detected causes the backup to be restored\.
+\FC\-v\F[]
+will check the database for damages (currupt data) which if detected causes the backup to be restored\&.
 .RE
 .SH "COMMANDS"
@@ -49 +207 @@
 .PP
 The
-tdbbackup
-utility can safely be run at any time\. It was designed so that it can be used at any time to validate the integrity of tdb files, even during Samba operation\. Typical usage for the command will be:
-.PP
-tdbbackup [\-s suffix] *\.tdb
-.PP
-Before restarting samba the following command may be run to validate \.tdb files:
-.PP
-tdbbackup \-v [\-s suffix] *\.tdb
-.PP
-Samba \.tdb files are stored in various locations, be sure to run backup all \.tdb file on the system\. Important files includes:
+\FCtdbbackup\F[]
+utility can safely be run at any time\&. It was designed so that it can be used at any time to validate the integrity of tdb files, even during Samba operation\&. Typical usage for the command will be:
+.PP
+tdbbackup [\-s suffix] *\&.tdb
+.PP
+Before restarting samba the following command may be run to validate \&.tdb files:
+.PP
+tdbbackup \-v [\-s suffix] *\&.tdb
+.PP
+Samba \&.tdb files are stored in various locations, be sure to run backup all \&.tdb file on the system\&. Important files includes:
 .sp
 .RS 4
@@ -69 +227 @@
 .\}
 
-secrets\.tdb
-\- usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\.
+\FCsecrets\&.tdb\F[]
+\- usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\&.
 .RE
 .sp
@@ -82 +240 @@
 .\}
 
-passdb\.tdb
-\- usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\.
+\FCpassdb\&.tdb\F[]
+\- usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\&.
 .RE
 .sp
@@ -95 +253 @@
 .\}
 
-*\.tdb
-located in the /usr/local/samba/var directory or on some systems in the /var/cache or /var/lib/samba directories\.
+\FC*\&.tdb\F[]
+located in the /usr/local/samba/var directory or on some systems in the /var/cache or /var/lib/samba directories\&.
 .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 "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
-The tdbbackup man page was written by John H Terpstra\.
+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
+The tdbbackup man page was written by John H Terpstra\&.