diff --git a/docs/source/guides/admin-guides/references/man1/lskit.1.rst b/docs/source/guides/admin-guides/references/man1/lskit.1.rst index e0e74377e..c845cadb3 100644 --- a/docs/source/guides/admin-guides/references/man1/lskit.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lskit.1.rst @@ -46,44 +46,44 @@ OPTIONS -\ **-F|-**\ **-framework**\ \ *kit_path_name*\ - +\ **-F|-**\ **-framework**\ \ *kit_path_name*\ + Use this option to display the framework values of the specified Kit tarfile. This information is retreived directly from the tarfile and can be done before the Kit has been defined in the xCAT database. This option cannot be combined with other options. - -\ **-K|-**\ **-kitattr**\ \ *kitattr_names*\ - + +\ **-K|-**\ **-kitattr**\ \ *kitattr_names*\ + Where \ *kitattr_names*\ is a comma-delimited list of kit attribute names. The names correspond to attribute names in the \ **kit**\ table. The \ **lskit**\ command will only display the specified kit attributes. - -\ **-R|-**\ **-repoattr**\ \ *repoattr_names*\ - + +\ **-R|-**\ **-repoattr**\ \ *repoattr_names*\ + Where \ *repoattr_names*\ is a comma-delimited list of kit repository attribute names. The names correspond to attribute names in the \ **kitrepo**\ table. The \ **lskit**\ command will only display the specified kit repository attributes. - -\ **-C|-**\ **-compattr**\ \ *compattr_names*\ - + +\ **-C|-**\ **-compattr**\ \ *compattr_names*\ + where \ *compattr_names*\ is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the \ **kitcomponent**\ table. The \ **lskit**\ command will only display the specified kit component attributes. - -\ *kit_names*\ - + +\ *kit_names*\ + is a comma-delimited list of kit names. The \ **lskit**\ command will only display the kits matching these names. - -\ **-x|-**\ **-xml|-**\ **-XML**\ - + +\ **-x|-**\ **-xml|-**\ **-XML**\ + Need XCATXMLTRACE=1 env when using -x|--xml|--XML, for example: XCATXMLTRACE=1 lskit -x testkit-1.0.0 Return the output with XML tags. The data is returned as: - - + + .. code-block:: perl - + ... @@ -95,58 +95,58 @@ OPTIONS ... - - + + Each tag contains info for one kit. The info inside is structured as follows: - - + + .. code-block:: perl - + The sub-tag contains the kit's basic info. The sub-tags store info about the kit's repositories. The sub-tags store info about the kit's components. - - + + The data inside is returned as: - - + + .. code-block:: perl - + ... - + ... ... - + ... ... - - -\ **-V|-**\ **-verbose**\ - + + +\ **-V|-**\ **-verbose**\ + Display additional progress and error messages. - -\ **-v|-**\ **-version**\ - + +\ **-v|-**\ **-version**\ + Command Version. - -\ **-?|-h|-**\ **-help**\ - + +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -172,64 +172,64 @@ EXAMPLES 1. To list all kits, enter: - - + + .. code-block:: perl - + lskit - - + + 2. To list the kit "kit-test1-1.0-Linux", enter: - - + + .. code-block:: perl - + lskit kit-test1-1.0-Linux - - + + 3. To list the kit "kit-test1-1.0-Linux" for selected attributes, enter: - - + + .. code-block:: perl - + lskit -K basename,description -R kitreponame -C kitcompname kit-test1-1.0-Linux - - + + 4. To list the framework value of a Kit tarfile. - - + + .. code-block:: perl - + lskit -F /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2 - - + + Output is similar to: - - + + .. code-block:: perl - + Extracting the kit.conf file from /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2. Please wait. - + kitframework=2 compatible_kitframeworks=0,1,2 - - + + 5. To list kit "testkit-1.0-1" with XML tags, enter: - - + + .. code-block:: perl - + XCATXMLTRACE=1 lskit -x testkit-1.0-1 - - + +