3.16.3. Getting Help

You can get general help for the wic command by entering the wic command by itself or by entering the command with a help argument as follows:

     $ wic -h
     $ wic --help
     $ wic help
                

Currently, Wic supports seven commands: cp, create, help, list, ls, rm, and write. You can get help for all these commands except "help" by using the following form:

     $ wic help command
                

For example, the following command returns help for the write command:

     $ wic help write
                

Wic supports help for three topics: overview, plugins, and kickstart. You can get help for any topic using the following form:

     $ wic help topic
                

For example, the following returns overview help for Wic:

     $ wic help overview
                

One additional level of help exists for Wic. You can get help on individual images through the list command. You can use the list command to return the available Wic images as follows:

     $ wic list images
       mpc8315e-rdb                  		Create SD card image for MPC8315E-RDB
       genericx86                    		Create an EFI disk image for genericx86*
       beaglebone-yocto              		Create SD card image for Beaglebone
       edgerouter                    		Create SD card image for Edgerouter
       qemux86-directdisk            		Create a qemu machine 'pcbios' direct disk image
       directdisk-gpt                		Create a 'pcbios' direct disk image
       mkefidisk                     		Create an EFI disk image
       directdisk                    		Create a 'pcbios' direct disk image
       systemd-bootdisk              		Create an EFI disk image with systemd-boot
       mkhybridiso                   		Create a hybrid ISO image
       sdimage-bootpart              		Create SD card image with a boot partition
       directdisk-multi-rootfs       		Create multi rootfs image using rootfs plugin
       directdisk-bootloader-config  		Create a 'pcbios' direct disk image with custom bootloader config
                

Once you know the list of available Wic images, you can use help with the command to get help on a particular image. For example, the following command returns help on the "beaglebone-yocto" image:

     $ wic list beaglebone-yocto help


     Creates a partitioned SD card image for Beaglebone.
     Boot files are located in the first vfat partition.