You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by cs...@apache.org on 2014/01/19 09:33:00 UTC
[1/2] git commit: Small changes in doc
Updated Branches:
refs/heads/master 7a0d6f962 -> d5431e846
Small changes in doc
Project: http://git-wip-us.apache.org/repos/asf/karaf/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/62c65250
Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/62c65250
Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/62c65250
Branch: refs/heads/master
Commit: 62c65250ad5c62b797aea2d66c3d9175d33c03f2
Parents: e473d9a
Author: Christian Schneider <ch...@die-schneider.net>
Authored: Sun Jan 19 09:31:31 2014 +0100
Committer: Christian Schneider <ch...@die-schneider.net>
Committed: Sun Jan 19 09:31:31 2014 +0100
----------------------------------------------------------------------
manual/src/main/webapp/users-guide/console.conf | 119 +++----------------
1 file changed, 16 insertions(+), 103 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/karaf/blob/62c65250/manual/src/main/webapp/users-guide/console.conf
----------------------------------------------------------------------
diff --git a/manual/src/main/webapp/users-guide/console.conf b/manual/src/main/webapp/users-guide/console.conf
index 7dc0c25..bf09f7c 100644
--- a/manual/src/main/webapp/users-guide/console.conf
+++ b/manual/src/main/webapp/users-guide/console.conf
@@ -153,58 +153,20 @@ h3. Help or man
We already saw the usage of the {{help}} command to display all commands available.
-But you can also use the {{help}} command to get details about a command:
+But you can also use the {{help}} command to get details about a command or
+the {{man}} command which is an alias to the {{help}} command.
+You can also use another form to get the command help, by using the {{--help}} option to the command.
-{code}
-karaf@root()> help feature:list
-DESCRIPTION
- feature:list
-
- Lists all existing features available from the defined repositories.
-
-SYNTAX
- feature:list [options]
-
-OPTIONS
- --help
- Display this help message
- -o, --ordered
- Display a list using alphabetical order
- -i, --installed
- Display a list of all installed features only
- --no-format
- Disable table rendered output
-
-{code}
-
-It's very similar to the {{man}} command on Unix. You can also use the {{man}} command (which is an lias to the {{help}} command):
+So these commands
{code}
+karaf@root()> help feature:list
karaf@root()> man feature:list
-DESCRIPTION
- feature:list
-
- Lists all existing features available from the defined repositories.
-
-SYNTAX
- feature:list [options]
-
-OPTIONS
- --help
- Display this help message
- -o, --ordered
- Display a list using alphabetical order
- -i, --installed
- Display a list of all installed features only
- --no-format
- Disable table rendered output
-
+karaf@root()> feature:list --help
{code}
-You can also use another form to get the command help, by using the {{--help}} option to the command:
-
+All produce the same help output:
{code}
-karaf@root()> feature:list --help
DESCRIPTION
feature:list
@@ -229,11 +191,11 @@ h3. Completion
When you type the tab key, Karaf tries to complete:
-* the subshell
-* the commands
-* the aliases
-* the command arguments
-* the command option
+* subshell
+* commands
+* aliases
+* command arguments
+* command options
h3. Alias
@@ -260,28 +222,6 @@ At login, the Apache Karaf console reads the {{etc/shell.init.script}} file wher
It's similar to a bashrc or profile file on Unix.
{code}
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-// This script is run each time a shell is created.
-// You can define here closures or variables that will be available
-// in each session.
-//
ld = { log:display $args } ;
lde = { log:exception-display $args } ;
la = { bundle:list -t 0 $args } ;
@@ -321,14 +261,8 @@ h3. Pipe
You can pipe the output of one command as input to another one. It's a pipe, using the | character:
{code}
-karaf@root()> feature:list|grep -i karaf
-standard | 3.0.0 | x | standard-3.0.0 | Karaf standard feature
+karaf@root()> feature:list | grep -i war
war | 3.0.0 | | standard-3.0.0 | Turn Karaf as a full WebContainer
-kar | 3.0.0 | x | standard-3.0.0 | Provide KAR (KARaf archive) support
-webconsole | 3.0.0 | | standard-3.0.0 | Base support of the Karaf WebConsole
-ssh | 3.0.0 | x | standard-3.0.0 | Provide a SSHd server on Karaf
-scheduler | 3.0.0 | | standard-3.0.0 | Provide a scheduler service in Karaf to fire event
-jasypt-encryption | 3.0.0 | | standard-3.0.0 | Advanced encryption support for Karaf security
{code}
h3. Grep, more, find, ...
@@ -362,29 +296,8 @@ Karaf console provides some core commands similar to Unix environment:
* {{shell:grep}} prints lines matching the given pattern
* {{shell:sort}} writes sorted concatenation of all files to stdout
-You don't have to use the full qualified name of the command, you can directly use the command name:
-
-{code}
-karaf@root(shell)> head --help
-DESCRIPTION
- shell:head
-
- Displays the first lines of a file.
-
-SYNTAX
- shell:head [options] [paths or urls]
-
-ARGUMENTS
- paths or urls
- A list of file paths or urls to display separated by whitespaces.
-
-OPTIONS
- -n
- The number of lines to display, starting at 1.
- --help
- Display this help message
-
-{code}
+You don't have to use the fully qualified name of the command, you can directly use the command name as long as it is unique.
+So you can use 'head' instead of 'shell:head'
Again, you can find details and all options of these commands using {{help}} command or {{--help}} option.
@@ -496,4 +409,4 @@ The Apache Karaf console supports a Role Based Access Control (RBAC) security me
the user connected to the console, you can define, depending of the user's groups and roles, the permission to execute
some commands, or limit the values allowed for the arguments.
-Console security is detailed in the [Security section|security] of this user guide.
\ No newline at end of file
+Console security is detailed in the [Security section|security] of this user guide.
[2/2] git commit: Merge branch 'master' of
https://git-wip-us.apache.org/repos/asf/karaf
Posted by cs...@apache.org.
Merge branch 'master' of https://git-wip-us.apache.org/repos/asf/karaf
Project: http://git-wip-us.apache.org/repos/asf/karaf/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/d5431e84
Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/d5431e84
Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/d5431e84
Branch: refs/heads/master
Commit: d5431e846ea73a3d381073335e5fc2cf1699cd16
Parents: 62c6525 7a0d6f9
Author: Christian Schneider <ch...@die-schneider.net>
Authored: Sun Jan 19 09:32:24 2014 +0100
Committer: Christian Schneider <ch...@die-schneider.net>
Committed: Sun Jan 19 09:32:24 2014 +0100
----------------------------------------------------------------------
.../enterprise/src/main/feature/feature.xml | 22 ++--
.../itests/FeatureSshCommandSecurityTest.java | 58 ++++++++++
.../itests/JaasSshCommandSecurityTest.java | 48 ++++++++
.../apache/karaf/itests/SshCommandTestBase.java | 12 ++
.../completers/DataSourcesCompleter.java | 53 ---------
.../DataSourcesFileNameCompleter.java | 53 +++++++++
.../completers/DataSourcesNameCompleter.java | 53 +++++++++
.../OSGI-INF/blueprint/jdbc-command.xml | 15 ++-
.../java/org/apache/karaf/jdbc/JdbcService.java | 7 ++
.../karaf/jdbc/internal/JdbcMBeanImpl.java | 2 +-
.../karaf/jdbc/internal/JdbcServiceImpl.java | 16 +++
.../karaf/jdbc/internal/datasource-derby.xml | 4 +-
.../karaf/jdbc/internal/datasource-generic.xml | 110 ++++++++++++++++++-
.../ConnectionFactoriesCompleter.java | 53 ---------
.../ConnectionFactoriesFileNameCompleter.java | 53 +++++++++
.../ConnectionFactoriesNameCompleter.java | 53 +++++++++
.../OSGI-INF/blueprint/jms-command.xml | 23 ++--
.../java/org/apache/karaf/jms/JmsService.java | 8 ++
.../karaf/jms/internal/JmsServiceImpl.java | 16 +++
.../karaf/jndi/internal/JndiServiceImpl.java | 2 +-
manual/src/main/webapp/users-guide/jdbc.conf | 2 +-
21 files changed, 524 insertions(+), 139 deletions(-)
----------------------------------------------------------------------