From ede2aaef281048123cacab9ae879f5c546787080 Mon Sep 17 00:00:00 2001 From: Karolin Seeger Date: Fri, 30 Nov 2012 09:39:22 +0100 Subject: lib/tdb: Rename manpages/ to man/. Trying to be more consistent. Karolin Reviewed-by: Andreas Schneider --- lib/tdb/man/tdbbackup.8.xml | 136 ++++++++++++++++++++++ lib/tdb/man/tdbdump.8.xml | 92 +++++++++++++++ lib/tdb/man/tdbrestore.8.xml | 66 +++++++++++ lib/tdb/man/tdbtool.8.xml | 235 ++++++++++++++++++++++++++++++++++++++ lib/tdb/manpages/tdbbackup.8.xml | 136 ---------------------- lib/tdb/manpages/tdbdump.8.xml | 92 --------------- lib/tdb/manpages/tdbrestore.8.xml | 66 ----------- lib/tdb/manpages/tdbtool.8.xml | 235 -------------------------------------- lib/tdb/wscript | 8 +- 9 files changed, 533 insertions(+), 533 deletions(-) create mode 100644 lib/tdb/man/tdbbackup.8.xml create mode 100644 lib/tdb/man/tdbdump.8.xml create mode 100644 lib/tdb/man/tdbrestore.8.xml create mode 100644 lib/tdb/man/tdbtool.8.xml delete mode 100644 lib/tdb/manpages/tdbbackup.8.xml delete mode 100644 lib/tdb/manpages/tdbdump.8.xml delete mode 100644 lib/tdb/manpages/tdbrestore.8.xml delete mode 100644 lib/tdb/manpages/tdbtool.8.xml diff --git a/lib/tdb/man/tdbbackup.8.xml b/lib/tdb/man/tdbbackup.8.xml new file mode 100644 index 00000000000..02936cf0d6b --- /dev/null +++ b/lib/tdb/man/tdbbackup.8.xml @@ -0,0 +1,136 @@ + + + + + + tdbbackup + 8 + Samba + System Administration tools + 3.6 + + + + + tdbbackup + tool for backing up and for validating the integrity of samba .tdb files + + + + + tdbbackup + -s suffix + -v + -h + + + + + DESCRIPTION + + This tool is part of the samba + 1 suite. + + 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. + + + + + + OPTIONS + + + + + -h + + Get help information. + + + + + -s suffix + + 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. + + + + + -v + + The -v will check the database for damages (currupt data) + which if detected causes the backup to be restored. + + + + + + + + + COMMANDS + + GENERAL INFORMATION + + + 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: + + + tdbbackup [-s suffix] *.tdb + + + Before restarting samba the following command may be run to validate .tdb files: + + + tdbbackup -v [-s suffix] *.tdb + + + Samba .tdb files are stored in various locations, be sure to run backup all + .tdb file on the system. Important files includes: + + + + + secrets.tdb - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + + + + passdb.tdb - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + + + + *.tdb located in the /usr/local/samba/var directory or on some + systems in the /var/cache or /var/lib/samba directories. + + + + + + + VERSION + + This man page is correct for version 3 of the Samba suite. + + + + AUTHOR + + + 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 tdbbackup man page was written by John H Terpstra. + + + diff --git a/lib/tdb/man/tdbdump.8.xml b/lib/tdb/man/tdbdump.8.xml new file mode 100644 index 00000000000..25fd432eb6e --- /dev/null +++ b/lib/tdb/man/tdbdump.8.xml @@ -0,0 +1,92 @@ + + + + + + tdbdump + 8 + Samba + System Administration tools + 3.6 + + + + + tdbdump + tool for printing the contents of a TDB file + + + + + tdbdump + -k keyname + -e + -h + filename + + + + + DESCRIPTION + + This tool is part of the samba + 1 suite. + + tdbdump is a very simple utility that 'dumps' the + contents of a TDB (Trivial DataBase) file to standard output in a + human-readable format. + + + This tool can be used when debugging problems with TDB files. It is + intended for those who are somewhat familiar with Samba internals. + + + + + OPTIONS + + + + + -h + + Get help information. + + + + + -k keyname + + The -k option restricts dumping to a single key, if found. + + + + + -e + + The -e tries to dump out from a corrupt database. Naturally, such a dump is unreliable, at best. + + + + + + + + VERSION + + This man page is correct for version 3 of the Samba suite. + + + + AUTHOR + + + 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 tdbdump man page was written by Jelmer Vernooij. + + + diff --git a/lib/tdb/man/tdbrestore.8.xml b/lib/tdb/man/tdbrestore.8.xml new file mode 100644 index 00000000000..64c0ba2dac1 --- /dev/null +++ b/lib/tdb/man/tdbrestore.8.xml @@ -0,0 +1,66 @@ + + + + + + tdbrestore + 8 + Samba + System Administration tools + 3.6 + + + + + tdbrestore + tool for creating a TDB file out of a tdbdump output + + + + + tdbrestore + tdbfilename + + + + + DESCRIPTION + + This tool is part of the samba + 1 suite. + + tdbrestore is a very simple utility that 'restores' the + contents of dump file into TDB (Trivial DataBase) file. The dump file is obtained from the tdbdump + command. + + + This tool wait on the standard input for the content of the dump and will write the tdb in the tdbfilename + parameter. + + This tool can be used for unpacking the content of tdb as backup mean. + + + + + + VERSION + + This man page is correct for version 3 of the Samba suite. + + + + AUTHOR + + + 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. + + This tool was initially written by Volker Lendecke based on an + idea by Simon McVittie. + + + The tdbrestore man page was written by Matthieu Patou. + + + diff --git a/lib/tdb/man/tdbtool.8.xml b/lib/tdb/man/tdbtool.8.xml new file mode 100644 index 00000000000..bc5c0014025 --- /dev/null +++ b/lib/tdb/man/tdbtool.8.xml @@ -0,0 +1,235 @@ + + + + + + tdbtool + 8 + Samba + System Administration tools + 4.0 + + + + + tdbtool + manipulate the contents TDB files + + + + + + tdbtool + + + + tdbtool + + TDBFILE + + + COMMANDS + + + + + + + DESCRIPTION + + This tool is part of the + samba + 1 suite. + + tdbtool a tool for displaying and + altering the contents of Samba TDB (Trivial DataBase) files. Each + of the commands listed below can be entered interactively or + provided on the command line. + + + + + + COMMANDS + + + + + + TDBFILE + Create a new database named + TDBFILE. + + + + + + TDBFILE + Open an existing database named + TDBFILE. + + + + + + Erase the current database. + + + + + + Dump the current database as strings. + + + + + + Dump the current database as connection records. + + + + + + Dump the current database keys as strings. + + + + + + Dump the current database keys as hex values. + + + + + + Print summary information about the + current database. + + + + + + KEY + DATA + + Insert a record into the + current database. + + + + + + KEY + TDBFILE + + Move a record from the + current database into TDBFILE. + + + + + + KEY + DATA + + Store (replace) a record in the + current database. + + + + + + KEY + + Show a record by key. + + + + + + KEY + + Delete a record by key. + + + + + + + Print the current database hash table and free list. + + + + + + + Print the current database and free list. + + + + + + COMMAND + + Execute the given system command. + + + + + + + + Print the first record in the current database. + + + + + + + + Print the next record in the current database. + + + + + + + + Check the integrity of the current database. + + + + + + + + Exit tdbtool. + + + + + + + + CAVEATS + The contents of the Samba TDB files are private + to the implementation and should not be altered with + tdbtool. + + + + + VERSION + This man page is correct for version 3.0.25 of the Samba suite. + + + + AUTHOR + + 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. + + + diff --git a/lib/tdb/manpages/tdbbackup.8.xml b/lib/tdb/manpages/tdbbackup.8.xml deleted file mode 100644 index 78fe32eb8ec..00000000000 --- a/lib/tdb/manpages/tdbbackup.8.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - tdbbackup - 8 - Samba - System Administration tools - 3.6 - - - - - tdbbackup - tool for backing up and for validating the integrity of samba .tdb files - - - - - tdbbackup - -s suffix - -v - -h - - - - - DESCRIPTION - - This tool is part of the samba - 1 suite. - - 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. - - - - - - OPTIONS - - - - - -h - - Get help information. - - - - - -s suffix - - 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. - - - - - -v - - The -v will check the database for damages (currupt data) - which if detected causes the backup to be restored. - - - - - - - - - COMMANDS - - GENERAL INFORMATION - - - 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: - - - tdbbackup [-s suffix] *.tdb - - - Before restarting samba the following command may be run to validate .tdb files: - - - tdbbackup -v [-s suffix] *.tdb - - - Samba .tdb files are stored in various locations, be sure to run backup all - .tdb file on the system. Important files includes: - - - - - secrets.tdb - usual location is in the /usr/local/samba/private - directory, or on some systems in /etc/samba. - - - - passdb.tdb - usual location is in the /usr/local/samba/private - directory, or on some systems in /etc/samba. - - - - *.tdb located in the /usr/local/samba/var directory or on some - systems in the /var/cache or /var/lib/samba directories. - - - - - - - VERSION - - This man page is correct for version 3 of the Samba suite. - - - - AUTHOR - - - 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 tdbbackup man page was written by John H Terpstra. - - - diff --git a/lib/tdb/manpages/tdbdump.8.xml b/lib/tdb/manpages/tdbdump.8.xml deleted file mode 100644 index 34201932434..00000000000 --- a/lib/tdb/manpages/tdbdump.8.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - tdbdump - 8 - Samba - System Administration tools - 3.6 - - - - - tdbdump - tool for printing the contents of a TDB file - - - - - tdbdump - -k keyname - -e - -h - filename - - - - - DESCRIPTION - - This tool is part of the samba - 1 suite. - - tdbdump is a very simple utility that 'dumps' the - contents of a TDB (Trivial DataBase) file to standard output in a - human-readable format. - - - This tool can be used when debugging problems with TDB files. It is - intended for those who are somewhat familiar with Samba internals. - - - - - OPTIONS - - - - - -h - - Get help information. - - - - - -k keyname - - The -k option restricts dumping to a single key, if found. - - - - - -e - - The -e tries to dump out from a corrupt database. Naturally, such a dump is unreliable, at best. - - - - - - - - VERSION - - This man page is correct for version 3 of the Samba suite. - - - - AUTHOR - - - 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 tdbdump man page was written by Jelmer Vernooij. - - - diff --git a/lib/tdb/manpages/tdbrestore.8.xml b/lib/tdb/manpages/tdbrestore.8.xml deleted file mode 100644 index 64c0ba2dac1..00000000000 --- a/lib/tdb/manpages/tdbrestore.8.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - tdbrestore - 8 - Samba - System Administration tools - 3.6 - - - - - tdbrestore - tool for creating a TDB file out of a tdbdump output - - - - - tdbrestore - tdbfilename - - - - - DESCRIPTION - - This tool is part of the samba - 1 suite. - - tdbrestore is a very simple utility that 'restores' the - contents of dump file into TDB (Trivial DataBase) file. The dump file is obtained from the tdbdump - command. - - - This tool wait on the standard input for the content of the dump and will write the tdb in the tdbfilename - parameter. - - This tool can be used for unpacking the content of tdb as backup mean. - - - - - - VERSION - - This man page is correct for version 3 of the Samba suite. - - - - AUTHOR - - - 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. - - This tool was initially written by Volker Lendecke based on an - idea by Simon McVittie. - - - The tdbrestore man page was written by Matthieu Patou. - - - diff --git a/lib/tdb/manpages/tdbtool.8.xml b/lib/tdb/manpages/tdbtool.8.xml deleted file mode 100644 index c143b5ce04e..00000000000 --- a/lib/tdb/manpages/tdbtool.8.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - tdbtool - 8 - Samba - System Administration tools - 4.0 - - - - - tdbtool - manipulate the contents TDB files - - - - - - tdbtool - - - - tdbtool - - TDBFILE - - - COMMANDS - - - - - - - DESCRIPTION - - This tool is part of the - samba - 1 suite. - - tdbtool a tool for displaying and - altering the contents of Samba TDB (Trivial DataBase) files. Each - of the commands listed below can be entered interactively or - provided on the command line. - - - - - - COMMANDS - - - - - - TDBFILE - Create a new database named - TDBFILE. - - - - - - TDBFILE - Open an existing database named - TDBFILE. - - - - - - Erase the current database. - - - - - - Dump the current database as strings. - - - - - - Dump the current database as connection records. - - - - - - Dump the current database keys as strings. - - - - - - Dump the current database keys as hex values. - - - - - - Print summary information about the - current database. - - - - - - KEY - DATA - - Insert a record into the - current database. - - - - - - KEY - TDBFILE - - Move a record from the - current database into TDBFILE. - - - - - - KEY - DATA - - Store (replace) a record in the - current database. - - - - - - KEY - - Show a record by key. - - - - - - KEY - - Delete a record by key. - - - - - - - Print the current database hash table and free list. - - - - - - - Print the current database and free list. - - - - - - COMMAND - - Execute the given system command. - - - - - - - - Print the first record in the current database. - - - - - - - - Print the next record in the current database. - - - - - - - - Check the integrity of the current database. - - - - - - - - Exit tdbtool. - - - - - - - - CAVEATS - The contents of the Samba TDB files are private - to the implementation and should not be altered with - tdbtool. - - - - - VERSION - This man page is correct for version 3.0.25 of the Samba suite. - - - - AUTHOR - - 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. - - - diff --git a/lib/tdb/wscript b/lib/tdb/wscript index 9d309a0325c..7a3d0fa602a 100644 --- a/lib/tdb/wscript +++ b/lib/tdb/wscript @@ -94,20 +94,20 @@ def build(bld): bld.SAMBA_BINARY('tdbrestore', 'tools/tdbrestore.c', - 'tdb', manpages='manpages/tdbrestore.8') + 'tdb', manpages='man/tdbrestore.8') bld.SAMBA_BINARY('tdbdump', 'tools/tdbdump.c', - 'tdb', manpages='manpages/tdbdump.8') + 'tdb', manpages='man/tdbdump.8') bld.SAMBA_BINARY('tdbbackup', 'tools/tdbbackup.c', 'tdb', - manpages='manpages/tdbbackup.8') + manpages='man/tdbbackup.8') bld.SAMBA_BINARY('tdbtool', 'tools/tdbtool.c', - 'tdb', manpages='manpages/tdbtool.8') + 'tdb', manpages='man/tdbtool.8') # FIXME: This hardcoded list is stupid, stupid, stupid. bld.SAMBA_SUBSYSTEM('tdb-test-helpers', -- cgit v1.2.1