diff --git a/docs/source/guides/admin-guides/references/man1/packimage.1.rst b/docs/source/guides/admin-guides/references/man1/packimage.1.rst index 6af0c9223..4c8568b15 100644 --- a/docs/source/guides/admin-guides/references/man1/packimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/packimage.1.rst @@ -23,7 +23,7 @@ SYNOPSIS \ **packimage [-v| -**\ **-version]**\ -\ **packimage**\ [\ **-m | -**\ **-method**\ \ *cpio|tar*\ ] [\ **-c | -**\ **-compress**\ \ *gzip|pigz|xz*\ ] [\ **-**\ **-nosyncfiles**\ ] \ *imagename*\ +\ **packimage**\ [\ **-m | -**\ **-method**\ \ **cpio|tar|squashfs**\ ] [\ **-c | -**\ **-compress**\ \ **gzip|pigz|xz**\ ] [\ **-**\ **-nosyncfiles**\ ] \ *imagename*\ *********** @@ -33,7 +33,7 @@ DESCRIPTION Packs the stateless image from the chroot file system into a file to be sent to the node for a diskless boot. -Note: For an osimage that is deployed on a cluster, running packimage will overwrite the existing rootimage file and be unavailable to the compute nodes while packimage is running. +Note: For an osimage that is deployed on a cluster, running \ **packimage**\ will overwrite the existing rootimage file and be unavailable to the compute nodes while \ **packimage**\ is running. ********** @@ -49,15 +49,36 @@ OPTIONS ******* -\ **-h**\ Display usage message. -\ **-v**\ Command Version. +\ **-h**\ + + Display usage message. + -\ **-m| -**\ **-method**\ Archive Method (cpio,tar,squashfs, default is cpio) -\ **-c| -**\ **-compress**\ Compress Method (pigz,gzip,xz, default is pigz/gzip) +\ **-v**\ + + Command Version. + + + +\ **-m| -**\ **-method**\ + + Archive Method (cpio, tar, squashfs (requires overlayFS or aufs modules during provisioning), default is cpio) + + + +\ **-c| -**\ **-compress**\ + + Compress Method (pigz, gzip, xz, default is pigz/gzip) + + + +\ **-**\ **-nosyncfiles**\ + + Bypass of syncfiles requested, will not sync files to root image directory + -\ **-**\ **-nosyncfiles**\ Bypass of syncfiles requested, will not sync files to root image directory ************ diff --git a/xCAT-client/pods/man1/packimage.1.pod b/xCAT-client/pods/man1/packimage.1.pod index dbca7c266..32e91d9f7 100644 --- a/xCAT-client/pods/man1/packimage.1.pod +++ b/xCAT-client/pods/man1/packimage.1.pod @@ -8,13 +8,13 @@ B B -B [B<-m>|B<--method> I] [B<-c>|B<--compress> I] [B<--nosyncfiles>] I +B [B<-m>|B<--method> B] [B<-c>|B<--compress> B] [B<--nosyncfiles>] I =head1 DESCRIPTION Packs the stateless image from the chroot file system into a file to be sent to the node for a diskless boot. -Note: For an osimage that is deployed on a cluster, running packimage will overwrite the existing rootimage file and be unavailable to the compute nodes while packimage is running. +Note: For an osimage that is deployed on a cluster, running B will overwrite the existing rootimage file and be unavailable to the compute nodes while B is running. =head1 PARAMETERS @@ -22,17 +22,29 @@ I specifies the name of a OS image definition to be used. The specifi =head1 OPTIONS +=over 10 -B<-h> Display usage message. +=item B<-h> -B<-v> Command Version. +Display usage message. -B<-m| --method> Archive Method (cpio,tar,squashfs, default is cpio) +=item B<-v> -B<-c| --compress> Compress Method (pigz,gzip,xz, default is pigz/gzip) +Command Version. -B<--nosyncfiles> Bypass of syncfiles requested, will not sync files to root image directory +=item B<-m| --method> +Archive Method (cpio, tar, squashfs (requires overlayFS or aufs modules during provisioning), default is cpio) + +=item B<-c| --compress> + +Compress Method (pigz, gzip, xz, default is pigz/gzip) + +=item B<--nosyncfiles> + +Bypass of syncfiles requested, will not sync files to root image directory + +=back =head1 RETURN VALUE