summaryrefslogtreecommitdiff
path: root/net/samba416/files/man/tdbtool.8
diff options
context:
space:
mode:
authorTimur I. Bakeyev <timur@FreeBSD.org>2022-10-17 01:06:57 +0200
committerTimur I. Bakeyev <timur@FreeBSD.org>2022-10-17 01:23:12 +0200
commit2daf87ac19838c9a36f56fb51b0678d193921771 (patch)
tree87a5f4c067f790a80182ab78a91be4695e030b8c /net/samba416/files/man/tdbtool.8
parentnet/samba413: Fix alignment of the WWW line. (diff)
net/samba416: New port for Samba 4.16
This is an initial attempt to add Samba to the FreeBSD after major rewrite of the VFS code in the upstream. Most of the port development is now carried in: https://gitlab.com/samba-freebsd Due to the way how new Samba VFS code is written there is a constrain that Samba 4.14+ can run only on FreeBSD 13.1+, as it requires support of the `nodup` option for the `fdesc` file system, as well as it's presence in the system in general. https://gitlab.com/samba-freebsd/-/wikis/The-New-VFS I'd like to thank CyberSecure Pty Ltd. company for their supoort of the port development and Andrew Walker from iXsystems Inc. for the patches he created and made available for the Samba4 on TrueNAS. PR: 263874
Diffstat (limited to 'net/samba416/files/man/tdbtool.8')
-rw-r--r--net/samba416/files/man/tdbtool.8170
1 files changed, 170 insertions, 0 deletions
diff --git a/net/samba416/files/man/tdbtool.8 b/net/samba416/files/man/tdbtool.8
new file mode 100644
index 000000000000..04ed76594c19
--- /dev/null
+++ b/net/samba416/files/man/tdbtool.8
@@ -0,0 +1,170 @@
+'\" t
+.\" Title: tdbtool
+.\" Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 2015-04-25
+.\" Manual: System Administration tools
+.\" Source: Samba 4.0
+.\" Language: English
+.\"
+.TH "TDBTOOL" "8" "2015\-04\-25" "Samba 4\&.0" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+tdbtool \- manipulate the contents TDB files
+.SH "SYNOPSIS"
+.HP \w'\fBtdbtool\fR\ 'u
+\fBtdbtool\fR
+.HP \w'\fBtdbtool\fR\ 'u
+\fBtdbtool\fR [\-l] \fITDBFILE\fR [\fICOMMANDS\fR...]
+.SH "DESCRIPTION"
+.PP
+This tool is part of the
+\fBsamba\fR(1)
+suite\&.
+.PP
+\fBtdbtool\fR
+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\&.
+.SH "OPTIONS"
+.PP
+\-l
+.RS 4
+This options disables any locking, by passing TDB_NOLOCK to tdb_open_ex()\&. Only use this for database files which are not used by any other process! And also only if it is otherwise not possible to open the database, e\&.g\&. databases which were created with mutex locking\&.
+.RE
+.SH "COMMANDS"
+.PP
+\fBcreate\fR \fITDBFILE\fR
+.RS 4
+Create a new database named
+\fITDBFILE\fR\&.
+.RE
+.PP
+\fBopen\fR \fITDBFILE\fR
+.RS 4
+Open an existing database named
+\fITDBFILE\fR\&.
+.RE
+.PP
+\fBerase\fR
+.RS 4
+Erase the current database\&.
+.RE
+.PP
+\fBdump\fR
+.RS 4
+Dump the current database as strings\&.
+.RE
+.PP
+\fBcdump\fR
+.RS 4
+Dump the current database as connection records\&.
+.RE
+.PP
+\fBkeys\fR
+.RS 4
+Dump the current database keys as strings\&.
+.RE
+.PP
+\fBhexkeys\fR
+.RS 4
+Dump the current database keys as hex values\&.
+.RE
+.PP
+\fBinfo\fR
+.RS 4
+Print summary information about the current database\&.
+.RE
+.PP
+\fBinsert\fR \fIKEY\fR \fIDATA\fR
+.RS 4
+Insert a record into the current database\&.
+.RE
+.PP
+\fBmove\fR \fIKEY\fR \fITDBFILE\fR
+.RS 4
+Move a record from the current database into
+\fITDBFILE\fR\&.
+.RE
+.PP
+\fBstore\fR \fIKEY\fR \fIDATA\fR
+.RS 4
+Store (replace) a record in the current database\&.
+.RE
+.PP
+\fBshow\fR \fIKEY\fR
+.RS 4
+Show a record by key\&.
+.RE
+.PP
+\fBdelete\fR \fIKEY\fR
+.RS 4
+Delete a record by key\&.
+.RE
+.PP
+\fBlist\fR
+.RS 4
+Print the current database hash table and free list\&.
+.RE
+.PP
+\fBfree\fR
+.RS 4
+Print the current database and free list\&.
+.RE
+.PP
+\fB!\fR \fICOMMAND\fR
+.RS 4
+Execute the given system command\&.
+.RE
+.PP
+\fBfirst\fR
+.RS 4
+Print the first record in the current database\&.
+.RE
+.PP
+\fBnext\fR
+.RS 4
+Print the next record in the current database\&.
+.RE
+.PP
+\fBcheck\fR
+.RS 4
+Check the integrity of the current database\&.
+.RE
+.PP
+\fBrepack\fR
+.RS 4
+Repack a database using a temporary file to remove fragmentation\&.
+.RE
+.PP
+\fBquit\fR
+.RS 4
+Exit
+\fBtdbtool\fR\&.
+.RE
+.SH "CAVEATS"
+.PP
+The contents of the Samba TDB files are private to the implementation and should not be altered with
+\fBtdbtool\fR\&.
+.SH "VERSION"
+.PP
+This man page is correct for version 3\&.6 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\&.