diff --git a/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst b/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst index 800184021..f09ea69ae 100644 --- a/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **chkosimage [-h | -**\ **-help ]**\ +\ **chkosimage [-h | -**\ **-help ]**\ -\ **chkosimage [-V] [-c|-**\ **-clean]**\ \ *osimage_name*\ +\ **chkosimage [-V] [-c|-**\ **-clean]**\ \ *osimage_name*\ *********** @@ -31,12 +31,12 @@ DESCRIPTION This command is currently supported for AIX osimages only. -Use this command to verify if the NIM lpp_source directories contain the +Use this command to verify if the NIM lpp_source directories contain the correct software. The lpp_source directory must contain all the software -that is specified in the "installp_bundle" and "otherpkgs" +that is specified in the "installp_bundle" and "otherpkgs" attributes of the osimage definition. -The command gets the name of the lpp_source resource from the xCAT osimage +The command gets the name of the lpp_source resource from the xCAT osimage definition and the location of the lpp_source directory from the NIM resource definition. @@ -46,16 +46,16 @@ Note: Remember to use the prefixes, "I:", "R:", and "E:", respectively, when specifying package names in an installp_bundle file or an otherpkgs list. In addition to checking for missing software the chkosimage command will -also check to see if there are multiple matches. This could happen +also check to see if there are multiple matches. This could happen when you use wildcards in the software file names. For example, if you -have perl-xCAT\* in a bundle file it could match multiple versions of the xCAT +have perl-xCAT\* in a bundle file it could match multiple versions of the xCAT rpm package saved in your lpp_source directory. If this happens you must remove the unwanted versions of the rpms. If the extra rpms are not removed you will get install errors. -To help with this process you can use the "-c|--clean" option. This -option will keep the rpm package with the most recent timestamp and +To help with this process you can use the "-c|--clean" option. This +option will keep the rpm package with the most recent timestamp and remove the others. The chkosimage command should always be used to verify the lpp_source content @@ -68,29 +68,29 @@ OPTIONS -\ **-c |-**\ **-clean**\ - +\ **-c |-**\ **-clean**\ + Remove any older versions of the rpms. Keep the version with the latest timestamp. - -\ **-h |-**\ **-help**\ - + +\ **-h |-**\ **-help**\ + Display usage message. - -\ *osimage_name*\ - + +\ *osimage_name*\ + The name of the xCAT for AIX osimage definition. - -\ **-V |-**\ **-verbose**\ - + +\ **-V |-**\ **-verbose**\ + Verbose mode. - + @@ -115,27 +115,27 @@ EXAMPLES -1. Check the XCAT osimage called "61image" to verify that the lpp_source +1. Check the XCAT osimage called "61image" to verify that the lpp_source directories contain all the software that is specified in the "installp_bundle" and "otherpkgs" attributes. - - + + .. code-block:: perl - + chkosimage -V 61image - - + + 2. Clean up the lpp_source directory for the osimage named "61img" by removing any older rpms with the same names but different versions. - - + + .. code-block:: perl - + chkosimage -c 61img - - + +