Added: karaf/site/production/manual/latest/commands/maven-repository-list.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/maven-repository-list.adoc?rev=1816059&view=auto ============================================================================== --- karaf/site/production/manual/latest/commands/maven-repository-list.adoc (added) +++ karaf/site/production/manual/latest/commands/maven-repository-list.adoc Wed Nov 22 14:52:25 2017 @@ -0,0 +1,26 @@ += maven:repository-list + +== Description + +Maven repository summary. + +== Syntax + +maven:repository-list [options] + +== Options + +|=== +|Name |Description + +|-v, --verbose +|Show additional information (policies, source) + +|-x, --show-passwords +|Do not hide passwords related to Maven encryption + +|--help +|Display this help message +|=== + +
Added: karaf/site/production/manual/latest/commands/maven-repository-remove.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/maven-repository-remove.adoc?rev=1816059&view=auto ============================================================================== --- karaf/site/production/manual/latest/commands/maven-repository-remove.adoc (added) +++ karaf/site/production/manual/latest/commands/maven-repository-remove.adoc Wed Nov 22 14:52:25 2017 @@ -0,0 +1,32 @@ += maven:repository-remove + +== Description + +Removes Maven repository + +== Syntax + +maven:repository-remove [options] + +== Options + +|=== +|Name |Description + +|-f, --force +|Do not ask for confirmation + +|-id +|Identifier of repository + +|-d, --default +|Edit default repository instead of remote one + +|-x, --show-passwords +|Do not hide passwords related to Maven encryption + +|--help +|Display this help message +|=== + + Added: karaf/site/production/manual/latest/commands/maven-summary.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/maven-summary.adoc?rev=1816059&view=auto ============================================================================== --- karaf/site/production/manual/latest/commands/maven-summary.adoc (added) +++ karaf/site/production/manual/latest/commands/maven-summary.adoc Wed Nov 22 14:52:25 2017 @@ -0,0 +1,32 @@ += maven:summary + +== Description + +Maven configuration summary. + +== Syntax + +maven:summary [options] + +== Options + +|=== +|Name |Description + +|-p, --property-ids +|Use PID property identifiers instead of their names + +|-s, --source +|Adds information about where the value is configured + +|-d, --description +|Adds description of Maven configuration options + +|-x, --show-passwords +|Do not hide passwords related to Maven encryption + +|--help +|Display this help message +|=== + + Modified: karaf/site/production/manual/latest/commands/obr-deploy.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/obr-deploy.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/obr-deploy.adoc (original) +++ karaf/site/production/manual/latest/commands/obr-deploy.adoc Wed Nov 22 14:52:25 2017 @@ -22,14 +22,14 @@ obr:deploy [options] bundles |=== |Name |Description +|-d, --deployOptional +|Deploy optional bundles + |-s, --start |Start the deployed bundles |--help |Display this help message - -|-d, --deployOptional -|Deploy optional bundles |=== Modified: karaf/site/production/manual/latest/commands/obr-list.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/obr-list.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/obr-list.adoc (original) +++ karaf/site/production/manual/latest/commands/obr-list.adoc Wed Nov 22 14:52:25 2017 @@ -22,11 +22,11 @@ obr:list [options] [packages] |=== |Name |Description -|--no-format -|Disable table rendered output - |--help |Display this help message + +|--no-format +|Disable table rendered output |=== Modified: karaf/site/production/manual/latest/commands/obr-resolve.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/obr-resolve.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/obr-resolve.adoc (original) +++ karaf/site/production/manual/latest/commands/obr-resolve.adoc Wed Nov 22 14:52:25 2017 @@ -22,26 +22,26 @@ obr:resolve [options] requirements |=== |Name |Description -|--start -|Deploy and start the selected bundles - |-w, --why |Display the reason of the inclusion of the resource +|--no-remote +|Ignore remote resources during resolution + |-l, --no-local |Ignore local resources during resolution -|--help -|Display this help message - |--deploy |Deploy the selected bundles |--optional |Resolve optional dependencies -|--no-remote -|Ignore remote resources during resolution +|--start +|Deploy and start the selected bundles + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/obr-source.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/obr-source.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/obr-source.adoc (original) +++ karaf/site/production/manual/latest/commands/obr-source.adoc Wed Nov 22 14:52:25 2017 @@ -25,11 +25,11 @@ obr:source [options] folder bundles |=== |Name |Description -|--help -|Display this help message - |-x |Extract the archive + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/obr-start.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/obr-start.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/obr-start.adoc (original) +++ karaf/site/production/manual/latest/commands/obr-start.adoc Wed Nov 22 14:52:25 2017 @@ -22,11 +22,11 @@ obr:start [options] bundles |=== |Name |Description -|--help -|Display this help message - |-d, --deployOptional |Deploy optional bundles + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/obr-url-list.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/obr-url-list.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/obr-url-list.adoc (original) +++ karaf/site/production/manual/latest/commands/obr-url-list.adoc Wed Nov 22 14:52:25 2017 @@ -13,11 +13,11 @@ obr:url-list [options] |=== |Name |Description -|--no-format -|Disable table rendered output - |--help |Display this help message + +|--no-format +|Disable table rendered output |=== Modified: karaf/site/production/manual/latest/commands/package-exports.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/package-exports.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/package-exports.adoc (original) +++ karaf/site/production/manual/latest/commands/package-exports.adoc Wed Nov 22 14:52:25 2017 @@ -13,11 +13,14 @@ package:exports [options] |=== |Name |Description +|-b +|Only show packages exported by given bundle id + |-d |Only show packages that are exported by more than one bundle -|--no-format -|Disable table rendered output +|--show-name-only +|Show only package name |-p |Only show package starting with given name @@ -25,11 +28,8 @@ package:exports [options] |--help |Display this help message -|--show-name-only -|Show only package name - -|-b -|Only show packages exported by given bundle id +|--no-format +|Disable table rendered output |=== Modified: karaf/site/production/manual/latest/commands/package-imports.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/package-imports.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/package-imports.adoc (original) +++ karaf/site/production/manual/latest/commands/package-imports.adoc Wed Nov 22 14:52:25 2017 @@ -13,8 +13,14 @@ package:imports [options] |=== |Name |Description -|--no-format -|Disable table rendered output +|-b +|Only show imports of the given bundle id + +|--show-name-only +|Show only package name + +|--filter +|Only show package instead of full filter |-p |Only show package starting with given name @@ -22,14 +28,8 @@ package:imports [options] |--help |Display this help message -|--filter -|Only show package instead of full filter - -|-b -|Only show imports of the given bundle id - -|--show-name-only -|Show only package name +|--no-format +|Disable table rendered output |=== Modified: karaf/site/production/manual/latest/commands/profile-copy.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/profile-copy.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/profile-copy.adoc (original) +++ karaf/site/production/manual/latest/commands/profile-copy.adoc Wed Nov 22 14:52:25 2017 @@ -25,11 +25,11 @@ profile:copy [options] source profile ta |=== |Name |Description -|--help -|Display this help message - |-f, --force |Flag to allow overwriting the target profile (if exists). + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/profile-create.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/profile-create.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/profile-create.adoc (original) +++ karaf/site/production/manual/latest/commands/profile-create.adoc Wed Nov 22 14:52:25 2017 @@ -25,9 +25,6 @@ profile:create [options] [profileId] |--help |Display this help message -|--version -|The profile version. Defaults to the current default version. - |--parents |Optionally specifies one or multiple parent profiles. To specify multiple parent profiles, specify this flag multiple times on the command line. For example, --parents foo --parents bar. |=== Modified: karaf/site/production/manual/latest/commands/profile-display.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/profile-display.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/profile-display.adoc (original) +++ karaf/site/production/manual/latest/commands/profile-display.adoc Wed Nov 22 14:52:25 2017 @@ -25,14 +25,14 @@ profile:display [options] profile |--overlay, -o |Shows the overlay profile settings, taking into account the settings inherited from parent profiles. -|--help -|Display this help message - |--effective, -e |Shows the effective profile settings, taking into account properties substitution. |--display-resources, -r |Displays the content of additional profile resources. + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/profile-edit.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/profile-edit.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/profile-edit.adoc (original) +++ karaf/site/production/manual/latest/commands/profile-edit.adoc Wed Nov 22 14:52:25 2017 @@ -25,56 +25,56 @@ profile:edit [options] profile |--remove |Removes value from a delimited list. It is only usable with the system, config & pid options +|--delete +|Delete values. This option can be used to delete a feature, a bundle or a pid from the profile. + +|--append +|Append value to a delimited list. It is only usable with the system, config & pid options + |-c, --config |Edit the Java system properties that affect the karaf container (analogous to editing etc/config.properties in a root container). -|--resource -|Selects a resource under the profile to edit. This option should only be used alone. - |--delimiter |Specifies the delimiter to use for appends and removals. -|--append -|Append value to a delimited list. It is only usable with the system, config & pid options - |-x, --extension |Edit extension libraries. To specify multiple libraries, specify this flag multiple times. -|-f, --features -|Edit features. To specify multiple features, specify this flag multiple times. For example, --features foo --features bar. +|-p, --pid +|Edit an OSGi configuration property, specified in the format <PID>/<Property>. To specify multiple properties, specify this flag multiple times. + +|--resource +|Selects a resource under the profile to edit. This option should only be used alone. |--set |Set or create values (selected by default). -|--delete -|Delete values. This option can be used to delete a feature, a bundle or a pid from the profile. - -|-r, --repositories -|Edit the features repositories. To specify multiple repositories, specify this flag multiple times. - |-i, --import-pid |Imports the pids that are edited, from local OSGi config admin -|-l, --libs -|Edit libraries. To specify multiple libraries, specify this flag multiple times. - -|-n, --endorsed -|Edit endorsed libraries. To specify multiple libraries, specify this flag multiple times. - |--help |Display this help message -|-b, --bundles -|Edit bundles. To specify multiple bundles, specify this flag multiple times. +|-f, --features +|Edit features. To specify multiple features, specify this flag multiple times. For example, --features foo --features bar. -|-p, --pid -|Edit an OSGi configuration property, specified in the format <PID>/<Property>. To specify multiple properties, specify this flag multiple times. +|-r, --repositories +|Edit the features repositories. To specify multiple repositories, specify this flag multiple times. + +|-o, --overrides +|Edit overrides. To specify multiple libraries, specify this flag multiple times. |-s, --system |Edit the Java system properties that affect installed bundles (analogous to editing etc/system.properties in a root container). -|-o, --overrides -|Edit overrides. To specify multiple libraries, specify this flag multiple times. +|-b, --bundles +|Edit bundles. To specify multiple bundles, specify this flag multiple times. + +|-n, --endorsed +|Edit endorsed libraries. To specify multiple libraries, specify this flag multiple times. + +|-l, --libs +|Edit libraries. To specify multiple libraries, specify this flag multiple times. |=== == Details Modified: karaf/site/production/manual/latest/commands/scheduler-schedule.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/scheduler-schedule.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/scheduler-schedule.adoc (original) +++ karaf/site/production/manual/latest/commands/scheduler-schedule.adoc Wed Nov 22 14:52:25 2017 @@ -22,26 +22,26 @@ scheduler:schedule [options] script |=== |Name |Description -|--at -|Absolute date in ISO format (ex: 2014-05-13T13:56:45) - -|--concurrent -|Should jobs run concurrently or not (defaults to false) - |--period |Time during executions (in seconds) -|--help -|Display this help message +|--at +|Absolute date in ISO format (ex: 2014-05-13T13:56:45) |--times |Number of times this job should be executed +|--name +|Name of this job + +|--concurrent +|Should jobs run concurrently or not (defaults to false) + |--cron |The cron expression -|--name -|Name of this job +|--help +|Display this help message |=== Added: karaf/site/production/manual/latest/commands/scheduler-trigger.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/scheduler-trigger.adoc?rev=1816059&view=auto ============================================================================== --- karaf/site/production/manual/latest/commands/scheduler-trigger.adoc (added) +++ karaf/site/production/manual/latest/commands/scheduler-trigger.adoc Wed Nov 22 14:52:25 2017 @@ -0,0 +1,32 @@ += scheduler:trigger + +== Description + +Manually trigger a scheduled job + +== Syntax + +scheduler:trigger [options] name + +== Arguments + +|=== +|Name |Description + +| name +| Name of the job to trigger +|=== + +== Options + +|=== +|Name |Description + +|-b, background +|schedule the trigger in the background + +|--help +|Display this help message +|=== + + Modified: karaf/site/production/manual/latest/commands/service-list.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/service-list.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/service-list.adoc (original) +++ karaf/site/production/manual/latest/commands/service-list.adoc Wed Nov 22 14:52:25 2017 @@ -22,14 +22,14 @@ service:list [options] [objectClass] |=== |Name |Description +|-a +|Shows all services. (By default Karaf commands are hidden) + |-n |Shows only service class names |--help |Display this help message - -|-a -|Shows all services. (By default Karaf commands are hidden) |=== Modified: karaf/site/production/manual/latest/commands/service-wait.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/service-wait.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/service-wait.adoc (original) +++ karaf/site/production/manual/latest/commands/service-wait.adoc Wed Nov 22 14:52:25 2017 @@ -22,14 +22,14 @@ service:wait [options] service |=== |Name |Description +|-t, --timeout +|timeout to wait for the service (in milliseconds, negative to not wait at all, zero to wait forever) + |-e, --exception |throw an exception if the service is not found after the timeout |--help |Display this help message - -|-t, --timeout -|timeout to wait for the service (in milliseconds, negative to not wait at all, zero to wait forever) |=== Modified: karaf/site/production/manual/latest/commands/shell-threads.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/shell-threads.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/shell-threads.adoc (original) +++ karaf/site/production/manual/latest/commands/shell-threads.adoc Wed Nov 22 14:52:25 2017 @@ -22,32 +22,32 @@ shell:threads [options] [id] |=== |Name |Description +|--tree +|Display threads as a tree + |--list |Display threads as a list +|-e, --empty-groups +|Show empty groups + |--packages |Pruned packages -|--no-format -|Disable table rendered output +|--monitors +|Display monitors |-t, --threshold |Minimal number of interesting stack trace line to display a thread -|--tree -|Display threads as a tree - |--locks |Display locks |--help |Display this help message -|--monitors -|Display monitors - -|-e, --empty-groups -|Show empty groups +|--no-format +|Disable table rendered output |=== Modified: karaf/site/production/manual/latest/commands/shell-watch.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/shell-watch.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/shell-watch.adoc (original) +++ karaf/site/production/manual/latest/commands/shell-watch.adoc Wed Nov 22 14:52:25 2017 @@ -22,14 +22,14 @@ shell:watch [options] command |=== |Name |Description -|-a, --append -|The output should be appended but not clear the console +|-n, --interval +|The interval between executions of the command in seconds |--help |Display this help message -|-n, --interval -|The interval between executions of the command in seconds +|-a, --append +|The output should be appended but not clear the console |=== Modified: karaf/site/production/manual/latest/commands/ssh-ssh.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/ssh-ssh.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/ssh-ssh.adoc (original) +++ karaf/site/production/manual/latest/commands/ssh-ssh.adoc Wed Nov 22 14:52:25 2017 @@ -25,12 +25,6 @@ ssh:ssh [options] hostname [command] |=== |Name |Description -|--help -|Display this help message - -|-l, --username -|The user name for remote login - |-P, --password |The password for remote login @@ -43,8 +37,14 @@ ssh:ssh [options] hostname [command] |-r, --retries |retry connection establishment (up to attempts times) +|-l, --username +|The user name for remote login + |-k, --keyfile |The private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/ssh-sshd.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/ssh-sshd.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/ssh-sshd.adoc (original) +++ karaf/site/production/manual/latest/commands/ssh-sshd.adoc Wed Nov 22 14:52:25 2017 @@ -13,20 +13,23 @@ ssh:sshd [options] |=== |Name |Description -|-i, --idle-timeout -|The session idle timeout in milliseconds +|-b, --background +|The service will run in the background |-p, --port |The port to setup the SSH server -|--help -|Display this help message - -|-b, --background -|The service will run in the background +|-i, --idle-timeout +|The session idle timeout in milliseconds |-w, --welcome-banner |The welcome banner to display when logging in + +|--help +|Display this help message + +|-n, --nio-workers +|The number of NIO worker threads to use |=== Modified: karaf/site/production/manual/latest/commands/subsystem-info.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/subsystem-info.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/subsystem-info.adoc (original) +++ karaf/site/production/manual/latest/commands/subsystem-info.adoc Wed Nov 22 14:52:25 2017 @@ -22,11 +22,11 @@ subsystem:info [options] [id] |=== |Name |Description -|--help -|Display this help message - |--indent |Indentation method + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/system-framework.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/system-framework.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/system-framework.adoc (original) +++ karaf/site/production/manual/latest/commands/system-framework.adoc Wed Nov 22 14:52:25 2017 @@ -25,11 +25,11 @@ system:framework [options] [framework] |-nodebug, --disable-debug |Disable debug for the OSGi framework -|--help -|Display this help message - |-debug, --enable-debug |Enable debug for the OSGi framework + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/system-property.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/system-property.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/system-property.adoc (original) +++ karaf/site/production/manual/latest/commands/system-property.adoc Wed Nov 22 14:52:25 2017 @@ -28,14 +28,14 @@ system:property [options] [key] [value] |-f, --file-dump |Dump all system properties in a file (in data folder) -|--help -|Display this help message - |-p, --persistent |Persist the new value to the etc/system.properties file |-u, --unset |Show unset know properties with value unset + +|--help +|Display this help message |=== Modified: karaf/site/production/manual/latest/commands/system-shutdown.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/system-shutdown.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/system-shutdown.adoc (original) +++ karaf/site/production/manual/latest/commands/system-shutdown.adoc Wed Nov 22 14:52:25 2017 @@ -22,23 +22,23 @@ system:shutdown [options] [time] |=== |Name |Description -|-r, --reboot -|Reboot the Karaf container. +|-c, --clean, --clean-all, -ca +|Force a clean restart by deleting the data directory -|--help -|Display this help message +|-h, --halt +|Halt the Karaf container. |-cc, --clean-cache, -cc |Force a clean restart by deleting the cache directory +|--help +|Display this help message + |-f, --force |Force the shutdown without confirmation message. -|-h, --halt -|Halt the Karaf container. - -|-c, --clean, --clean-all, -ca -|Force a clean restart by deleting the data directory +|-r, --reboot +|Reboot the Karaf container. |=== Modified: karaf/site/production/manual/latest/commands/web-list.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/web-list.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/web-list.adoc (original) +++ karaf/site/production/manual/latest/commands/web-list.adoc Wed Nov 22 14:52:25 2017 @@ -13,11 +13,11 @@ web:list [options] |=== |Name |Description -|--no-format -|Disable table rendered output - |--help |Display this help message + +|--no-format +|Disable table rendered output |=== Modified: karaf/site/production/manual/latest/commands/wrapper-install.adoc URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/commands/wrapper-install.adoc?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/commands/wrapper-install.adoc (original) +++ karaf/site/production/manual/latest/commands/wrapper-install.adoc Wed Nov 22 14:52:25 2017 @@ -13,11 +13,17 @@ wrapper:install [options] |=== |Name |Description +|-i, --include +|Specify include statement for JSW wrapper conf. To specify multiple include statement, specify this flag multiple times. + |-D, --description |The description of the service. -|-i, --include -|Specify include statement for JSW wrapper conf. To specify multiple include statement, specify this flag multiple times. +|-s, --start-type +|Mode in which the service is installed. AUTO_START or DEMAND_START (Default: AUTO_START) + +|-e, --env +|Specify environment variable and values. To specify multiple environment variable and values, specify this flag multiple times. |-n, --name |The service name that will be used when installing the service. (Default: karaf) @@ -25,14 +31,8 @@ wrapper:install [options] |-d, --display |The display name of the service. -|-s, --start-type -|Mode in which the service is installed. AUTO_START or DEMAND_START (Default: AUTO_START) - |--help |Display this help message - -|-e, --env -|Specify environment variable and values. To specify multiple environment variable and values, specify this flag multiple times. |=== Added: karaf/site/production/manual/latest/configuration.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/configuration.html?rev=1816059&view=auto ============================================================================== --- karaf/site/production/manual/latest/configuration.html (added) +++ karaf/site/production/manual/latest/configuration.html Wed Nov 22 14:52:25 2017 @@ -0,0 +1,1043 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 1.5.2"> +<title>Configuration</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";> +<style> +/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ +/* Remove the comments around the @import statement below when using this as a custom stylesheet */ +/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} +audio,canvas,video{display:inline-block} +audio:not([controls]){display:none;height:0} +[hidden],template{display:none} +script{display:none!important} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +body{margin:0} +a{background:transparent} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +dfn{font-style:italic} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} +input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +#map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +.antialiased,body{-webkit-font-smoothing:antialiased} +img{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:none} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ul.no-bullet{list-style:none} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite:before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7;font-weight:bold} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} +.clearfix:after,.float-group:after{clear:both} +*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} +pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} +.keyseq{color:rgba(51,51,51,.8)} +kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menu{color:rgba(0,0,0,.8)} +b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} +b.button:before{content:"[";padding:0 3px 0 2px} +b.button:after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} +#header:after,#content:after,#footnotes:after,#footer:after{clear:both} +#content{margin-top:1.25em} +#content:before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} +#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span:before{content:"\00a0\2013\00a0"} +#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark:before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber:after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +@media only screen and (min-width:768px){#toctitle{font-size:1.375em} +body.toc2{padding-left:15em;padding-right:0} +#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{width:20em} +#toc.toc2 #toctitle{font-size:1.375em} +#toc.toc2>ul{font-size:.95em} +#toc.toc2 ul ul{padding-left:1.25em} +body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +#content #toc>:first-child{margin-top:0} +#content #toc>:last-child{margin-bottom:0} +#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} +#footer-text{color:rgba(255,255,255,.8);line-height:1.44} +.sect1{padding-bottom:.625em} +@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} +.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} +.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.listingblock>.content{position:relative} +.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]:before{display:block} +.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} +table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} +table.pyhltable td.code{padding-left:.75em;padding-right:0} +pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} +pre.pygments .lineno{display:inline-block;margin-right:.25em} +table.pyhltable .linenodiv{background:none!important;padding-right:0!important} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} +.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} +.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} +.quoteblock .quoteblock blockquote:before{display:none} +.verseblock{margin:0 1em 1.25em 1em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} +.quoteblock.abstract{margin:0 0 1.25em 0;display:block} +.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} +.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} +table.tableblock{max-width:100%;border-collapse:separate} +table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} +table.spread{width:100%} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} +table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} +table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} +table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} +table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} +table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} +table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot{border-width:1px 0} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +td>div.verse{white-space:pre} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} +ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px} +ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} +ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} +ul.inline>li>*{display:block} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1{padding-right:.75em;font-weight:bold} +td.hdlist1,td.hdlist2{vertical-align:top} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} +.colist>table tr>td:last-of-type{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} +.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none} +span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} +span.footnote a,span.footnoteref a{text-decoration:none} +span.footnote a:active,span.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} +#footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background-color:#00fafa} +.black{color:#000} +.black-background{background-color:#000} +.blue{color:#0000bf} +.blue-background{background-color:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background-color:#fa00fa} +.gray{color:#606060} +.gray-background{background-color:#7d7d7d} +.green{color:#006000} +.green-background{background-color:#007d00} +.lime{color:#00bf00} +.lime-background{background-color:#00fa00} +.maroon{color:#600000} +.maroon-background{background-color:#7d0000} +.navy{color:#000060} +.navy-background{background-color:#00007d} +.olive{color:#606000} +.olive-background{background-color:#7d7d00} +.purple{color:#600060} +.purple-background{background-color:#7d007d} +.red{color:#bf0000} +.red-background{background-color:#fa0000} +.silver{color:#909090} +.silver-background{background-color:#bcbcbc} +.teal{color:#006060} +.teal-background{background-color:#007d7d} +.white{color:#bfbfbf} +.white-background{background-color:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background-color:#fafa00} +span.icon>.fa{cursor:default} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]:after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +h1,h2{letter-spacing:-.01em} +dt,th.tableblock,td.content{text-rendering:optimizeLegibility} +p,td.content{letter-spacing:-.01em} +p strong,td.content strong{letter-spacing:-.005em} +p,blockquote,dt,td.content{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} +.print-only{display:none!important} +@media print{@page{margin:1.25cm .75cm} +*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} +a{color:inherit!important;text-decoration:underline!important} +a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} +a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} +abbr[title]:after{content:" (" attr(title) ")"} +pre,blockquote,tr,img{page-break-inside:avoid} +thead{display:table-header-group} +img{max-width:100%!important} +p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} +h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} +#toc,.sidebarblock,.exampleblock>.content{background:none!important} +#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} +.sect1{padding-bottom:0!important} +.sect1+.sect1{border:0!important} +#header>h1:first-child{margin-top:1.25rem} +body.book #header{text-align:center} +body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} +body.book #header .details{border:0!important;display:block;padding:0!important} +body.book #header .details span:first-child{margin-left:0!important} +body.book #header .details br{display:block} +body.book #header .details br+span:before{content:none!important} +body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} +body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} +.listingblock code[data-lang]:before{display:block} +#footer{background:none!important;padding:0 .9375em} +#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} +.hide-on-print{display:none!important} +.print-only{display:block!important} +.hide-for-print{display:none!important} +.show-for-print{display:inherit!important}} +</style> +<style> +/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */ +/*pre.CodeRay {background-color:#f7f7f8;}*/ +.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em} +.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)} +.CodeRay .line-numbers strong{font-weight: normal} +table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none} +table.CodeRay td{vertical-align: top} +table.CodeRay td.line-numbers{text-align:right} +table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)} +table.CodeRay td.code{padding:0 0 0 .5em} +table.CodeRay td.code>pre{padding:0} +.CodeRay .debug{color:#fff !important;background:#000080 !important} +.CodeRay .annotation{color:#007} +.CodeRay .attribute-name{color:#000080} +.CodeRay .attribute-value{color:#700} +.CodeRay .binary{color:#509} +.CodeRay .comment{color:#998;font-style:italic} +.CodeRay .char{color:#04d} +.CodeRay .char .content{color:#04d} +.CodeRay .char .delimiter{color:#039} +.CodeRay .class{color:#458;font-weight:bold} +.CodeRay .complex{color:#a08} +.CodeRay .constant,.CodeRay .predefined-constant{color:#008080} +.CodeRay .color{color:#099} +.CodeRay .class-variable{color:#369} +.CodeRay .decorator{color:#b0b} +.CodeRay .definition{color:#099} +.CodeRay .delimiter{color:#000} +.CodeRay .doc{color:#970} +.CodeRay .doctype{color:#34b} +.CodeRay .doc-string{color:#d42} +.CodeRay .escape{color:#666} +.CodeRay .entity{color:#800} +.CodeRay .error{color:#808} +.CodeRay .exception{color:inherit} +.CodeRay .filename{color:#099} +.CodeRay .function{color:#900;font-weight:bold} +.CodeRay .global-variable{color:#008080} +.CodeRay .hex{color:#058} +.CodeRay .integer,.CodeRay .float{color:#099} +.CodeRay .include{color:#555} +.CodeRay .inline{color:#00} +.CodeRay .inline .inline{background:#ccc} +.CodeRay .inline .inline .inline{background:#bbb} +.CodeRay .inline .inline-delimiter{color:#d14} +.CodeRay .inline-delimiter{color:#d14} +.CodeRay .important{color:#555;font-weight:bold} +.CodeRay .interpreted{color:#b2b} +.CodeRay .instance-variable{color:#008080} +.CodeRay .label{color:#970} +.CodeRay .local-variable{color:#963} +.CodeRay .octal{color:#40e} +.CodeRay .predefined{color:#369} +.CodeRay .preprocessor{color:#579} +.CodeRay .pseudo-class{color:#555} +.CodeRay .directive{font-weight:bold} +.CodeRay .type{font-weight:bold} +.CodeRay .predefined-type{color:inherit} +.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold} +.CodeRay .key{color:#808} +.CodeRay .key .delimiter{color:#606} +.CodeRay .key .char{color:#80f} +.CodeRay .value{color:#088} +.CodeRay .regexp .delimiter{color:#808} +.CodeRay .regexp .content{color:#808} +.CodeRay .regexp .modifier{color:#808} +.CodeRay .regexp .char{color:#d14} +.CodeRay .regexp .function{color:#404;font-weight:bold} +.CodeRay .string{color:#d20} +.CodeRay .string .string .string{background:#ffd0d0} +.CodeRay .string .content{color:#d14} +.CodeRay .string .char{color:#d14} +.CodeRay .string .delimiter{color:#d14} +.CodeRay .shell{color:#d14} +.CodeRay .shell .delimiter{color:#d14} +.CodeRay .symbol{color:#990073} +.CodeRay .symbol .content{color:#a60} +.CodeRay .symbol .delimiter{color:#630} +.CodeRay .tag{color:#008080} +.CodeRay .tag-special{color:#d70} +.CodeRay .variable{color:#036} +.CodeRay .insert{background:#afa} +.CodeRay .delete{background:#faa} +.CodeRay .change{color:#aaf;background:#007} +.CodeRay .head{color:#f8f;background:#505} +.CodeRay .insert .insert{color:#080} +.CodeRay .delete .delete{color:#800} +.CodeRay .change .change{color:#66f} +.CodeRay .head .head{color:#f4f} +</style> +</head> +<body class="article"> +<div id="header"> +<div id="toc" class="toc"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel2"> +<li><a href="#_configuration">Configuration</a></li> +</ul> +</div> +</div> +<div id="content"> +<div class="sect2"> +<h3 id="_configuration">Configuration</h3> +<div class="sect3"> +<h4 id="_files">Files</h4> +<div class="paragraph"> +<p>Apache Karaf stores and loads all configuration in files located in the <code>etc</code> folder.</p> +</div> +<div class="paragraph"> +<p>By default, the <code>etc</code> folder is located relatively to the <code>KARAF_BASE</code> folder. You can define another location +using the <code>KARAF_ETC</code> variable.</p> +</div> +<div class="paragraph"> +<p>Each configuration is identified by a ID (the ConfigAdmin PID). The configuration files name follows the <code>pid.cfg</code> +name convention.</p> +</div> +<div class="paragraph"> +<p>For instance, <code>etc/org.apache.karaf.shell.cfg</code> means that this file is the file used by the configuration with +<code>org.apache.karaf.shell</code> as PID.</p> +</div> +<div class="paragraph"> +<p>A configuration file is a properties file containing key/value pairs:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>property=value</pre> +</div> +</div> +<div class="paragraph"> +<p>Properties can be referenced inside configuration files using the syntax <code>${<name>}</code>. Default and alternate +values can be specified using <code>${<name>:-<default_value>}</code> and <code>${<name>:+<alternate_value>}</code> syntaxes respectively.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>existing_property=baz +property1=${missing_property:-foo} # "foo" +property2=${missing_property:+foo} # empty string +property3=${existing_property:-bar} # "baz" +property4=${existing_property:+bar} # "bar"</pre> +</div> +</div> +<div class="paragraph"> +<p>Environment variables can be referenced inside configuration files using the syntax <code>${env:<name>}</code> (e.g. +<code>property=${env:FOO}</code> will set "property" to the value of the enviroment variable "FOO"). Default and alternate +values can be defined for them as well using the same syntax as above.</p> +</div> +<div class="paragraph"> +<p>In Apache Karaf, a configuration is PID with a set of properties attached.</p> +</div> +<div class="paragraph"> +<p>Apache Karaf automatically loads all <code>*.cfg</code> files from the <code>etc</code> folder.</p> +</div> +<div class="paragraph"> +<p>You can configure the behaviour of the configuration files using some dedicated properties in the +<code>etc/config.properties</code> configuration file:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>... +# +# Configuration FileMonitor properties +# +felix.fileinstall.enableConfigSave = true +felix.fileinstall.dir = ${karaf.etc} +felix.fileinstall.filter = .*\\.(cfg|config) +felix.fileinstall.poll = 1000 +felix.fileinstall.noInitialDelay = true +felix.fileinstall.log.level = 3 +felix.fileinstall.log.default = jul +...</pre> +</div> +</div> +<div class="ulist"> +<ul> +<li> +<p><code>felix.fileinstall.enableConfigSave</code> flush back in the configuration file the changes performed directly on the +configuration service (ConfigAdmin). If <code>true</code>, any change (using <code>config:*</code> commands, MBeans, OSGi service) is +persisted back in the configuration false. Default is <code>true</code>.</p> +</li> +<li> +<p><code>felix.fileinstall.dir</code> is the directory where Apache Karaf is looking for configuration files. Default is <code>${karaf.etc}</code> +meaning the value of the <code>KARAF_ETC</code> variable.</p> +</li> +<li> +<p><code>felix.fileinstall.filter</code> is the file name pattern used to load only some configuration files. Only files matching +the pattern will be loaded. Default value is <code>.*\\.(cfg|config)</code> meaning *.cfg and *.config files.</p> +</li> +<li> +<p><code>felix.fileinstall.poll</code> is the polling interval (in milliseconds). Default value is <code>1000</code> meaning that Apache +Karaf "re-loads" the configuration files every second.</p> +</li> +<li> +<p><code>felix.fileinstall.noInitialDelay</code> is a flag indicating if the configuration file polling starts as soon as Apache +Karaf starts or wait for a certain time. If <code>true</code>, Apache Karaf polls the configuration files as soon as the configuration +service starts.</p> +</li> +<li> +<p><code>felix.fileinstall.log.level</code> is the log message verbosity level of the configuration polling service. More +this value is high, more verbose the configuration service is.</p> +</li> +<li> +<p><code>felix.fileinstall.log.default</code> is the logging framework to use, <code>jul</code> meaning Java Util Logging.</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>You can change the configuration at runtime by directly editing the configuration file.</p> +</div> +<div class="paragraph"> +<p>You can also do the same using the <code>config:*</code> commands or the ConfigMBean.</p> +</div> +<div class="paragraph"> +<p>Apache Karaf persists configuration using own persistence manager in case of when available persistence managers do not support that. +Configuration files are placed by default in <code>KARAF_ETC</code>, but it could be overridden via variable <code>storage</code> in <code>etc/org.apache.karaf.config.cfg</code>. +If you want to disable karaf persistence manager, set storage variable to empty string (<code>storage=</code>).</p> +</div> +</div> +<div class="sect3"> +<h4 id="__code_config_code_commands"><code>config:*</code> commands</h4> +<div class="paragraph"> +<p>Apache Karaf provides a set of commands to manage the configuration.</p> +</div> +<div class="sect4"> +<h5 id="__code_config_list_code"><code>config:list</code></h5> +<div class="paragraph"> +<p><code>config:list</code> displays the list of all configurations available, or the properties in a given configuration (PID).</p> +</div> +<div class="paragraph"> +<p>Without the <code>query</code> argument, the <code>config:list</code> command display all configurations, with PID, attached bundle and +properties defined in the configuration:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:list +---------------------------------------------------------------- +Pid: org.apache.karaf.service.acl.command.system.start-level +BundleLocation: mvn:org.apache.karaf.shell/org.apache.karaf.shell.console/4.0.0 +Properties: + service.guard = (&(osgi.command.scope=system)(osgi.command.function=start-level)) + * = * + start-level = admin # admin can set any start level, including < 100 + start-level[/[^0-9]*/] = viewer # viewer can obtain the current start level + execute[/.*/,/[^0-9]*/] = viewer # viewer can obtain the current start level + execute = admin # admin can set any start level, including < 100 + service.pid = org.apache.karaf.service.acl.command.system.start-level + start-level[/.*[0-9][0-9][0-9]+.*/] = manager # manager can set startlevels above 100 + execute[/.*/,/.*[0-9][0-9][0-9]+.*/] = manager # manager can set startlevels above 100 +---------------------------------------------------------------- +Pid: org.apache.karaf.log +BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 +Properties: + service.pid = org.apache.karaf.log + size = 500 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg +...</pre> +</div> +</div> +<div class="paragraph"> +<p>The <code>query</code> argument accepts a query using a LDAP syntax.</p> +</div> +<div class="paragraph"> +<p>For instance, you can display details on one specific configuration using the following filter:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:list "(service.pid=org.apache.karaf.log)" +---------------------------------------------------------------- +Pid: org.apache.karaf.log +BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 +Properties: + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + service.pid = org.apache.karaf.log + size = 500</pre> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_edit_code"><code>config:edit</code></h5> +<div class="paragraph"> +<p><code>config:edit</code> is the first command to do when you want to change a configuration. <code>config:edit</code> command put you +in edition mode for a given configuration.</p> +</div> +<div class="paragraph"> +<p>For instance, you can edit the <code>org.apache.karaf.log</code> configuration:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:edit org.apache.karaf.log</pre> +</div> +</div> +<div class="paragraph"> +<p>The <code>config:edit</code> command doesn’t display anything, it just puts you in configuration edit mode. You are now ready +to use other config commands (like <code>config:property-append</code>, <code>config:property-delete</code>, <code>config:property-set</code>, …​).</p> +</div> +<div class="paragraph"> +<p>If you provide a configuration PID that doesn’t exist yet, Apache Karaf will create a new configuration (and so a new +configuration file) automatically.</p> +</div> +<div class="paragraph"> +<p>All changes that you do in configuration edit mode are store in your console session: the changes are not directly +applied in the configuration. It allows you to "commit" the changes (see <code>config:update</code> command) or "rollback" and +cancel your changes (see <code>config:cancel</code> command).</p> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_property_list_code"><code>config:property-list</code></h5> +<div class="paragraph"> +<p>The <code>config:property-list</code> lists the properties for the currently edited configuration.</p> +</div> +<div class="paragraph"> +<p>Assuming that you edited the <code>org.apache.karaf.log</code> configuration, you can do:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:property-list + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + service.pid = org.apache.karaf.log + size = 500</pre> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_property_set_code"><code>config:property-set</code></h5> +<div class="paragraph"> +<p>The <code>config:property-set</code> command update the value of a given property in the currently edited configuration.</p> +</div> +<div class="paragraph"> +<p>For instance, to change the value of the <code>size</code> property of previously edited <code>org.apache.karaf.log</code> configuration, +you can do:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:property-set size 1000 +karaf@root()> config:property-list + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + service.pid = org.apache.karaf.log + size = 1000</pre> +</div> +</div> +<div class="paragraph"> +<p>If the property doesn’t exist, the <code>config:property-set</code> command creates the property.</p> +</div> +<div class="paragraph"> +<p>You can use <code>config:property-set</code> command outside the configuration edit mode, by specifying the <code>-p</code> (for configuration pid) option:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:property-set -p org.apache.karaf.log size 1000 +karaf@root()> config:list "(service.pid=org.apache.karaf.log)" +---------------------------------------------------------------- +Pid: org.apache.karaf.log +BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 +Properties: + service.pid = org.apache.karaf.log + size = 1000 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg</pre> +</div> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<div class="title">Note</div> +</td> +<td class="content"> +<div class="paragraph"> +<p>Using the <code>pid</code> option, you bypass the configuration commit and rollback mechanism.</p> +</div> +</td> +</tr> +</table> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_property_append_code"><code>config:property-append</code></h5> +<div class="paragraph"> +<p>The <code>config:property-append</code> is similar to <code>config:property-set</code> command, but instead of completely replacing the +property value, it appends a string at the end of the property value.</p> +</div> +<div class="paragraph"> +<p>For instance, to add 1 at the end of the value of the <code>size</code> property in <code>org.apache.karaf.log</code> configuration +(and so have 5001 for the value instead of 500), you can do:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:property-append size 1 +karaf@root()> config:property-list + service.pid = org.apache.karaf.log + size = 5001 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg</pre> +</div> +</div> +<div class="paragraph"> +<p>Like the <code>config:property-set</code> command, if the property doesn’t exist, the <code>config:property-set</code> command creates +the property.</p> +</div> +<div class="paragraph"> +<p>You can use the <code>config:property-append</code> command outside the configuration edit mode, by specifying the <code>-p</code> (for configuration pid) option:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:property-append -p org.apache.karaf.log size 1 +karaf@root()> config:list "(service.pid=org.apache.karaf.log)" +---------------------------------------------------------------- +Pid: org.apache.karaf.log +BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 +Properties: + service.pid = org.apache.karaf.log + size = 5001 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg</pre> +</div> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<div class="title">Note</div> +</td> +<td class="content"> +<div class="paragraph"> +<p>Using the <code>pid</code> option, you bypass the configuration commit and rollback mechanism.</p> +</div> +</td> +</tr> +</table> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_property_delete_code"><code>config:property-delete</code></h5> +<div class="paragraph"> +<p>The <code>config:property-delete</code> command delete a property in the currently edited configuration.</p> +</div> +<div class="paragraph"> +<p>For instance, you previously added a <code>test</code> property in <code>org.apache.karaf.log</code> configuration. To delete this <code>test</code> +property, you do:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:property-set test test +karaf@root()> config:property-list + service.pid = org.apache.karaf.log + size = 500 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg + test = test +karaf@root()> config:property-delete test +karaf@root()> config:property-list + service.pid = org.apache.karaf.log + size = 500 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg</pre> +</div> +</div> +<div class="paragraph"> +<p>You can use the <code>config:property-delete</code> command outside the configuration edit mode, by specifying the <code>-p</code> (for configuration pid) option:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:property-delete -p org.apache.karaf.log test</pre> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_update_code_and_code_config_cancel_code"><code>config:update</code> and <code>config:cancel</code></h5> +<div class="paragraph"> +<p>When you are in the configuration edit mode, all changes that you do using <code>config:property*</code> commands are stored in "memory" +(actually in the console session).</p> +</div> +<div class="paragraph"> +<p>Thanks to that, you can "commit" your changes using the <code>config:update</code> command. The <code>config:update</code> command will +commit your changes, update the configuration, and (if possible) update the configuration files.</p> +</div> +<div class="paragraph"> +<p>For instance, after changing <code>org.apache.karaf.log</code> configuration with some <code>config:property*</code> commands, you have +to commit your change like this:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:edit org.apache.karaf.log +karaf@root()> config:property-set test test +karaf@root()> config:update +karaf@root()> config:list "(service.pid=org.apache.karaf.log)" +---------------------------------------------------------------- +Pid: org.apache.karaf.log +BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 +Properties: + service.pid = org.apache.karaf.log + size = 500 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg + test = test</pre> +</div> +</div> +<div class="paragraph"> +<p>On the other hand, if you want to "rollback" your changes, you can use the <code>config:cancel</code> command. It will cancel all +changes that you did, and return of the configuration state just before the <code>config:edit</code> command. The <code>config:cancel</code> +exits from the edit mode.</p> +</div> +<div class="paragraph"> +<p>For instance, you added the test property in the <code>org.apache.karaf.log</code> configuration, but it was a mistake:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:edit org.apache.karaf.log +karaf@root()> config:property-set test test +karaf@root()> config:cancel +karaf@root()> config:list "(service.pid=org.apache.karaf.log)" +---------------------------------------------------------------- +Pid: org.apache.karaf.log +BundleLocation: mvn:org.apache.karaf.log/org.apache.karaf.log.core/4.0.0 +Properties: + service.pid = org.apache.karaf.log + size = 500 + pattern = %d{ISO8601} | %-5.5p | %-16.16t | %-32.32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n + felix.fileinstall.filename = file:/opt/apache-karaf-4.0.0/etc/org.apache.karaf.log.cfg</pre> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_delete_code"><code>config:delete</code></h5> +<div class="paragraph"> +<p>The <code>config:delete</code> command completely delete an existing configuration. You don’t have to be in edit mode to delete +a configuration.</p> +</div> +<div class="paragraph"> +<p>For instance, you added <code>my.config</code> configuration:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:edit my.config +karaf@root()> config:property-set test test +karaf@root()> config:update +karaf@root()> config:list "(service.pid=my.config)" +---------------------------------------------------------------- +Pid: my.config +BundleLocation: null +Properties: + service.pid = my.config + test = test</pre> +</div> +</div> +<div class="paragraph"> +<p>You can delete the <code>my.config</code> configuration (including all properties in the configuration) using the <code>config:delete</code> +command:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:delete my.config +karaf@root()> config:list "(service.pid=my.config)" +karaf@root()></pre> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="__code_config_meta_code"><code>config:meta</code></h5> +<div class="paragraph"> +<p>The <code>config:meta</code> command lists the meta type information related to a given configuration.</p> +</div> +<div class="paragraph"> +<p>It allows you to get details about the configuration properties: key, name, type, default value, and description:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>karaf@root()> config:meta -p org.apache.karaf.log +Meta type informations for pid: org.apache.karaf.log +key | name | type | default | description +--------------------------------------------------------------------------------------------------------------------------------------- +size | Size | int | 500 | size of the log to keep in memory +pattern | Pattern | String | %d{ABSOLUTE} | %-5.5p | %-16.16t | %-32.32c{1} | %-32.32C %4L | %m%n | Pattern used to display log entries</pre> +</div> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_jmx_configmbean">JMX ConfigMBean</h4> +<div class="paragraph"> +<p>On the JMX layer, you have a MBean dedicated to the management of the configurations: the ConfigMBean.</p> +</div> +<div class="paragraph"> +<p>The ConfigMBean object name is: <code>org.apache.karaf:type=config,name=*</code>.</p> +</div> +<div class="sect4"> +<h5 id="_attributes">Attributes</h5> +<div class="paragraph"> +<p>The <code>Configs</code> attribute is a list of all configuration PIDs.</p> +</div> +</div> +<div class="sect4"> +<h5 id="_operations">Operations</h5> +<div class="ulist"> +<ul> +<li> +<p><code>listProperties(pid)</code> returns the list of properties (property=value formatted) for the configuration <code>pid</code>.</p> +</li> +<li> +<p><code>deleteProperty(pid, property)</code> deletes the <code>property</code> from the configuration <code>pid</code>.</p> +</li> +<li> +<p><code>appendProperty(pid, property, value)</code> appends <code>value</code> at the end of the value of the <code>property</code> of the configuration <code>pid</code>.</p> +</li> +<li> +<p><code>setProperty(pid, property, value)</code> sets <code>value</code> for the value of the <code>property</code> of the configuration <code>pid</code>.</p> +</li> +<li> +<p><code>delete(pid)</code> deletes the configuration identified by the <code>pid</code>.</p> +</li> +<li> +<p><code>create(pid)</code> creates an empty (without any property) configuration with <code>pid</code>.</p> +</li> +<li> +<p><code>update(pid, properties)</code> updates a configuration identified with <code>pid</code> with the provided <code>properties</code> map.</p> +</li> +</ul> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer-text"> +Last updated 2017-11-15 16:55:26 +01:00 +</div> +</div> +</body> +</html> \ No newline at end of file Modified: karaf/site/production/manual/latest/connect.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/connect.html?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/connect.html (original) +++ karaf/site/production/manual/latest/connect.html Wed Nov 22 14:52:25 2017 @@ -609,7 +609,7 @@ public class Main { </div> <div id="footer"> <div id="footer-text"> -Last updated 2016-04-27 13:59:28 CEST +Last updated 2017-07-26 16:36:29 +02:00 </div> </div> </body> Modified: karaf/site/production/manual/latest/console.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/console.html?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/console.html (original) +++ karaf/site/production/manual/latest/console.html Wed Nov 22 14:52:25 2017 @@ -1190,7 +1190,7 @@ some commands, or limit the values allow </div> <div id="footer"> <div id="footer-text"> -Last updated 2016-04-27 13:59:28 CEST +Last updated 2017-07-26 16:36:29 +02:00 </div> </div> </body> Modified: karaf/site/production/manual/latest/creating-bundles.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/creating-bundles.html?rev=1816059&r1=1816058&r2=1816059&view=diff ============================================================================== --- karaf/site/production/manual/latest/creating-bundles.html (original) +++ karaf/site/production/manual/latest/creating-bundles.html Wed Nov 22 14:52:25 2017 @@ -775,7 +775,7 @@ This bundle is simply a Maven POM that s </div> <div id="footer"> <div id="footer-text"> -Last updated 2016-04-27 13:59:28 CEST +Last updated 2017-07-26 16:36:29 +02:00 </div> </div> </body>
