doc/gdbm_dump.1

   1 .\" This file is part of GDBM.
   2 .\" Copyright (C) 2013 Free Software Foundation, Inc.
   3 .\"
   4 .\" GDBM is free software; you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation; either version 3, or (at your option)
   7 .\" any later version.
   8 .\"
   9 .\" GDBM is distributed in the hope that it will be useful,
  10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 .\" GNU General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License
  15 .\" along with GDBM. If not, see <http://www.gnu.org/licenses/>. */
  16 .TH GDBM_DUMP 1 "May 8, 2013" "GDBM" "GDBM User Reference"
  17 .SH NAME
  18 gdbm_dump \- dump a GDBM database to a file
  19 .SH SYNOPSIS
  20 \fBgdbm_dump\fR [\fB\-H \fIFMT\fR] [\fB\-\-format\fR=\fIFMT\fR] \fIDB_FILE\fR [\fIFILE\fR]
  21 .sp
  22 \fBgdbm_dump\fR [\fB\-Vh\fR] [\fB\-\-help\fR] [\fB\-\-usage\fR] [\fB\-\-version\fR]
  23 .SH DESCRIPTION
  24 The
  25 .B gdbm_dump
  26 utility creates a dump of the specified
  27 .BR gdbm (3)
  28 database file.  The name for the output dump file is supplied by the
  29 second argument (\fIFILE\fR).  If not specified, the output goes to
  30 the standard error.
  31 .PP
  32 The created dump can be given as argument to the
  33 .BR gdbm_load (1)
  34 utility in order to re-create an exact copy of the \fIDB_FILE\fR.
  35 .SH OPTIONS
  36 .TP
  37 \fB\-H\fR, \fB\-\-format\fR=\fIFMT\fR
  38 Select dump format.  The value \fBbinary\fR (or \fB0\fR) instructs
  39 .B gdbm_dump
  40 to produce a binary dump, compatible with earlier
  41 .B gdbm
  42 versions (up to version 1.9).  The value \fBascii\fR (or \fB1\fR)
  43 instructs it to create an ASCII dump (this is the default).  The
  44 latter is preferred because, apart from the actual data, it also
  45 contains meta-information which will allow
  46 .BR gdbm_load (1)
  47 to recreate an exact copy of the file.
  48 .TP
  49 \fB\-h\fR, \fB\-\-help\fR
  50 Print a short usage summary.
  51 .TP
  52 \fB\-\-usage\fR
  53 Print a list of available options.
  54 .TP
  55 \fB\-V\fR, \fB\-\-version\fR
  56 Print program version
  57 .SH "SEE ALSO"
  58 .BR gdbm_load (1),
  59 .BR gdbmtool (1),
  60 .BR gdbm (3).
  61 .PP
  62 For a detailed description of
  63 .B gdbm_dump
  64 and other
  65 .B gdbm
  66 utilities, refer to the \fBGDBM Manual\fR available in
  67 Texinfo format.  To access it, run:
  68
  69   \fBinfo gdbm\fR
  70
  71 .SH "REPORTING BUGS"
  72 Report bugs to <bug\-gdbm@gnu.org>.
  73 .SH COPYRIGHT
  74 Copyright \(co 2013 Free Software Foundation, Inc
  75 .br
  76 .na
  77 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
  78 .br
  79 .ad
  80 This is free software: you are free to change and redistribute it.
  81 There is NO WARRANTY, to the extent permitted by law.
  82 .\" Local variables:
  83 .\" eval: (add-hook 'write-file-hooks 'time-stamp)
  84 .\" time-stamp-start: ".TH GDBM[A-Z_-]* 1 \""
  85 .\" time-stamp-format: "%:B %:d, %:y"
  86 .\" time-stamp-end: "\""
  87 .\" time-stamp-line-limit: 20
  88 .\" end: