release/src/router/samba3/docs/manpages/tdbtool.8

   1 .\"     Title: tdbtool
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 09/30/2009
   5 .\"    Manual: System Administration tools
   6 .\"    Source: Samba 3.0
   7 .\"  Language: English
   8 .\"
   9 .TH "TDBTOOL" "8" "09/30/2009" "Samba 3\&.0" "System Administration tools"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 tdbtool \- manipulate the contents TDB files
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\ 'u
 174 \FCtdbtool\F[]
 175 .fam
 176 .fam C
 177 .HP \w'\ 'u
 178 \FCtdbtool\F[] \fITDBFILE\fR [\fICOMMANDS\fR...]
 179 .fam
 180 .SH "DESCRIPTION"
 181 .PP
 182 This tool is part of the
 183 \fBsamba\fR(1)
 184 suite\&.
 185 .PP
 186 \FCtdbtool\F[]
 187 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\&.
 188 .SH "COMMANDS"
 189 .PP
 190 \fBcreate\fR \fITDBFILE\fR
 191 .RS 4
 192 Create a new database named
 193 \fITDBFILE\fR\&.
 194 .RE
 195 .PP
 196 \fBopen\fR \fITDBFILE\fR
 197 .RS 4
 198 Open an existing database named
 199 \fITDBFILE\fR\&.
 200 .RE
 201 .PP
 202 \fBerase\fR
 203 .RS 4
 204 Erase the current database\&.
 205 .RE
 206 .PP
 207 \fBdump\fR
 208 .RS 4
 209 Dump the current database as strings\&.
 210 .RE
 211 .PP
 212 \fBcdump\fR
 213 .RS 4
 214 Dump the current database as connection records\&.
 215 .RE
 216 .PP
 217 \fBkeys\fR
 218 .RS 4
 219 Dump the current database keys as strings\&.
 220 .RE
 221 .PP
 222 \fBhexkeys\fR
 223 .RS 4
 224 Dump the current database keys as hex values\&.
 225 .RE
 226 .PP
 227 \fBinfo\fR
 228 .RS 4
 229 Print summary information about the current database\&.
 230 .RE
 231 .PP
 232 \fBinsert\fR \fIKEY\fR \fIDATA\fR
 233 .RS 4
 234 Insert a record into the current database\&.
 235 .RE
 236 .PP
 237 \fBmove\fR \fIKEY\fR \fITDBFILE\fR
 238 .RS 4
 239 Move a record from the current database into
 240 \fITDBFILE\fR\&.
 241 .RE
 242 .PP
 243 \fBstore\fR \fIKEY\fR \fIDATA\fR
 244 .RS 4
 245 Store (replace) a record in the current database\&.
 246 .RE
 247 .PP
 248 \fBshow\fR \fIKEY\fR
 249 .RS 4
 250 Show a record by key\&.
 251 .RE
 252 .PP
 253 \fBdelete\fR \fIKEY\fR
 254 .RS 4
 255 Delete a record by key\&.
 256 .RE
 257 .PP
 258 \fBlist\fR
 259 .RS 4
 260 Print the current database hash table and free list\&.
 261 .RE
 262 .PP
 263 \fBfree\fR
 264 .RS 4
 265 Print the current database and free list\&.
 266 .RE
 267 .PP
 268 \fB!\fR \fICOMMAND\fR
 269 .RS 4
 270 Execute the given system command\&.
 271 .RE
 272 .PP
 273 \fBfirst\fR
 274 .RS 4
 275 Print the first record in the current database\&.
 276 .RE
 277 .PP
 278 \fBnext\fR
 279 .RS 4
 280 Print the next record in the current database\&.
 281 .RE
 282 .PP
 283 \fBquit\fR
 284 .RS 4
 285 Exit
 286 \FCtdbtool\F[]\&.
 287 .RE
 288 .SH "CAVEATS"
 289 .PP
 290 The contents of the Samba TDB files are private to the implementation and should not be altered with
 291 \FCtdbtool\F[]\&.
 292 .SH "VERSION"
 293 .PP
 294 This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
 295 .SH "AUTHOR"
 296 .PP
 297 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\&.