diff --git a/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst b/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst index 895a065e1..615db005a 100644 --- a/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst @@ -44,38 +44,38 @@ OPTIONS -\ **-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 \ **lskitcomp**\ command will only display the specified kit component attributes. - -\ **-O|-**\ **-osdistro**\ \ *os_distro*\ - + +\ **-O|-**\ **-osdistro**\ \ *os_distro*\ + where \ *os_distro*\ is the name of an osdistro in \ **osdistro**\ table. The \ **lskitcomp**\ command will only display the kit components matching the specified osdistro. - -\ **-S|-**\ **-serverrole**\ \ *server_role*\ - + +\ **-S|-**\ **-serverrole**\ \ *server_role*\ + where \ *server_role*\ is the name of a server role. The typical server roles are: mgtnode, servicenode, computenode, loginnode, storagennode. The \ **lskitcomp**\ command will only display the kit components matching the specified server role. - -\ *kitcomp_names*\ - + +\ *kitcomp_names*\ + is a comma-delimited list of kit component names. The \ **lskitcomp**\ command will only display the kit components matching the specified names. - -\ **-x|-**\ **-xml|-**\ **-XML**\ - + +\ **-x|-**\ **-xml|-**\ **-XML**\ + Need XCATXMLTRACE=1 env when using -x|--xml|--XML. Return the output with XML tags. The data is returned as: - - + + .. code-block:: perl - + ... @@ -87,52 +87,52 @@ OPTIONS ... - - + + Each tag contains info for a group of kit components belonging to the same kit. The info inside is structured as follows: - - + + .. code-block:: perl - + The sub-tag contains the kit's name. 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. - + @@ -158,75 +158,75 @@ EXAMPLES 1. - + To list all kit components, enter: - - + + .. code-block:: perl - + lskitcomp - - + + 2. - + To list the kit component "comp-server-1.0-1-rhels-6-x86_64", enter: - - + + .. code-block:: perl - + lskitcomp comp-server-1.0-1-rhels-6-x86_64 - - + + 3. - + To list the kit component "comp-server-1.0-1-rhels-6-x86_64" for selected kit component attributes, enter: - - + + .. code-block:: perl - + lskitcomp -C kitcompname,desc comp-server-1.0-1-rhels-6-x86_64 - - + + 4. - + To list kit components compatible with "rhels-6.2-x86_64" osdistro, enter: - - + + .. code-block:: perl - + lskitcomp -O rhels-6.2-x86_64 - - + + 5. - + To list kit components compatible with "rhels-6.2-x86_64" osdistro and "computenode" server role, enter: - - + + .. code-block:: perl - + lskitcomp -O rhels-6.2-x86_64 -S computenode - - + + 6. - + To list the kit component "testkit-compute-1.0-1-ubuntu-14.04-ppc64el" with XML tags, enter: - - + + .. code-block:: perl - + XCATXMLTRACE=1 lskitcomp -x testkit-compute-1.0-1-ubuntu-14.04-ppc64el - - + +