From 093625b9fd517d56fb38b0d61142109bf48062d0 Mon Sep 17 00:00:00 2001 From: Tzafrir Cohen Date: Wed, 2 Oct 2013 17:36:28 +0000 Subject: [PATCH] man pages for astdb2bdb and astdb2sqlite3 Review: https://reviewboard.asterisk.org/r/2898/ git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/11@400279 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- Makefile | 1 + doc/astdb2bdb.8 | 46 +++++++++++++++++++++++++++++++++++++++++++++ doc/astdb2sqlite3.8 | 39 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 86 insertions(+) create mode 100644 doc/astdb2bdb.8 create mode 100644 doc/astdb2sqlite3.8 diff --git a/Makefile b/Makefile index 8082bc0e82..9686725ea9 100644 --- a/Makefile +++ b/Makefile @@ -564,6 +564,7 @@ bininstall: _all installdirs $(SUBDIRS_INSTALL) main-bininstall $(INSTALL) -m 644 doc/core-*.xml "$(DESTDIR)$(ASTDATADIR)/documentation" $(INSTALL) -m 644 doc/appdocsxml.dtd "$(DESTDIR)$(ASTDATADIR)/documentation" $(INSTALL) -m 644 doc/asterisk.8 "$(DESTDIR)$(ASTMANDIR)/man8" + $(INSTALL) -m 644 doc/astdb*.8 "$(DESTDIR)$(ASTMANDIR)/man8" $(INSTALL) -m 644 contrib/scripts/astgenkey.8 "$(DESTDIR)$(ASTMANDIR)/man8" $(INSTALL) -m 644 contrib/scripts/autosupport.8 "$(DESTDIR)$(ASTMANDIR)/man8" $(INSTALL) -m 644 contrib/scripts/safe_asterisk.8 "$(DESTDIR)$(ASTMANDIR)/man8" diff --git a/doc/astdb2bdb.8 b/doc/astdb2bdb.8 new file mode 100644 index 0000000000..735bf2102c --- /dev/null +++ b/doc/astdb2bdb.8 @@ -0,0 +1,46 @@ +.TH "ASTDB2BDB" "8" "30 SEPTEMBER 2013" "Asterisk 11" "" + +.SH NAME +astdb2bdb \- convert astdb back to Berkeley DB 1.86 +.SH SYNOPSIS + +.B cd \fIastvarlibdir\fB && astdb2bdb path/to/astdb.sqlite3 + +.SH "DESCRIPTION" +Up until version version 11, Asterisk used an old version of the +Berkeley DB 1.86 (bdb) to store its internal persistent database. In +version 11 it switched to using a SQLIte 3 database. This program is +used to convert the newly-formatted SQLite 3 astdb back to bdb. + +You may need it in case of reverting an upgrade or other similar +scenarios. + +.SH OPTIONS +There is a single (and required) parameter: the path the the sqlite file. +The output file will be a file called +.B astdb +in the current working directory. + +.SH EXAMPLES +In case you want to revert an upgrade to Asterisk 11, you can do the +following (while Asterisk is not running): + + cd /var/lib/asterisk && astdb2bdb astdb.sqlite3 && rm astdb.sqlite3 + +This will convert the newly-formatted astdb back to the old format, and +delete it (to avoid obsolete data copies). + +.SH NOTES +Berkeley DB 1.86 is obsolete. It is incompatible with newer versions +(4.x and newer) that you may see around. Chances are you don't have the +tools to use it independently of Asterisk. + +.SH SEE ALSO +.B astdb2sqlite3(8), +.B asterisk(8) + +.SH AUTHOR +astdb2bdb was written by Terry Wilson . + +This manual page was written by Tzafrir Cohen . + diff --git a/doc/astdb2sqlite3.8 b/doc/astdb2sqlite3.8 new file mode 100644 index 0000000000..406d9665c8 --- /dev/null +++ b/doc/astdb2sqlite3.8 @@ -0,0 +1,39 @@ +.TH "ASTDB2SQLITE3" "8" "30 SEPTEMBER 2013" "Asterisk 11" "" + +.SH NAME +astdb2sqlite3 \- convert astdb to SQLite 3 +.SH SYNOPSIS + +.B astdb2sqlite3 path/to/astdb + +.SH "DESCRIPTION" +Up until version version 11, Asterisk used an old version of the +Berkeley DB 1.86 (bdb) to store its internal persistent database. In +version 11 it switched to using a SQLite 3 database. This program is +used to convert an existing bdb astdb file to astdb.sqlite3. + +Normally the conversion is done by Asterisk itself which will run this +program. But you may need to run it on your own. + +.SH OPTIONS +There is a single (and required) parameter: the path the the bdb file. +The output file name will be the same as the input, with +.B .sqlite3 +appended. + +.SH EXAMPLES +Asterisk will typically run the following to upgrade the database: + + astdb2sqlite3 /var/lib/asterisk/astdb + +which will create \fB/var/lib/asterisk/astdb.sqlite3\fR. + +.SH SEE ALSO +.B astdb2bdb(8), +.B asterisk(8) + +.SH AUTHOR +astdb2sqlite3 was written by Terry Wilson . + +This manual page was written by Tzafrir Cohen . +