Return-Path: X-Original-To: apmail-felix-commits-archive@www.apache.org Delivered-To: apmail-felix-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id E3CB2E2A2 for ; Fri, 1 Mar 2013 07:27:28 +0000 (UTC) Received: (qmail 47692 invoked by uid 500); 1 Mar 2013 07:27:28 -0000 Delivered-To: apmail-felix-commits-archive@felix.apache.org Received: (qmail 47654 invoked by uid 500); 1 Mar 2013 07:27:28 -0000 Mailing-List: contact commits-help@felix.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@felix.apache.org Delivered-To: mailing list commits@felix.apache.org Received: (qmail 47644 invoked by uid 99); 1 Mar 2013 07:27:28 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 01 Mar 2013 07:27:28 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 01 Mar 2013 07:27:25 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 0D1ED23889E3 for ; Fri, 1 Mar 2013 07:27:05 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r852502 - in /websites/staging/felix/trunk/content: ./ documentation/subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.html Date: Fri, 01 Mar 2013 07:27:04 -0000 To: commits@felix.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20130301072705.0D1ED23889E3@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: buildbot Date: Fri Mar 1 07:27:04 2013 New Revision: 852502 Log: Staging update by buildbot for felix Modified: websites/staging/felix/trunk/content/ (props changed) websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.html Propchange: websites/staging/felix/trunk/content/ ------------------------------------------------------------------------------ --- cms:source-revision (original) +++ cms:source-revision Fri Mar 1 07:27:04 2013 @@ -1 +1 @@ -1451152 +1451504 Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.html ============================================================================== --- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.html (original) +++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.html Fri Mar 1 07:27:04 2013 @@ -76,16 +76,20 @@

Apache Felix Framework Usage Documentation

Apache Felix Framework Usage Documentation

Downloading the Framework

Go to the downloads page and download the latest Felix framework distribution.

@@ -102,15 +106,26 @@

Where <cache-path> is the path you want to use as the bundle cache. If you specify a relative cache path, then it will be treated as relative to the current working directory.

-**Useful Information** -Previous versions of the framework prompted for a profile name when executed. The profile name was used to create a directory inside `.felix/` in the user home directory. This approach allowed users to have different sets of bundles for different purposes, e.g., testing, production, etc. If this behavior is still desired, it is very easy to mimic. Modify `conf/config.properties` to include "`felix.cache.rootdir=$\{user.home}/.felix`". Now, if you start Felix with something like "`java -jar bin/felix.jar foo`", it will use "`$\{user.home}/.felix/foo/`" as the bundle cache directory, where "`$\{user.home\`}" is automatically substituted with the appropriate system property by the launcher. +Useful Information
+Previous versions of the framework prompted for a profile name when executed. The profile name +was used to create a directory inside .felix/ in the user home directory. This +approach allowed users to have different sets of bundles for different purposes, e.g., testing, +production, etc. If this behavior is still desired, it is very easy to mimic. Modify +conf/config.properties to include "felix.cache.rootdir=${user.home}/.felix". +Now, if you start Felix with something like "java -jar bin/felix.jar foo", it will use +"${user.home}/.felix/foo/" as the bundle cache directory, where +"${user.home}" is automatically substituted with the appropriate system property by +the launcher.

Framework Shell

The main way to interact with the framework is via the supplied Apache Felix Gogo shell. After starting the framework, type help into the shell to see the list of the available commands and help <command-name> to get help for a specific command.

-**Useful Information** -In Gogo, command names are made up of two parts: `:`. This is similar to a fully qualified class name in Java and is used to avoid naming collisions. If the `` portion of the command is unique, then you only need to type it. If not, then you must either type the full `:` or arrange the scope search path accordingly. +Useful Information
+In Gogo, command names are made up of two parts: <scope>:<name>. This is similar +to a fully qualified class name in Java and is used to avoid naming collisions. If the +<name> portion of the command is unique, then you only need to type it. If not, +then you must either type the full <scope>:<name> or arrange the scope search path accordingly.

To install bundles, use the felix:install command, which is described in more detail in the next sub-section. To list installed bundles, use the felix:lb command. To stop the framework type stop 0 to stop the System Bundle; any installed bundles will automatically be reloaded (and potentially restarted) the next time you launch with the associated cache.

@@ -142,8 +157,13 @@ In Gogo, command names are made up of tw

The felix:stop command is used to stop a bundle and the felix:uninstall command is used to remove a bundle from the bundle cache. As an alternative to using the felix:install and felix:start commands explicitly, it is also possible to install and start a bundle in one step by using the felix:start command with a bundle URL.

Bundles can be updated using the felix:update command. The update command allows you to specify an URL from which to retrieve the updated bundle, but if one is not specified it will try to update the bundle from the bundle's Bundle-UpdateLocation manifest attribute, if present, or the bundle's original location URL.

-**Useful Information** -When you use `felix:update` or `felix:uninstall`, the changes appear to take effect immediately, but in reality the changes are only partially enacted. If a bundle is updated or uninstalled and it was exporting packages, these packages are not removed until the framework is refreshed using the `PackageAdmin` service. The Felix shell offers a convenient `refresh` command for this purpose. This is the correct behavior as defined by the OSGi specification. +Useful Information
+When you use felix:update or felix:uninstall, the changes appear to take +effect immediately, but in reality the changes are only partially enacted. If a bundle is updated +or uninstalled and it was exporting packages, these packages are not removed until the framework +is refreshed using the PackageAdmin service. The Felix shell offers a convenient +refresh command for this purpose. This is the correct behavior as defined by the OSGi +specification.

For an introduction to writing bundles and services, refer to the Felix bundle tutorial.

@@ -184,7 +204,7 @@ When you use `felix:update` or `felix:un

Feedback

Subscribe to the Felix users mailing list by sending a message to users-subscribe@felix.apache.org; after subscribing, email questions or feedback to [users@felix.apache.org|mailto:users@felix.apache.org].

- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000 + Rev. 1451504 by fmeschbe on Fri, 1 Mar 2013 07:26:51 +0000
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project