.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MIC-IMAGE-CREATOR 1"
.TH MIC-IMAGE-CREATOR 1 "2011-05-31" "perl v5.12.3"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
mic\-image\-creator \-  Create various images
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
mic-image-creator [options]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
mic-image-creator is a powerful image creating tool, it can create live
\&\s-1CD\s0, live \s-1USB\s0, VMWare, \s-1KVM\s0 and VirtualBox images using a yum repository and
a kickstart file.
.PP
There are also many companion tools for doing various operations on
images, including mic-image-convertor, mic-chroot, mic-image-writer,
mic-livecd-iso-to-disk, etc. They are all command line tools except
mic-image-writer which has \s-1GUI\s0 if current runtime environment is X.
mic-image-manager is a more powerful \s-1GUI\s0 toolset for them.
.SH "OPTIONS"
.IX Header "OPTIONS"
General options:
.PP
\&\fB\-\-version\fR                        show version number and exit
.PP
\&\fB\-h, \-\-help\fR                       show this help message and exit
.PP
\&\fB\-c \s-1KSCFG\s0, \-\-config=KSCFG\fR          Path to kickstart config file
.PP
\&\fB\-f \s-1FORMAT\s0, \-\-format=FORMAT\fR        Image format, you can specify as livecd, liveusb, loop, raw, nand, mrstnand, ubi, vdi or vmdk
.PP
\&\fB\-t \s-1TMPDIR\s0, \-\-tmpdir=TMPDIR\fR        Temporary directory to use (default: /var/tmp)
.PP
\&\fB\-k \s-1CACHEDIR\s0, \-\-cache=CACHEDIR\fR     Cache directory to use (default: private cache)
.PP
\&\fB\-o \s-1OUTDIR\s0, \-\-outdir=OUTDIR\fR        Output directory to use (default: current work dir)
.PP
\&\fB\-\-genchecksum\fR                     Generate checksum for image file if this option is provided
.PP
\&\fB\-S \s-1SUFFIX\s0, \-\-suffix=SUFFIX\fR        Image name suffix (default: date stamp)
.PP
\&\fB\-b, \-\-build\-bootstrap\fR             Build a bootstrap, it should be used with \-B or \-\-bootstrap together
.PP
\&\fB\-\-mainrepo=MAINREPO\fR               Specify main repo name, it must be a repo name in your kickstart file
.PP
\&\fB\-\-siteconf=SITECONF\fR               Specify site config file, it can be used to set tmpdir, cachedir, outputdir, it also can be used to remap/reroute a repo in kickstart to another equivalent repo, the default site config is ~/.mic2_site.conf.
.PP
\&\fB\-\-repo=REPO\fR                       Specify additional repo, it may be a simple \s-1URL\s0 or a complicated tuple string, you can specify multiple repos using this option multiple times
.PP
\&\fB\-B \s-1BOOTSTRAP\s0, \-\-bootstrap=BOOTSTRAP\fR    Use a given bootstrap env to create image
.PP
\&\fB\-\-alt\-initrd\-name=ALT_INITRD_NAME\fR  Name of alternate initrd image, if \s-1NOT\s0 to use the one from kernel package
.PP
\&\fB\-\-record\-pkgs=RECORD_PKGS\fR          Record the installed packages, valid values: name, content
.PP
\&\fB\-\-local\-pkgs\-path=LOCAL_PKGS_PATH\fR  Path for local pkgs (rpms) to be installed
.SH "OPTIONS For Live USB"
.IX Header "OPTIONS For Live USB"
These options are for creating the live \s-1USB\s0 file image
.PP
\&\fB\-i, \-\-interactive\fR                  Directly write into a \s-1USB\s0 disk.
.PP
\&\fB\-\-fstype=FSTYPE\fR                    File system type for live \s-1USB\s0 file image, ext3 or vfat, the default is vfat.
.PP
\&\fB\-\-overlay\-size\-mb=OVERLAYSIZEMB\fR    overlay size in \s-1MB\s0 as unit, it means how size changes you can save in your live \s-1USB\s0 disk.
.SH "OPTIONS for MRST NAND"
.IX Header "OPTIONS for MRST NAND"
These options are for creating the \s-1MRST\s0 \s-1NAND\s0 image
.PP
\&\fB\-\-initrd\-url=INITRD_URL\fR            \s-1URL\s0 of initrd.img, if it need to be retrieved from remote site.
.PP
\&\fB\-\-initrd\-path=INITRD_PATH\fR          Path of initrd.img, if it was saved in local filesystem.
.PP
\&\fB\-\-kernel\-url=KERNEL_URL\fR            \s-1URL\s0 of kernel file(vmlinuz), if it need to be retrieved from remote site.
.PP
\&\fB\-\-kernel\-path=KERNEL_PATH\fR          Path of kernel file(vmlinuz), if it was saved in local filesystem.
.PP
\&\fB\-\-kernel\-rpm\-url=KERNEL_RPM_URL\fR    \s-1URL\s0 of kernel rpm package, if it need to be retrieved from remote site.
.PP
\&\fB\-\-kernel\-rpm\-path=KERNEL_RPM_PATH\fR  Path of kernel rpm package, if it was saved in local filesystem.
.PP
\&\fB\-\-bootimg\-only\fR      Create boot image only.
.SH "OPTIONS For Debug"
.IX Header "OPTIONS For Debug"
These options control the output of logging information during image
creation
.PP
\&\fB\-d, \-\-debug\fR         Output debugging information
.PP
\&\fB\-v, \-\-verbose\fR       Output verbose progress information
.PP
\&\fB\-\-logfile=FILE\fR      Save debug information to \s-1FILE\s0
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Create a live \s-1CD\s0 image:
.PP
mic-image-creator \-f livecd \-c 2.1\-final.ks
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
mic-image-creator returns  a  zero  exist  status  if it succeeds, otherwise return non-zero and print error message.
.SH "AUTHOR"
.IX Header "AUTHOR"
Yi Yang, Anas Nashif, Jianfeng Ding
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fImic\-image\-convertor\fR\|(1), \fImic\-chroot\fR\|(1), \fImic\-image\-writer\fR\|(1),
\&\fImic\-livecd\-iso\-to\-disk\fR\|(1), \fImic\-image\-manager\fR\|(1)