You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2013/10/26 12:08:33 UTC
svn commit: r1535960 - in /karaf/trunk/manual/src/main/webapp: overview.conf
quick-start.conf
Author: jbonofre
Date: Sat Oct 26 10:08:32 2013
New Revision: 1535960
URL: http://svn.apache.org/r1535960
Log:
Update and cleanup documentation
Modified:
karaf/trunk/manual/src/main/webapp/overview.conf
karaf/trunk/manual/src/main/webapp/quick-start.conf
Modified: karaf/trunk/manual/src/main/webapp/overview.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/overview.conf?rev=1535960&r1=1535959&r2=1535960&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/overview.conf (original)
+++ karaf/trunk/manual/src/main/webapp/overview.conf Sat Oct 26 10:08:32 2013
@@ -1,10 +1,10 @@
h1. Karaf Overview
-Apache Karaf is a small OSGi based runtime which provides a lightweight container onto which various components and applications can be deployed.
-* Uses either Apache Felix or Eclipse Equinox as OSGi framework and extends these with many features that make it a fully featured server
-* Can be scaled from a very lightweight small container to a fully featured enterprise Server
+Apache Karaf is a OSGi-based runtime which provides a lightweight container onto which various components and applications can be deployed.
-[See all Karaf features in detail|features]
+Apache Karaf uses either Apache Felix Framework or Eclipse Equinox OSGi frameworks, and provide additional features on top of the framework.
+
+Apache Karaf can be scaled from a very lightweight container to a fully features enterprise service: it's a very flexible and extensible container, covering all the major needs.
Here is a short list of features supported by the Karaf:
Modified: karaf/trunk/manual/src/main/webapp/quick-start.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/quick-start.conf?rev=1535960&r1=1535959&r2=1535960&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/quick-start.conf (original)
+++ karaf/trunk/manual/src/main/webapp/quick-start.conf Sat Oct 26 10:08:32 2013
@@ -4,7 +4,7 @@ This instructions should help you get Ap
h2. Prerequisites
-Karaf requires a Java SE 6 environment to run. Refer to [http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 1.6 or greater.
+Karaf requires a Java SE 7 environment to run. Refer to [http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 1.7 or greater.
* Open a Web browser and access the following URL: [http://karaf.apache.org/index/community/download.html]
* Download the binary distribution that matches your system (zip for windows, tar.gz for unixes)
@@ -31,23 +31,26 @@ You should see the following information
/ /| |/ /_/ / / / /_/ / __/
/_/ |_|\__,_/_/ \__,_/_/
- Apache Karaf (3.0.0-SNAPSHOT)
+ Apache Karaf (3.0.0)
Hit '<tab>' for a list of available commands
and '[cmd] --help' for help on a specific command.
-Hit '<ctrl-d>' or 'system:shutdown' to shutdown Karaf.
+Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown Karaf.
+
+karaf@root()>
-karaf@root()>
{code}
h2. Some shell Basics
You can now run your first command. Simply type the {{<tab>}} key in the console.
{code:borderStyle=solid}
-karaf@root>
-
-instance:change-port instance:connect instance:create instance:destroy
-instance:list instance:start instance:stop config:cancel
+karaf@root> Display all 183 possibilities? (y or n)
+*:config *:dev *:feature *:instance *:jaas *:kar *:log *:package
+*:region *:service *:shell *:ssh addbundle addfilter addregion alias
+cancel cl clear clone config config:cancel config:delete config:edit
+config:list config:property-append config:property-delete config:property-list config:property-set config:update connect create
+date delete destroy dev dev:dump-create display dump-create each
...
{code}
@@ -59,7 +62,24 @@ DESCRIPTION
bundle:list
Lists all installed bundles.
-...
+
+SYNTAX
+ bundle:list [options]
+
+OPTIONS
+ -u
+ Shows the update locations
+ --help
+ Display this help message
+ --table
+ Show bundles using a shell table
+ -t
+ Specifies the bundle threshold; bundles with a start-level less than this value will not get printed out.
+ -l
+ Show the locations
+ -s
+ Shows the symbolic name
+
{code}
Note that the console supports tab completion so if your start typing a command it will show possible completions and also auto complete if there is only one completion.
@@ -70,9 +90,10 @@ While you will learn in the Karaf user's
In the console, run the following commands:
{code}
-feature:repo-add camel 2.10.0
-feature:install camel-spring
-install -s mvn:org.apache.camel/camel-example-osgi/2.10.1
+karaf@root()> feature:repo-add camel 2.10.0
+Adding feature url mvn:org.apache.camel.karaf/apache-camel/2.10.0/xml/features
+karaf@root()> feature:install camel-spring
+karaf@root()> bundle:install -s mvn:org.apache.camel/camel-example-osgi/2.10.1
{code}
The example installed is using Camel to start a timer every 2 seconds and output a message on the console.
@@ -88,7 +109,7 @@ h3. Stopping and uninstalling the sample
To stop this demo, run the following command:
{code}
-bundle:stop org.apache.camel.camel-example-osgi
+karaf@root()> bundle:stop org.apache.camel.camel-example-osgi
{code}
h2. Stopping Karaf