You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by th...@apache.org on 2014/10/06 15:34:07 UTC
svn commit: r1629649 - in /jackrabbit/oak/trunk/oak-doc/src/site:
markdown/command_line.md site.xml
Author: thomasm
Date: Mon Oct 6 13:34:07 2014
New Revision: 1629649
URL: http://svn.apache.org/r1629649
Log:
OAK-2163 Oak-run "checkpoint" and "backup" don't use memory mapped files
Added:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/command_line.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/site.xml
Added: jackrabbit/oak/trunk/oak-doc/src/site/markdown/command_line.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/command_line.md?rev=1629649&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/command_line.md (added)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/command_line.md Mon Oct 6 13:34:07 2014
@@ -0,0 +1,51 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+## Command Line Tools
+
+### Oak Run
+
+This tool supports maintenance operations such as backup and compaction.
+
+#### Backup
+
+To back up a repository, use:
+
+ java -mx4g -jar oak-run-*.jar backup <repository> <backup>
+
+When using the (default) Tar storage, the `<repository>` setting is the path to the directory
+that contains the segment (data*.tar) files.
+The `<backup>` option is the target directory.
+
+#### Checkpoint
+
+To list the checkpoints of a repository, use:
+
+ java -mx4g -jar oak-run-*.jar checkpoint <repository>
+
+When using the (default) Tar storage, the `<repository>` setting is the path to the directory
+that contains the segment (data*.tar) files.
+
+#### Using Memory Mapped Files
+
+When using the Tar storage, some operations, for example backup and checkpoint,
+allow to use memory mapped files to reduce memory usage.
+To use this option, set the system property `tar.memoryMapped` to `true`.
+Example:
+
+ java -Dtar.memoryMapped=true -mx4g -jar oak-run-*.jar checkpoint <repository>
+
Modified: jackrabbit/oak/trunk/oak-doc/src/site/site.xml
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/site.xml?rev=1629649&r1=1629648&r2=1629649&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Mon Oct 6 13:34:07 2014
@@ -31,7 +31,7 @@ under the License.
</menu>
<menu name="Concepts and Architecture">
<item href="architecture/overview.html" name="Overview" />
- <item href="architecture/nodestate.html" name="The node state model" />
+ <item href="architecture/nodestate.html" name="The Node State Model" />
</menu>
<menu name="Main APIs">
<item href="http://www.day.com/specs/jcr/2.0/index.html" name="JCR API" />
@@ -46,18 +46,19 @@ under the License.
</menu>
<menu name="Using Oak">
<item href="use_getting_started.html" name="Getting Started" />
- <item href="construct.html" name="Repository construction" />
+ <item href="construct.html" name="Repository Construction" />
<item href="osgi_config.html" name="Configuring Oak" />
+ <item href="command_line.html" name="Command Line Tools" />
<item href="differences.html" name="Differences to Jackrabbit 2" />
<item href="known_issues.html" name="Known Issues" />
- <item href="dos_and_donts.html" name="Dos and don'ts" />
+ <item href="dos_and_donts.html" name="Dos and Don'ts" />
<item href="coldstandby/coldstandby.html" name="Cold Standby" />
<item href="FAQ.html" name="FAQ" />
</menu>
<menu name="Developing Oak">
<item href="dev_getting_started.html" name="Getting Started" />
<item href="participating.html" name="Participating" />
- <item href="apidocs/index.html" name="API docs" />
+ <item href="apidocs/index.html" name="API Docs" />
</menu>
<menu name="Links">
<item href="http://jackrabbit.apache.org/oak" name="Apache Jackrabbit Oak" />