Author: areshetnyak Date: 2011-10-04 09:07:38 -0400 (Tue, 04 Oct 2011) New Revision: 5021 Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml Log: EXOJCR-1531 : Help information in backup client was extended and fixed. Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml =================================================================== --- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml 2011-10-04 13:07:08 UTC (rev 5020) +++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml 2011-10-04 13:07:38 UTC (rev 5021) @@ -1006,13 +1006,13 @@ stop &lt;backup_id&gt; status &lt;backup_id&gt; restores &lt;repo[/ws]&gt; - restore [remove-exists] [&lt;repo[/ws]&gt;] {&lt;backup_id&gt;|&lt;backup_set_path&gt;} [&lt;pathToConfigFile&gt;] + restore [remove-exists] {{&lt;backup_id&gt;|&lt;backup_set_path&gt;} | {&lt;repo[/ws]&gt; {&lt;backup_id&gt;|&lt;backup_set_path&gt;} [&lt;pathToConfigFile&gt;]}} list [completed] info drop [force-close-session] &lt;repo[/ws]&gt; help - start - start backup of repositpry or workspace + start - start backup of repository or workspace stop - stop backup status - information about the current or completed backup by 'backup_id' restores - information about the last restore on specific repository or workspace @@ -1029,8 +1029,23 @@ &lt;backup_set_dir&gt; - path to folder with backup set on remote server &lt;incr&gt; - incemental job period &lt;pathToConfigFile&gt; - path (local) to repository or workspace configuration - remove-exists - removed fully (db, value storage, index) existed repository/workspace - force-close-session - close opened sessions on repositpry or workspace.</programlisting> + remove-exists - remove fully (db, value storage, index) exists repository/workspace + force-close-session - close opened sessions on repository or workspace. + + All valid combination of parameters for command restore: + 1. restore remove-exists &lt;repo/ws&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 2. restore remove-exists &lt;repo&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 3. restore remove-exists &lt;repo/ws&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 4. restore remove-exists &lt;repo&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 5. restore remove-exists &lt;backup_id&gt; + 6. restore remove-exists &lt;backup_set_path&gt; + 7. restore &lt;repo/ws&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 8. restore &lt;repo&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 9. restore &lt;repo/ws&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 10. restore &lt;repo&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 11. restore &lt;backup_id&gt; + 12. restore &lt;backup_set_path&gt; +</programlisting> </section> <section> @@ -1563,10 +1578,11 @@ status code = 200</programlisting>The /home/rainf0x/java/exo-working/JCR-839/exo-jcr-config_backup.xml content the configuration for restored workspace <emphasis - role="bold">"backup"</emphasis>:</para></listitem> + role="bold">"backup"</emphasis>:</para> + </listitem> </itemizedlist> - - <programlisting language="xml">&lt;repository-service default-repository="repository"&gt; + + <programlisting language="xml">&lt;repository-service default-repository="repository"&gt; &lt;repositories&gt; &lt;repository name="repository" system-workspace="production" default-workspace="production"&gt; &lt;security-domain&gt;exo-domain&lt;/security-domain&gt; @@ -1650,7 +1666,7 @@ <para>This usecase needs RestRepositoryService enabled. (Deleting the repository needs it)</para> - + <programlisting language="xml">&lt;component&gt; &lt;type&gt;org.exoplatform.services.jcr.ext.repository.RestRepositoryService&lt;/type&gt; &lt;/component&gt;</programlisting> @@ -1738,8 +1754,8 @@ role="bold">"repository"</emphasis>:</para> </listitem> </itemizedlist> - - <programlisting language="xml">&lt;repository-service default-repository="repository"&gt; + + <programlisting language="xml">&lt;repository-service default-repository="repository"&gt; &lt;repositories&gt; &lt;repository name="repository" system-workspace="production" default-workspace="production"&gt; &lt;security-domain&gt;exo-domain&lt;/security-domain&gt; @@ -1873,7 +1889,6 @@ &lt;/repositories&gt; &lt;/repository-service&gt; </programlisting> - </section> <section> Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml =================================================================== --- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml 2011-10-04 13:07:08 UTC (rev 5020) +++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-clonsole-dist.xml 2011-10-04 13:07:38 UTC (rev 5021) @@ -4,14 +4,14 @@ <chapter id="JCR.BackupClient"> <?dbhtml filename="ch-backup-clonsole.dist.html"?> - <title>Backup console binary distribution </title> + <title>Backup console binary distribution</title> <section> <title>Introduction</title> <para>The backup console binary distribution is script-based front-end to backup client to creation backup, restore, getting status of current or - completed backup/restore, etc. </para> + completed backup/restore, etc.</para> <para>The backup console binary distribution conatins original backup console and script adaptation for use with GateIn based products like @@ -41,7 +41,7 @@ stop &lt;backup_id&gt; status &lt;backup_id&gt; restores &lt;repo[/ws]&gt; - restore [remove-exists] [&lt;repo[/ws]&gt;] {&lt;backup_id&gt;|&lt;backup_set_path&gt;} [&lt;pathToConfigFile&gt;] + restore [remove-exists] {{&lt;backup_id&gt;|&lt;backup_set_path&gt;} | {&lt;repo[/ws]&gt; {&lt;backup_id&gt;|&lt;backup_set_path&gt;} [&lt;pathToConfigFile&gt;]}} list [completed] info drop [force-close-session] &lt;repo[/ws]&gt; @@ -64,7 +64,23 @@ &lt;incr&gt; : incremental job period &lt;pathToConfigFile&gt; : path (local) to repository or workspace configuration remove-exists : remove fully (db, value storage, index) exists repository/workspace - force-close-session : close opened sessions on repository or workspace</programlisting> + force-close-session : close opened sessions on repository or workspace + + + All valid combination of parameters for command restore: + 1. restore remove-exists &lt;repo/ws&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 2. restore remove-exists &lt;repo&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 3. restore remove-exists &lt;repo/ws&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 4. restore remove-exists &lt;repo&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 5. restore remove-exists &lt;backup_id&gt; + 6. restore remove-exists &lt;backup_set_path&gt; + 7. restore &lt;repo/ws&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 8. restore &lt;repo&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 9. restore &lt;repo/ws&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 10. restore &lt;repo&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 11. restore &lt;backup_id&gt; + 12. restore &lt;backup_set_path&gt; +</programlisting> </section> <section> @@ -86,7 +102,7 @@ stop &lt;backup_id&gt; status &lt;backup_id&gt; restores &lt;repo[/ws]&gt; - restore [remove-exists] [&lt;repo[/ws]&gt;] {&lt;backup_id&gt;|&lt;backup_set_path&gt;} [&lt;pathToConfigFile&gt;] + restore [remove-exists] {{&lt;backup_id&gt;|&lt;backup_set_path&gt;} | {&lt;repo[/ws]&gt; {&lt;backup_id&gt;|&lt;backup_set_path&gt;} [&lt;pathToConfigFile&gt;]}} list [completed] info drop [force-close-session] &lt;repo[/ws]&gt; @@ -109,7 +125,22 @@ &lt;incr&gt; : incremental job period &lt;pathToConfigFile&gt; : path (local) to repository or workspace configuration remove-exists : remove fully (db, value storage, index) exists repository/workspace - force-close-session : close opened sessions on repository or workspace</programlisting> + force-close-session : close opened sessions on repository or workspace + + + All valid combination of parameters for command restore: + 1. restore remove-exists &lt;repo/ws&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 2. restore remove-exists &lt;repo&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 3. restore remove-exists &lt;repo/ws&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 4. restore remove-exists &lt;repo&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 5. restore remove-exists &lt;backup_id&gt; + 6. restore remove-exists &lt;backup_set_path&gt; + 7. restore &lt;repo/ws&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 8. restore &lt;repo&gt; &lt;backup_id&gt; &lt;pathToConfigFile&gt; + 9. restore &lt;repo/ws&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 10. restore &lt;repo&gt; &lt;backup_set_path&gt; &lt;pathToConfigFile&gt; + 11. restore &lt;backup_id&gt; + 12. restore &lt;backup_set_path&gt; </programlisting> </section> <section>