configurationengine/doc/cli/info.rst
author terytkon
Thu, 11 Mar 2010 17:04:37 +0200
changeset 0 2e8eeb919028
permissions -rw-r--r--
Adding EPL version of configurationengine.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
ConE info action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
================
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
Running action info
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
Usage: cone info [options]
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
The info functionality is meant for printing information about the contents of a CPF/ZIP file or Configuration Project (folder).
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
Examples
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
--------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
**Get a list of root configurations inside the project**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
    >cone info 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
or use the option -p|--project to point to the configuration project root::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
    >cone info --project=configproject_root 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
**Get a list of root configurations inside a carbon storage (Available in ConE 1.2)**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
    >cone info --project=http://carbonqa.nokia.com/extapi
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
Options list
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
  --version             show program's version number and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
  -h, --help            show this help message and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
  --print-settings      Print all the default settings from the current
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
                        setting container.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
  --print-supported-impls
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
                        Print all supported ImplML XML namespaces and file
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
                        extension.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
  -v LEVEL, --verbose=LEVEL
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
                        Print error, warning and information on system out.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
                        Possible choices: Default is 3.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
                        NONE (all)    0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
                        CRITICAL      1
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
                        ERROR         2
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
                        WARNING       3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
                        INFO          4
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
                        DEBUG         5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
  --log-file=FILE       Location of the used log file. Default is 'cone.log'
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
  -c CONFIG, --configuration=CONFIG
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
                        defines the name of the configuration for the action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
  -p STORAGE, --project=STORAGE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
                        defines the location of current project. Default is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
                        the current working directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
  --dump-api=FILE       Write the confml feature api string representation to
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
                        a file.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
  Info options:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
    The info functionality is meant for printing information about the
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
    contents of a cpf/zip file or Configuration Project (folder).
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
    --template=FILE     Template used in a report generation.Example -t
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
                        report_template.html.