lib/wic/help.py

7 # with the bulk of the help topic text for the OE Core Image Tools.
92  Create a customized OpenEmbedded image
98     create            Create a new OpenEmbedded image
116  Create a new OpenEmbedded image
118  usage: wic create <wks file or image name> [-o <DIRNAME> | --outdir <DIRNAME>]
119             [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
124  This command creates an OpenEmbedded image based on the 'OE kickstart
127  The -o option can be used to place the image in a directory with a
136     wic create - Create a new OpenEmbedded image
139     wic create <wks file or image name> [-o <DIRNAME> | --outdir <DIRNAME>]
140         [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
146     This command creates an OpenEmbedded image based on the 'OE
150     various build artifacts required to build the image.
158     those locations for a given image.  If the -e option is used, the
162     The -e option is used to specify the name of the image to use the
163     artifacts from e.g. core-image-sato.
176     containing the tools to use to build the image.
178     The -f option is used to build rootfs by running "bitbake <image>"
195     -e' command given an image name e.g. 'core-image-minimal' and a
196     given machine set in local.conf.  In that case, the image is
207     The -o option can be used to place the image in a directory with a
211     an image. gzip, bzip2 and xz compressors are supported.
213     The -m option is used to produce .bmap file for the image. This file
214     can be used to flash image using bmaptool utility.
227         wic list <image> help
237  'canned' image.
252     wic list <image> help
265     'canned' image.
279  List content of a partitioned image
281  usage: wic ls <image>[:<partition>[<path>]] [--native-sysroot <path>]
283  This command  outputs either list of image partitions or directory contents
293     wic ls - List contents of partitioned image or partition
296     wic ls <image>
297     wic ls <image>:<vfat or ext* partition>
298     wic ls <image>:<vfat or ext* partition><path>
299     wic ls <image>:<vfat or ext* partition><path> --native-sysroot <path>
302     This command lists either partitions of the image or directory contents
305     The first form it lists partitions of the image.
307         $ wic ls tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic
313         $ wic ls tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1
325         $ wic ls tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1/EFI/boot/
348  source/destination image in format <image>:<partition>[<path>]
351   - from local to vfat or ext* partitions of partitioned image
352   - from vfat or ext* partitions of partitioned image to local
366     wic cp <src> <dest-image>:<partition><path>
367     wic cp <src> <dest-image>:<partition><path> --native-sysroot <path>
371       - from local to vfat or ext* partitions of partitioned image
372       - from vfat or ext* partitions of partitioned image to local
376         $ wic cp test.wks tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1
377         $ wic ls tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1
392        $ wic cp test tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1/efi/
393        $ wic ls tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1/efi/
407        $ wic cp tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1/vmlinuz test
417  usage: wic rm <image>:<partition><path> [--native-sysroot <path>]
420  the partitioned image.
432     wic rm <src> <image>:<partition><path>
433     wic rm <src> <image>:<partition><path> --native-sysroot <path>
434     wic rm -r <image>:<partition><path>
438     partitioned image:
440         $ wic ls ./tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1
453         $ wic rm ./tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1/libutil.c32
455         $ wic ls ./tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic:1
476  Write image to a device
478  usage: wic write <image> <target device> [--expand [rules]] [--native-sysroot <path>]
480  This command writes partitioned image to a target device (USB stick, SD card etc).
489     wic write - write an image to a device
492     wic write <image> <target>
493     wic write <image> <target> --expand auto
494     wic write <image> <target> --expand 1:100M,2:300M
495     wic write <image> <target> --native-sysroot <path>
498     This command writes an image to a target device (USB stick, SD card etc)
500         $ wic write ./tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.wic /dev/sdb
502     The --expand option is used to resize image partitions.
507     Note: Resizing boot partition can result in non-bootable image for non-EFI images. It is
508     recommended to use size 0 for boot partition to keep image bootable.
525     of the image generation process in wic, mainly the contents of
576           image which will be incorporated into the disk image.
589           into a disk image.  This provides a hook to allow
590           finalization of a disk image, for example to write an MBR to
619     OpenEmbedded build artifacts.  Image generation is driven by
624     artifacts, the result is an image or set of images that can be
650     artifacts that will be used in creating the image: 'raw' and
657     setting and a specified image name to automatically locate the
658     artifacts used to create the image.
665     In any case, the prerequisite for generating any image is to have
667     the user has already build a 'core-image-minimal' for a specific
675     To start out with, we'll generate an image from one of the canned
680         mkefidisk             Create an EFI disk image
681         directdisk            Create a 'pcbios' direct disk image
684     typing 'wic list xxx help', where 'xxx' is one of the image names:
688     Creates a partitioned EFI disk image that the user can directly dd
699        Create a new OpenEmbedded image
701        usage: wic create <wks file or image name> [-o <DIRNAME> | ...]
703             [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
707        This command creates an OpenEmbedded image based on the 'OE
710        The -o option can be used to place the image in a directory
721     So, the easiest way to create an image is to use the -e option
723     specify the image used to generate the artifacts and you actually
726     using the -e options.)  Below, we generate a directdisk image,
727     pointing the process at the core-image-minimal artifacts for the
730       $ wic create directdisk -e core-image-minimal
735       Creating image(s)...
737       Info: The new image(s) can be found here:
740       The following build artifacts were used to create the image(s):
747       The image(s) were created using OE kickstart file:
750     The output shows the name and location of the image created, and
751     so that you know exactly what was used to generate the image, each
754     Similarly, you can create a 'mkefidisk' image in the same way
759       $ wic create mkefidisk -e core-image-minimal
763       Creating image(s)...
765       Info: The new image(s) can be found here:
776       tmp/work/qemux86_64-poky-linux/core-image-minimal/1.0-r0/rootfs
781      Creating image(s)...
783      Info: The new image(s) can be found here:
786      The following build artifacts were used to create the image(s):
787        ROOTFS_DIR:                   tmp/work/qemux86_64-poky-linux/core-image-minimal/1.0-r0/rootfs
792      The image(s) were created using OE kickstart file:
804     commands used to generate the mkefidisk image i.e. these are the
807       # short-description: Create an EFI disk image
808       # long-description: Creates a partitioned EFI disk image that the user
866        This is achieved by wic adding entries to the fstab during image
886                        raised when assembling disk image.
969                          relative path from the resulting image. If the path
975                          of the given path or a rootfs to the resulting image.
1090 Creates a customized OpenEmbedded image.
1104     ls     -   List contents of partitioned image or partition
1107     write  -   Write an image to a device
1109     create -   Create a new OpenEmbedded image
1136     $ wic create mkefidisk -e core-image-minimal
1138     Creates an EFI disk image from artifacts used in a previous
1139     core-image-minimal build in standard BitBake locations