You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by gn...@apache.org on 2011/02/10 11:47:38 UTC
svn commit: r1069333 - in /karaf/trunk/manual: ./ src/main/webapp/
src/main/webapp/developers-guide/ src/main/webapp/users-guide/
Author: gnodet
Date: Thu Feb 10 10:47:37 2011
New Revision: 1069333
URL: http://svn.apache.org/viewvc?rev=1069333&view=rev
Log:
Fix various things in the manual
Modified:
karaf/trunk/manual/pom.xml
karaf/trunk/manual/src/main/webapp/_navigation.conf
karaf/trunk/manual/src/main/webapp/developers-guide/security-framework.conf
karaf/trunk/manual/src/main/webapp/overview.conf
karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf
karaf/trunk/manual/src/main/webapp/users-guide/installation.conf
karaf/trunk/manual/src/main/webapp/users-guide/logging-system.conf
Modified: karaf/trunk/manual/pom.xml
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/pom.xml?rev=1069333&r1=1069332&r2=1069333&view=diff
==============================================================================
--- karaf/trunk/manual/pom.xml (original)
+++ karaf/trunk/manual/pom.xml Thu Feb 10 10:47:37 2011
@@ -42,7 +42,7 @@
<jetty-port>8080</jetty-port>
<jetty-war-dir>${project.build.directory}/webapp/</jetty-war-dir>
<scalate.version>1.4.0-SNAPSHOT</scalate.version>
- <wikitext.version>1.2</wikitext.version>
+ <wikitext.version>1.3-SNAPSHOT</wikitext.version>
<scalate.editor>${env.SCALATE_EDITOR}</scalate.editor>
<scalate.mode>production</scalate.mode>
<scalate.workdir>${project.build.directory}/scalateWorkDir</scalate.workdir>
Modified: karaf/trunk/manual/src/main/webapp/_navigation.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/_navigation.conf?rev=1069333&r1=1069332&r2=1069333&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/_navigation.conf (original)
+++ karaf/trunk/manual/src/main/webapp/_navigation.conf Thu Feb 10 10:47:37 2011
@@ -32,4 +32,4 @@ h3. [Developers Guide|/developers-guide/
- [connect-console]
- [shell-syntax]
-h3. [Commands|/commands/]
+h3. [Commands|/commands/commands]
Modified: karaf/trunk/manual/src/main/webapp/developers-guide/security-framework.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/developers-guide/security-framework.conf?rev=1069333&r1=1069332&r2=1069333&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/developers-guide/security-framework.conf (original)
+++ karaf/trunk/manual/src/main/webapp/developers-guide/security-framework.conf Thu Feb 10 10:47:37 2011
@@ -15,53 +15,10 @@ h2. Schema
To override or deploy a new realm, you can use the following XSD which is supported by a Spring namespace handler and can thus be defined in a spring xml configuration file.
Following is the XML Schema to use when defining Karaf realms:
-{pygmentize:xml}
-<xs:schema elementFormDefault='qualified'
- targetNamespace='http://karaf.apache.org/xmlns/jaas/v1.0.0'
- xmlns:xs='http://www.w3.org/2001/XMLSchema'
- xmlns:bp="http://www.osgi.org/xmlns/blueprint/v1.0.0"
- xmlns:tns='http://karaf.apache.org/xmlns/jaas/v1.0.0'>
-
- <xs:import namespace="http://www.osgi.org/xmlns/blueprint/v1.0.0"/>
-
- <xs:element name="config">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="module" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType mixed="true">
- <xs:attribute name="className" use="required" type="xs:string" />
- <xs:attribute name="flags" default="required">
- <xs:simpleType>
- <xs:restriction base="xs:NMTOKEN">
- <xs:enumeration value="required"/>
- <xs:enumeration value="requisite"/>
- <xs:enumeration value="sufficient"/>
- <xs:enumeration value="optional"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- <xs:attribute name="name" use="required" type="xs:string" />
- <xs:attribute name="rank" use="optional" default="0" type="xs:int" />
- </xs:complexType>
- </xs:element>
-
- <xs:element name="keystore">
- <xs:complexType>
- <xs:attribute name="name" use="required" type="xs:string" />
- <xs:attribute name="rank" use="optional" default="0" type="xs:int" />
- <xs:attribute name="path" use="required" type="xs:string" />
- <xs:attribute name="keystorePassword" use="optional" type="xs:string" />
- <xs:attribute name="keyPasswords" use="optional" type="xs:string" />
- </xs:complexType>
- </xs:element>
-
-</xs:schema>
-{pygmentize}
+{snippet:url=../jaas/config/src/main/resources/org/apache/karaf/jaas/config/karaf-jaas-1.1.0.xsd|lang=xml|pygmentize=true}
+{snippet}
-You can find the schema at the following [location|https://svn.apache.org/repos/asf/karaf/tags/karaf-2.0.0/jaas/config/src/main/resources/org/apache/karaf/jaas/config/karaf-jaas.xsd].
+You can find the schema at the following [location|http://karaf.apache.org/xmlns/jaas/v1.1.0].
Here are two example using this schema:
{pygmentize:xml}
@@ -82,7 +39,7 @@ Here are two example using this schema:
</blueprint>
{pygmentize}
{pygmentize:xml}
-<jaas:keystore xmlns:jaas="http://karaf.apache.org/xmlns/jaas/v1.0.0"
+<jaas:keystore xmlns:jaas="http://karaf.apache.org/xmlns/jaas/v1.1.0"
name="ks"
rank="1"
path="classpath:privatestore.jks"
@@ -105,7 +62,7 @@ So if you want to override the default s
{pygmentize:xml}
<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
- xmlns:jaas="http://karaf.apache.org/xmlns/jaas/v1.0.0"
+ xmlns:jaas="http://karaf.apache.org/xmlns/jaas/v1.1.0"
xmlns:ext="http://aries.apache.org/blueprint/xmlns/blueprint-ext/v1.0.0">
<!-- Bean to allow the $[karaf.base] property to be correctly resolved -->
Modified: karaf/trunk/manual/src/main/webapp/overview.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/overview.conf?rev=1069333&r1=1069332&r2=1069333&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/overview.conf (original)
+++ karaf/trunk/manual/src/main/webapp/overview.conf Thu Feb 10 10:47:37 2011
@@ -4,8 +4,8 @@ Apache Karaf is a small OSGi based runti
Here is a short list of features supported by the Karaf:
-* *Hot deployment*: Karaf supports hot deployment of OSGi bundles by monitoring jar files inside the {{[home]/deploy}} directory. Each time a jar is copied in this folder, it will be installed inside the runtime. You can then update or delete it and changes will be handled automatically. In addition, the Karaf also supports exploded bundles and custom deployers (blueprint and spring ones are included by default).
-* *Dynamic configuration*: Services are usually configured through the ConfigurationAdmin OSGi service. Such configuration can be defined in Karaf using property files inside the {{[home]/etc}} directory. These configurations are monitored and changes on the properties files will be propagated to the services.
+* *Hot deployment*: Karaf supports hot deployment of OSGi bundles by monitoring jar files inside the {{\[home\]/deploy}} directory. Each time a jar is copied in this folder, it will be installed inside the runtime. You can then update or delete it and changes will be handled automatically. In addition, the Karaf also supports exploded bundles and custom deployers (blueprint and spring ones are included by default).
+* *Dynamic configuration*: Services are usually configured through the ConfigurationAdmin OSGi service. Such configuration can be defined in Karaf using property files inside the {{\[home\]/etc}} directory. These configurations are monitored and changes on the properties files will be propagated to the services.
* *Logging System*: using a centralized logging back end supported by Log4J, Karaf supports a number of different APIs (JDK 1.4, JCL, SLF4J, Avalon, Tomcat, OSGi)
* *Provisioning*: Provisioning of libraries or applications can be done through a number of different ways, by which they will be downloaded locally, installed and started.
* *Native OS integration*: Karaf can be integrated into your own Operating System as a service so that the lifecycle will be bound to your Operating System.
Modified: karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf?rev=1069333&r1=1069332&r2=1069333&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/configuration.conf Thu Feb 10 10:47:37 2011
@@ -6,14 +6,14 @@ The files in the {{etc}} directory are u
For dynamic configuration, Karaf provides a suite of command to administer the configuration service grouped under {{config}}. To learn about all currently supported configuration commands type:
-|| Command || Description ||
-| cancel | Change the changes to the configuration being edited. |
-| edit | Create or edit a configuration. |
-| list | List existing configurations. |
-| propdel | Delete a property from the edited configuration. |
-| proplist | List properties from the edited configuration. |
-| propset | Set a property on the edited configuration. |
-| update | Save and propagate changes from the configuration being edited. |
+|| Command || Description ||
+| [{{cancel}}|/commands/config-cancel] | Change the changes to the configuration being edited. |
+| [{{edit}}|/commands/config-edit] | Create or edit a configuration. |
+| [{{list}}|/commands/config-list] | List existing configurations. |
+| [{{propdel}}|/commands/config-propdel] | Delete a property from the edited configuration. |
+| [{{proplist}}|/commands/config-proplist] | List properties from the edited configuration. |
+| [{{propset}}|/commands/config-propset] | Set a property on the edited configuration. |
+| [{{update}}|/commands/config-update] | Save and propagate changes from the configuration being edited. |
h2. Editing
@@ -23,16 +23,16 @@ h3. Select Configuration To Edit
For example to edit configuration {{foo.bar}}:
{code}
-karaf@root:/> config:edit foo.bar
+karaf@root> config:edit foo.bar
{code}
h3. Modify Properties
Use:
- * {{config:proplist}} to list existing properties
- * {{config:propdel}} to delete existing properties
- * {{config:propset}} to set a new value for a property
+ * [{{config:proplist}}|/commands/config-proplist] to list existing properties
+ * [{{config:propdel}}|/commands/config-propdel] to delete existing properties
+ * [{{config:propset}}|/commands/config-propset] to set a new value for a property
Any number of properties can be modified within a single editing session.
@@ -40,7 +40,7 @@ h3. Commit Or Rollback Changes
Use
- * {{config:update}} to commit all changes made in the current session
- * {{config:cancel}} to roll back any changes made in the current session
+ * [{{config:update}}|/commands/config-update] to commit all changes made in the current session
+ * [{{config:cancel}}|/commands/config-cancel] to roll back any changes made in the current session
Modified: karaf/trunk/manual/src/main/webapp/users-guide/installation.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/installation.conf?rev=1069333&r1=1069332&r2=1069333&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/installation.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/installation.conf Thu Feb 10 10:47:37 2011
@@ -40,7 +40,7 @@ For a source distribution, the filename
# {anchor:Windows Source Installation} Build Karaf using Maven 2.2.1 or greater and Java 5.
The recommended method of building Karaf is the following:
{code}
-cd \[karaf_install_dir\]\src
+cd [karaf_install_dir]\src
{code}
where {{\[karaf_install_dir\]}} is the directory in which Karaf was installed.
{code}
@@ -49,7 +49,7 @@ mvn
Both steps take around 10 to 15 minutes.
# Unzip the distribution using your favorite zip tool. The windows distribution is available at
{code}
-\[karaf_install_dir\]\assembly\target\apache-karaf-x.y.zip
+[karaf_install_dir]\assembly\target\apache-karaf-x.y.zip
{code}
# Proceed to the [Starting Karaf|start-stop#Starting Karaf] chapter.
@@ -68,7 +68,7 @@ Please remember the restrictions concern
# Build Karaf using Maven:
The preferred method of building Karaf is the following:
{code}
-cd \[karaf_install_dir\]/src
+cd [karaf_install_dir]/src
{code}
where \[karaf_install_dir\] is the directory in which Karaf was installed.
{code}
@@ -76,7 +76,7 @@ mvn
{code}
# Uncompress the distribution that has just been created
{code}
-cd \[karaf_install_dir\]/assembly/target
+cd [karaf_install_dir]/assembly/target
gunzip apache-karaf-x.y.tar.gz
tar xvf apache-karaf-x.y.tar
{code}
Modified: karaf/trunk/manual/src/main/webapp/users-guide/logging-system.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/logging-system.conf?rev=1069333&r1=1069332&r2=1069333&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/logging-system.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/logging-system.conf Thu Feb 10 10:47:37 2011
@@ -52,11 +52,13 @@ log4j.appender.stdout.threshold=WARN
h2. Commands
-The log subshell comes with 3 commands:
+The log subshell comes with the following commands:
+* [{{log:clear}}|/commands/log-clear]: clear the log
* [{{log:display}}|/commands/log-display]: display the last log entries
* [{{log:display-exception}}|/commands/log-display-exception]: display the last exception from the log
* [{{log:get}}|/commands/log-get]: show the log levels
* [{{log:set}}|/commands/log-set]: set the log levels
+* [{{log:tail}}|/commands/log-tail]: continuous display of the log entries
For example, if you want to debug something, you might want to run the following commands:
{code}