* doc/guide.tex: Improve explanation of backup commands (EJAB-832)

* doc/guide.html: Likewise

SVN Revision: 1792

2 files changed, 30 insertions, 4 deletions

diff --git a/doc/guide.html b/doc/guide.html
index b7466955e..a75ff4bf9 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -2929,8 +2929,21 @@ The more interesting ones are:
 </DD><DT CLASS="dt-description"><B><TT>reopen-log</TT></B></DT><DD CLASS="dd-description"> Reopen the log files after they were renamed.
 If the old files were not renamed before calling this command,
 they are automatically renamed to <TT>"*-old.log"</TT>. See section <A HREF="#logfiles">7.1</A>.
-</DD><DT CLASS="dt-description"><B><TT>backup, restore, install-fallback, dump, load</TT></B></DT><DD CLASS="dd-description"> You can use these
-commands to create and restore backups.
+</DD><DT CLASS="dt-description"><B><TT>backup ejabberd.backup</TT></B></DT><DD CLASS="dd-description">
+Store internal Mnesia database to a binary backup file.
+</DD><DT CLASS="dt-description"><B><TT>restore ejabberd.backup</TT></B></DT><DD CLASS="dd-description">
+Restore immediately from a binary backup file the internal Mnesia database.
+This will comsume quite some memory for big servers.
+</DD><DT CLASS="dt-description"><B><TT>install-fallback ejabberd.backup</TT></B></DT><DD CLASS="dd-description">
+The binary backup file is installed as fallback:
+it will be used to restore the database at the next ejabberd start.
+Similar to <TT>restore</TT>, but requires less memory.
+</DD><DT CLASS="dt-description"><B><TT>dump ejabberd.dump</TT></B></DT><DD CLASS="dd-description">
+Dump internal Mnesia database to a text file dump.
+</DD><DT CLASS="dt-description"><B><TT>load ejabberd.dump</TT></B></DT><DD CLASS="dd-description">
+Restore immediately from a text file dump.
+This is not recommended for big databases, as it will consume much time,
+memory and processor. In that case it&#X2019;s preferable to use <TT>backup</TT> and <TT>install-fallback</TT>.
 </DD><DT CLASS="dt-description"><B><TT>import-file, import-dir</TT></B></DT><DD CLASS="dd-description"> 
 These options can be used to migrate from other Jabber/XMPP servers. There
 exist tutorials to <A HREF="http://www.ejabberd.im/migrate-to-ejabberd">migrate from other software to ejabberd</A>.
diff --git a/doc/guide.tex b/doc/guide.tex
index c3fb6db07..239c9e581 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3771,8 +3771,21 @@ The more interesting ones are:
 \titem{reopen-log} Reopen the log files after they were renamed.
   If the old files were not renamed before calling this command,
   they are automatically renamed to \term{"*-old.log"}. See section \ref{logfiles}.
-\titem {backup, restore, install-fallback, dump, load} You can use these
-  commands to create and restore backups.
+\titem {backup ejabberd.backup}
+  Store internal Mnesia database to a binary backup file.
+\titem {restore ejabberd.backup}
+  Restore immediately from a binary backup file the internal Mnesia database.
+  This will comsume quite some memory for big servers.
+\titem {install-fallback ejabberd.backup}
+  The binary backup file is installed as fallback:
+  it will be used to restore the database at the next ejabberd start.
+  Similar to \term{restore}, but requires less memory.
+\titem {dump ejabberd.dump}
+  Dump internal Mnesia database to a text file dump.
+\titem {load ejabberd.dump}
+  Restore immediately from a text file dump.
+  This is not recommended for big databases, as it will consume much time,
+  memory and processor. In that case it's preferable to use \term{backup} and \term{install-fallback}.
 %%More information about backuping can
 %%  be found in section~\ref{backup}.
 \titem{import-file, import-dir} \ind{migration from other software}