* doc/guide.tex: Improve explanation of backup commands

* doc/guide.html: Likewise

SVN Revision: 1789

diff --git a/ChangeLog b/ChangeLog
index 15b86286802f6e084f5843389724f15f46629d32..afc913e3604e2e4a88896a736849d66669f88285 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2009-01-09  Badlop  <badlop@process-one.net>
 
+       * doc/guide.tex: Improve explanation of backup commands
+       * doc/guide.html: Likewise
+
        * src/web/ejabberd_web_admin.erl: New appearance of WebAdmin logo,
        fixed logo-fill.
 

diff --git a/doc/guide.html b/doc/guide.html
index 56fbf2e5c7dcd8d61283a9841b21526dbf7b74d6..7236dfab9d6bf466822520b9f407b4f78ad0e70e 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -1010,6 +1010,10 @@ declarations of ACLs in the configuration file have the following syntax:
 </PRE></DD><DT CLASS="dt-description"><B><TT>{server, &lt;server&gt;}</TT></B></DT><DD CLASS="dd-description"> Matches any JID from server
 <TT>&lt;server&gt;</TT>. Example:
 <PRE CLASS="verbatim">{acl, exampleorg, {server, "example.org"}}.
+</PRE></DD><DT CLASS="dt-description"><B><TT>{shared_group, &lt;groupname&gt;}</TT></B></DT><DD CLASS="dd-description"> Matches any member of a Shared Roster Group with name <TT>&lt;groupname&gt;</TT> in the virtual host. Example:
+<PRE CLASS="verbatim">{acl, techgroupmembers, {shared_group, "techteam"}}.
+</PRE></DD><DT CLASS="dt-description"><B><TT>{shared_group, &lt;groupname&gt;, &lt;server&gt;}</TT></B></DT><DD CLASS="dd-description"> Matches any member of a Shared Roster Group with name <TT>&lt;groupname&gt;</TT> in the virtual host <TT>&lt;server&gt;</TT>. Example:
+<PRE CLASS="verbatim">{acl, techgroupmembers, {shared_group, "techteam", "example.org"}}.
 </PRE></DD><DT CLASS="dt-description"><B><TT>{user_regexp, &lt;regexp&gt;}</TT></B></DT><DD CLASS="dd-description"> Matches any local user with a name that
 matches <TT>&lt;regexp&gt;</TT> on local virtual hosts. Example:
 <PRE CLASS="verbatim">{acl, tests, {user_regexp, "^test[0-9]*$"}}.
@@ -2801,8 +2805,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 6b3f0be597630c6ac7ad7692b7acde2c0fc4c859..7c0ff7fab70f495ef04fd0e4ef43d45e84ee1a93 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3580,8 +3580,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}