--- /dev/null
+
+PRIMARY AUTHORS are:
+
+ * Anas Nashif <anas.nashif@intel.com>
+ * Gui Chen <gui.chen@intel.com>
+ * Jian-feng Ding <jian-feng.ding@intel.com>
+ * Zhang Qiang <qiang.z.zhang@intel.com>
+
+ADDITIONAL CONTRIBUTORS include:
+
+ * Artem Bityutskiy <artem.bityutskiy@intel.com>
+ * Ed Bartosh <eduard.bartosh@intel.com>
+ * Huanhuan Li <huanhuanx.li@intel.com>
+ * Huaxu Wan <huaxu.wan@intel.com>
+ * Marko Saukko <marko.saukko@cybercom.com>
+ * Shuangquan Zhou <shuangquan.zhou@intel.com>
+ * jobol <jobol@nonadev.net>
+ * yanqingx.li <yanqingx.li@intel.com>
+
--- /dev/null
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Steet, Fifth Floor, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+\f
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+\f
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+\f
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+\f
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+\f
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Steet, Fifth Floor, Boston, MA 02111-1307 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
-=====
- mic
-=====
+ mic - Mic Image Creator
+========================
Overview
-========
+--------
MIC means Image Creator and it's used to create images for Tizen. The tool offers three major functions:
- image creation
With the MIC tool, users can create different types of images for different verticals, including live CD images, live USB images, raw images for KVM, loop images for IVI platforms, and fs images for chrooting. Also, users can work in a chroot environment, based on an existing live image using MIC's enhanced chrooting. Besides, MIC enables transforming an image to another image format, a very useful function for those sensitive to image format.
-Installation
-============
-MIC runs natively in many mainstream Linux distributions, including:
+Resource
+--------
-- Ubuntu (LTS and one latest non-LTS version --- 12.04 and 11.10)
-- openSUSE (the latest version --- 12.1)
-- Fedora (the latest version --- 17)
+ * SITE: https://www.tizen.org/
+ * REPO: https://download.tizen.org/tools/
+ * DOCS: https://source.tizen.org/documentation/reference/mic-image-creator
+ * CODE: https://github.com/01org/mic
+ * BUGS: https://bugs.tizen.org/jira
+ * HELP: general@lists.tizen.org
-Binary Installation
--------------------
+License
+-------
+MIC is Open Source and is distributed under the GPLv2 License. Please see the COPYING file included with this software
-To install the MIC package, get the corresponding repository at:
-http://download.tizen.org/tools/
-
-If none of the distributions available in the list are the one you want, install MIC from source code.
-
-Ubuntu Installation
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-1. Append repository source:
-::
-
- $ sudo vi /etc/apt/sources.list
-
-Append the following line:
-
-for Ubuntu 12.04:
-::
-
- deb http://download.tizen.org/tools/xUbuntu_12.04/
-
-for Ubuntu11.10:
-::
-
- deb http://download.tizen.org/tools/xUbuntu_11.10/
-
-2. Update repository list:
-::
-
- $ sudo apt-get update
-
-3. Install mic:
-::
-
- $ sudo apt-get install mic
-
-OpenSUSE Installation
-~~~~~~~~~~~~~~~~~~~~~
-1. Add Tools Building repository:
-::
-
- $ sudo zypper addrepo http://download.tizen.org/tools/openSUSE12.1/ tools-building
-
-
-2. Update repository list:
-::
-
- $ sudo zypper refresh
-
-3. Install mic:
-::
-
- $ sudo zypper install mic
-
-Fedora Installation
-~~~~~~~~~~~~~~~~~~~
-1. Add The Tools Building repository:
-::
-
- $ sudo cat /etc/yum.repos.d/tools-building.repo
- > [Tools]
- > name=Tools project for mic, gbs, etc. (Fedora_17)
- > baseurl=http://download.tizen.org/tools/Fedora_17/
- > enabled=1
- > gpgcheck=0
-
-2. Update repository cache:
-::
-
- $ sudo yum makecache
-
-3. Install Mic:
-::
-
- $ sudo yum install mic --nogpgcheck
-
-Source Installation
--------------------
-Before you install MIC from the source, make sure you installed all the MIC's dependencies manually.
-
-Enable Bootstrap Environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If your mic is higher than 0.15, it means mic would use bootstrap as default. This is the recommended way to install MIC source. The dependencies are:
-::
-
- - rpm
- - rpm-python
- - python
- - python-xml
- - python-urlgrabber
-
-Take Ubuntu 12.04 as an example, you should install the dependencies with apt-get:
-::
-
- $ sudo apt-get install rpm python-rpm python-urlgrabber
-
-For OpenSUSE, you can install the dependencies with zypper:
-::
-
- $ sudo zypper install rpm-python python-xml python-urlgrabber
-
-Using Native Envionment
-~~~~~~~~~~~~~~~~~~~~~~~
-If you want MIC to run natively in your host, you should install more dependencies to make it work. For Ubuntu 12.04, you should install these packages with apt-get:
-::
-
- $ sudo apt-get install python-rpm bzip2 dmsetup dosfstools e2fsprogs isomd5sum genisoimage \
- > kpartx parted psmisc sqashfs-tools qemu-user-static extlinux syslinux yum python-m2crypto
-
-To get the MIC source, go `here
-<https://github.com/otcshare/mic/downloads>`_ or git clone from github
-
-::
-
- $ git clone https://github.com/01org/mic
-
-Then go to the MIC source directory, and run 'make install' to install MIC from source:
-
-::
-
- $ cd mic
- $ sudo make install
-
-
-Quick Start
-============
-
-How to create an image
------------------------
-
-**Prepare kickstart file**
-
-To create an image, you need a proper ks file.
-Here's a simple example:
-::
-
- # filename: tizen-min.ks
- lang en_US.UTF-8
- keyboard us
- timezone --utc America/Los_Angeles
-
- part / --size 1824 --ondisk sda --fstype=ext3
-
- rootpw tizen
- bootloader --timeout=0 --append="rootdelay=5"
-
- desktop --autologinuser=tizen
- user --name tizen --groups audio,video --password 'tizen'
-
- repo --name=Tizen-base --baseurl=http://download.tizen.org/snapshots/trunk/latest/repos/base/ia32/packages/
- repo --name=Tizen-main --baseurl=http://download.tizen.org/snapshots/trunk/latest/repos/main/ia32/packages/
-
- %packages --ignoremissing
- @tizen-bootstrap
- %end
-
- %post
- rm -rf /var/lib/rpm/__db*
- rpm --rebuilddb
- %end
-
- %post --nochroot
- %end
-
-The ks file above can be used to create a minimum Tizen image. For other repositories, you can replace with the appropriate repository url. For example:
-::
-
- repo --name=REPO-NAME --baseurl=https://username:passwd@yourrepo.com/ia32/packages/ --save --ssl_verify=no
-
-**Create an loop image**
-
-To create an image, run MIC in the terminal:
-::
-
- $ sudo mic create loop tizen-min.ks
-
-How to add/remove packages
---------------------------
-
-You can specific the packages you plan to install in the '%packages' section in ks file. Packages can be specified by group/pattern or by individual package name. The definition of the groups/pattern can be referred to in the repodata/\*comps.xml or repodata/pattern.xml file at the download server. For example: http://download.tizen.org/snapshots/latest/repos/base/ia32/packages/repodata/_.
-
-The %packages section is required to end with '%end'. Also, multiple '%packages' sections are allowed. Additionally, individual packages may be specified using globs. For example:
-::
-
- %packages
- ...
- @Tizen Core # add a group named Tizen Core, and all the packages in this group would be added
- e17-* # add all the packages with name starting with "e17-"
- kernel # add kernel package
- nss-server.armv7hl # add nss-server with arch armv7hl
- -passwd # remove the package passwd
- ...
- %end
-
-Use local rpm package
----------------------
-
-"How can I install my own rpm into the image, so I can test my package with the image?"
-In such a case, using local package path would be very helpful. For example, if your rpm 'hello.rpm' is under directory 'localpath', run MIC like below:
-
-::
-
- $ sudo mic create loop test.ks --local-pkgs-path=localpath
-
-From the output, MIC will tell you "Marked 'hellop.rpm' as installed", and it will install hello.rpm in the image. Be sure your rpm is not in the repo of ks file and that your rpm's version is newer or equal to the repo rpm version.
-
-How to set proxy
-----------------
-
-**Proxy variable in bash**
-
-It's common to use the proxy variable in bash. In general, you can set the following environment variables to enable proxy support:
-
-::
-
- export http_proxy=http://proxy.com:port
- export https_proxy=http://proxy.com:port
- export ftp_proxy=http://proxy.com:port
- export no_proxy=localhost,127.0.0.0/8,.company.com
-
-You don't need all the variables. Check what you do need. When your repo url in your ks file starts with 'https', MIC will use https_proxy. Be especially aware of when you set no_proxy (it indicates which domain should be accessed directly). Don't leave blank space in the string.
-
-Because MIC needs sudo privilege, set /etc/sudoers, to keep the proxy environment, and add those proxy variables to "env_keep":
-
-::
-
- Defaults env_keep += "http_proxy https_proxy ftp_proxy no_proxy"
-
-Note: Use "visudo" to modify /etc/sudoers
-
-However, if you don't want to change your /etc/sudoers, there is an alternative for you to set the proxy in mic.conf. See the next section.
-
-**Proxy setting in mic.conf**
-
-The proxy environment variables may disturb other program, so if you would like to enable proxy support only for MIC, set the proxy in /etc/mic/mic.conf like this:
-
-::
-
- [create]
- ; settings for create subcommand
- tmpdir= /var/tmp/mic
- cachedir= /var/tmp/mic/cache
- outdir= .
- pkgmgr = zypp
- proxy = http://proxy.yourcompany.com:8080/
- no_proxy = localhost,127.0.0.0/8,.yourcompany.com
-
-**Proxy setting in ks file**
-
-It's likely that you will need to enable proxy support only for a special repo url, and other things would remain at their existing proxy setting.
-Here's how to handle that case:
-
-::
-
- repo --name=oss --baseurl=http://www.example.com/repos/oss/packages --proxy=http://host:port
-
-Chroot an image
-----------------
-
-When you want to run commands inside an image, just chroot it first. Be sure your image has bash installed inside:
-
-::
-
- $ sudo mic chroot tizen-min.img
-
-Convert an image to another format
-----------------------------------
-
-**Convert livecd to liveusb**
-
-To convert a livecd image to liveusb:
-
-::
-
- $ sudo mic convert test.iso liveusb
-
-**Convert liveusb to livecd**
-
-To convert a liveusb to livecd:
-
-::
-
- $ sudo mic convert test.usbimg livecd
-
-Basic Usage
-============
-MIC is used to create and manipulate images for Linux distributions. It is composed of three subcommands: create, convert, and chroot.
-
-Create
--------------------
-
-This command is used to create various images, including live CD, live USB, loop, and raw.
-
-**Usage:**
-
-::
-
- mic create(cr) SUBCOMMAND <ksfile> [OPTION]
-
-**Sub-commands:**
-
-::
-
- help(?) give detailed help on a specific sub-command
- fs create fs image, which is also chroot directory
- livecd create live CD image, used for CD booting
- liveusb create live USB image, used for USB booting
- loop create loop image, including multi-partitions
- raw create raw image, containing multi-partitions
-
-**Options:**
-
-::
-
- -h, --help Show this help message and exit
- --logfile=LOGFILE Path of logfile
- -c CONFIG, --config=CONFIG
- Specify config file for MIC
- -k CACHEDIR, --cachedir=CACHEDIR
- Cache directory to store downloaded files
- -o OUTDIR, --outdir=OUTDIR
- Output directory
- -A ARCH, --arch=ARCH
- Specify repo architecture
- --release=RID Generate a release of RID with all necessary files.
- When @BUILD_ID@ is contained in kickstart file, it
- will be replaced by RID.
- --record-pkgs=RECORD_PKGS
- Record the info of installed packages. Multiple values
- can be specified which joined by ",", valid values:
- "name", "content", "license".
- --pkgmgr=PKGMGR Specify backend package manager
- --local-pkgs-path=LOCAL_PKGS_PATH
- Path for local pkgs(rpms) to be installed
- --compress-disk-image=COMPRESS_DISK_IMAGE
- Sets the disk image compression. Note: The available
- values might depend on the used filesystem type.
- --copy-kernel Copy kernel files from image /boot directory to the
- image output directory.
-
-**Examples:**
-
-::
-
- mic cr loop tizen.ks
- mic cr livecd tizen.ks --release=latest
- mic cr fs tizen.ks --local-pkgs-path=localrpm
-
-
-Chroot
--------------------
-
-This command is used to chroot inside the image. It's a great enhancement of the chroot command in the Linux system.
-
-**Usage:**
-
-::
-
- mic chroot(ch) <imgfile>
-
-**Options:**
-
-::
-
- -h, --help show this help message and exit
- -s SAVETO, --saveto=SAVETO
- Save the unpacked image to specified dir
-
-**Examples:**
-
-::
-
- mic ch loop.img
- mic ch tizen.iso
- mic ch -s tizenfs tizen.usbimg
-
-Convert
--------------------
-
-This command is used for converting an image to another format.
-
-**Usage:**
-
-::
-
- mic convert(cv) <imagefile> <destformat>
-
-**Options:**
-
-::
-
- -h, --help Show this help message and exit
- -S, --shell Launch shell before packaging the converted image
-
-**Examples:**
-
-::
-
- mic cv tizen.iso liveusb
- mic cv tizen.usbimg livecd
- mic cv --shell tizen.iso liveusb
-
-What's BootStrap?
-=================
-When some important packages (like rpm) of the distribution (Tizen) is much different with native environment, the image created by native environment may be not bootable. Then a bootstrap environment will be required to create the image.
-
-To create an image of one distribution (Tizen), MIC will create a bootstrap for this distribution (Tizen) at first, and then create the image by chrooting this bootstrap. This way is called "Bootstrap Mode" for MIC. And from 0.15 on, MIC will use this mode by default.
-
-Advanced Usage
-==============
-The advanced usage is exclusively for bootstrap. Please skip it if you don't care about it.
-
-The major reason for using bootstrap is if some important packages (like rpm) are customized a lot in the repo in which you want to create image, and mic must use the customized rpm to create images, or the images can't be booted. So MIC will create a bootstrap using the repo in the ks file at first, then create the image through chrooting, which can make MIC use the chroot environment with the customized rpm.
-
-Now MIC will use bootstrap mode to create an image by default. To meet your requirement, you can also change the bootstrap settings (/etc/mic/bootstrap.conf):
-
-::
-
- [main]
- distro_name = tizen # which distro will be used for creating bootstrap
- rootdir = /var/tmp/mic-bootstrap # which dir will be located when creating bootstrap
- enable = true # whether to enable the bootstrap mode
- [tizen] # the supported distro for creating bootstrap
- optional: # which packages will be optional when creating bootstrap for this distro
- packages: # which packages will be required when creating bootstrap for this distro
-
-
-FAQ
-============
-
-Q: When creating an image, MIC shows "Error <creator>: URLGrabber error: http://www.example.com/latest/repos/oss/ia32/packages/repodata/repomd.xml"
-
-A: Perhaps your network has some issues, or your proxy doesn't work. Try another proxy or find out the network issue.
-
-Q: MIC complains "Error <repo>: found 1 resolver problem, abort!"
-
-A: This is not an issue with MIC, but with the repo you used. Make sure the packages in the repo you used have proper dependencies.
-
-Q: I used '-A i586' to create an i586 image, but it showed "nothing provided ....". What's wrong with it?
-
-A: Use '-A i686'. i586 is lower than i686, so many packages will be missing from the installation.
-
-Q: MIC shows in the log: "file /usr/share/whatever conflicts between attempted installs of somepackageA and somepackageB"
-
-A: There are conflicts between some packages in the repo you used, but this is not an issue with MIC. Please make sure you are using a proper repo.
-
-Q: Error shows: Command 'modprobe' is not available in Fedora 17.
-
-A: In Fedora 17, when you use sudo, the PATH variable will be changed and you will lose some important paths. Run 'export PATH=/sbin:$PATH' before running MIC.
-
-Known Issues
-============
-
-Nonsupport zypp backend in Fedora 17
-------------------------------------
-As libsat-solver changed to libsolv in Fedora 17, zypp backend can't work well for some dependency issues. Use yum as the backend in Fedora 17 distribution.
-
-Unable to install syslinux bootloader
---------------------------------------
-
-In some new Linux distributions, the "syslinux" package in their official software repositories is version 4.04. It causes a segfault, which is a fatal bug, and MIC will fail with syslinux installation errors.
-
-The solution is to install the patched "syslinux" package in MeeGo or Tizen's tools repos, until the official released one has been fixed
-
-Failed to create btrfs image in OpenSUSE
-----------------------------------------
-
-When creating a btrfs image in OpenSUSE, it hangs, showing image kernel panic. This issue impacts OpenSUSE distributions: 12.1, etc.
-
-Failed to create an image (and the password in the repo URL contains "@")
---------------------------------------------------------------------------
-
-MIC cannot support passwords that contain the char "@", but this will be fixed soon. Example:
-
-::
-
- repo --name=Tizen-base --baseurl=https://username:passwd@example.com/arch/packages/ --save --ssl_verify=no
-
-
-Bug report and Contacts
-=========================
-The source code is tracked at github.com: https://github.com/01org/mic
-
-Report issues for bugs or feature requests at JIRA: https://bugs.tizen.org, or at the github page directly.
+Contacts
+--------
+Contact with us at JIRA: https://bugs.tizen.org/jira, or directly at github.com: https://github.com/01org/mic
--- /dev/null
+FAQ
+===
+
+Q: When creating an image, MIC shows "Error <creator>: URLGrabber error: http://www.example.com/latest/repos/oss/ia32/packages/repodata/repomd.xml"
+
+A: Perhaps your network has some issues, or your proxy doesn't work. Try another proxy or find out the network issue.
+
+Q: MIC complains "Error <repo>: found 1 resolver problem, abort!"
+
+A: This is not an issue with MIC, but with the repo you used. Make sure the packages in the repo you used have proper dependencies.
+
+Q: I used '-A i586' to create an i586 image, but it showed "nothing provided ....". What's wrong with it?
+
+A: Use '-A i686'. i586 is lower than i686, so many packages will be missing from the installation.
+
+Q: MIC shows in the log: "file /usr/share/whatever conflicts between attempted installs of somepackageA and somepackageB"
+
+A: There are conflicts between some packages in the repo you used, but this is not an issue with MIC. Please make sure you are using a proper repo.
+
+Q: Error shows: Command 'modprobe' is not available in Fedora 17.
+
+A: In Fedora 17, when you use sudo, the PATH variable will be changed and you will lose some important paths. Run 'export PATH=/sbin:$PATH' before running MIC.
+
+
--- /dev/null
+MIC Installation
+================
+
+.. contents:: Table of Contents
+
+Overview
+--------
+Many mainstream Linux distributions are supported in Tizen Tools repository, including:
+
+- Ubuntu (12.10, 12.04, 11.10)
+- openSUSE (12.2, 12.1)
+- Feodra (17, 16)
+
+Ubuntu Installation
+-------------------
+1. Append Tizen Tools Repository, example: Ubuntu 12.04
+::
+
+ $ sudo vi /etc/apt/sources.list
+
+Append this line:
+::
+
+ deb http://download.tizen.org/tools/latest-release/Ubuntu_12.04/ /
+
+2. Install or upgrade tools
+::
+
+ $ sudo apt-get update
+ $ sudo apt-get install mic
+
+OpenSUSE Installation
+---------------------
+1. Adding Tizen Tools Repository, example: openSUSE12.1
+::
+
+ $ sudo zypper addrepo http://download.tizen.org/tools/latest-release/openSUSE_12.1/ tools
+
+2. Install tools
+::
+
+ $ sudo zypper refresh
+ $ sudo zypper install mic
+
+3. Upgrade tools
+::
+
+ $ sudo zypper refresh
+ $ sudo zypper update mic
+
+Fedora Installation
+-------------------
+1. Adding Tizen Tools Repository, example: Fedora17
+::
+
+ $ sudo wget -O /etc/yum.repos.d/tools.repo http://download.tizen.org/tools/latest-release/Fedora_17/Tools.repo
+
+2. Install tools
+::
+
+ $ sudo yum makecache
+ $ sudo yum install mic
+
+3. Upgrade tools
+::
+
+ $ sudo yum makecache
+ $ sudo yum update mic
+
+Source Installation
+-------------------
+To make your source insatllation work, you should make sure you have installed all required depends of mic. Then run 'make install' to install MIC from source:
+::
+
+ $ cd mic
+ $ sudo make install
=====
- mic
+ mic
=====
------------------------------------------------
-mic Means Image Creator for Linux distributions
------------------------------------------------
-:Date: 2012-03-02
-:Copyright: GPLv2
-:Version: 0.1
-:Manual section: 1
-:Manual group: System
-
SYNOPSIS
========
DESCRIPTION
===========
+
The tools `mic` is used to create and manipulate images for Linux distributions.
It is composed of three subcommand: `create`, `convert`, `chroot`.
--- /dev/null
+MIC Usage
+=========
+
+.. contents:: Table of Contents
+
+Overview
+--------
+MIC offers three major functions:
+
+- creating an image with different format
+- converting an image to another format
+- chrooting into an image
+
+Getting help
+------------
+You can also use `$ mic --help` or `$ mic <subcmd> --help` to get the help message.
+
+How to get help:
+
+- using 'man'
+
+ * man mic
+
+- using '--help' option
+
+ * mic --help
+ * mic create --help
+ * mic help create
+ * mic create loop --help
+ * mic create help loop
+
+Image formulation support
+-------------------------
+- Loop
+
+ * Each loop corresponds to one partition
+ * A file system will be created inside the image
+ * For a configuration with multiple partitions, which is specified in the kickstartfile, mic will generate multiple loop images
+ * And multiple loop images can be packed into a single archive file
+
+- Raw
+
+ * “raw” format means something like hard disk dumping
+ * Including partition table and all the partitions
+ * The image is bootable directly
+
+- Livecd/liveusb
+
+ * Mainly used for an ia32 build, it can be burned to CD or usbstick, which can be booted into a live system or installation UI
+
+- fs
+
+ * “fs” means file-system
+ * mic can install all the Tizen files to the specified directory, which can be used directly as chroot env
+
+
+Create
+------
+- Command line for image creation:
+
+::
+
+ mic create(cr) SUBCOMMAND <ksfile> [OPTION]
+
+
+- Sub-commands, to specify image format, include:
+
+::
+
+ help(?) give detailed help on a specific sub-command
+ fs create fs image, which is also a chroot directory
+ livecd create live CD image, used for CD booting
+ liveusb create live USB image, used for USB booting
+ loop create loop image, including multi-partitions
+ raw create raw image, containing multi-partitions
+
+- <ksfile>:
+
+The kickstart file is a simple text file, containing a list of items about image partition, setup, Bootloader, packages to be installed, etc, each identified by a keyword.
+
+In Tizen, the released image will have a ks file along with image. For example, you can download the ks file from: http://download.tizen.org/releases/daily/trunk/ivi/latest/images/ivi-min...
+
+- Options include:
+
+::
+
+ -h, --help Show this help message and exit
+ --logfile=LOGFILE Path of logfile
+ -c CONFIG, --config=CONFIG
+ Specify config file for MIC
+ -k CACHEDIR, --cachedir=CACHEDIR
+ Cache directory to store downloaded files
+ -o OUTDIR, --outdir=OUTDIR
+ Output directory
+ -A ARCH, --arch=ARCH
+ Specify repo architecture
+ --release=RID Generate a release of RID with all necessary files.
+ When @BUILD_ID@ is contained in kickstart file, it
+ will be replaced by RID.
+ --record-pkgs=RECORD_PKGS
+ Record the info of installed packages. Multiple values
+ can be specified which joined by ",", valid values:
+ "name", "content", "license".
+ --pkgmgr=PKGMGR Specify backend package manager
+ --local-pkgs-path=LOCAL_PKGS_PATH
+ Path for local pkgs(rpms) to be installed
+ --pack-to=PACK_TO Pack the images together into the specified achive,
+ extension supported: .zip, .tar, .tar.gz, .tar.bz2,
+ etc. by default, .tar will be used
+ --copy-kernel Copy kernel files from image /boot directory to the
+ image output directory.
+
+- Other options:
+
+::
+
+ --runtime=RUNTIME_MODE
+ Sets runtime mode, the default is bootstrap mode, valid
+ values: "native", "bootstrap". "native" means mic uses
+ localhost environment to create image, while "bootstrap"
+ means mic uses one tizen chroot environment to create image.
+ --compress-image=COMPRESS_IMAGE (for loop & raw)
+ Sets the disk image compression. Note: The available
+ values might depend on the used filesystem type.
+ --compress-disk-image=COMPRESS_IMAGE
+ Same with --compress-image
+ --shrink (for loop)
+ Whether to shrink loop images to minimal size
+ --generate-bmap (for raw)
+ Generate the block map file
+
+- Examples:
+
+::
+
+ mic cr loop tizen.ks
+
+Chroot
+------
+This command is used to chroot inside the image. It's a great enhancement of the chroot command in the Linux system.
+
+- Usage:
+
+::
+
+ mic chroot(ch) <imgfile>
+
+- Options:
+
+::
+
+ -h, --help Show this help message and exit
+ -s SAVETO, --saveto=SAVETO
+ Save the unpacked image to a specified dir
+
+- Examples:
+
+::
+
+ mic ch loop.img
+ mic ch tizen.iso
+ mic ch -s tizenfs tizen.usbimg
+
+Convert
+-------
+This command is used for converting an image to another format.
+
+
+- Usage:
+
+::
+
+ mic convert(cv) <imagefile> <destformat>
+
+- Options:
+
+::
+
+ -h, --help Show this help message and exit
+ -S, --shell Launch shell before packaging the converted image
+
+- Examples:
+
+::
+
+ mic cv tizen.iso liveusb
+ mic cv tizen.usbimg livecd
+ mic cv --shell tizen.iso liveusb
+
+Getting Start
+-------------
+
+How to create an image
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Prepare kickstart file**
+
+To create an image, you need a proper ks file.
+Here's a simple example:
+::
+
+ # filename: tizen-min.ks
+ lang en_US.UTF-8
+ keyboard us
+ timezone --utc America/Los_Angeles
+
+ part / --size 1824 --ondisk sda --fstype=ext3
+
+ rootpw tizen
+ bootloader --timeout=0 --append="rootdelay=5"
+
+ desktop --autologinuser=tizen
+ user --name tizen --groups audio,video --password 'tizen'
+
+ repo --name=Tizen-base --baseurl=http://download.tizen.org/snapshots/trunk/latest/repos/base/ia32/packages/
+ repo --name=Tizen-main --baseurl=http://download.tizen.org/snapshots/trunk/latest/repos/main/ia32/packages/
+
+ %packages --ignoremissing
+ @tizen-bootstrap
+ %end
+
+ %post
+ rm -rf /var/lib/rpm/__db*
+ rpm --rebuilddb
+ %end
+
+ %post --nochroot
+ %end
+
+The ks file above can be used to create a minimum Tizen image. For other repositories, you can replace with the appropriate repository url. For example:
+::
+
+ repo --name=REPO-NAME --baseurl=https://username:passwd@yourrepo.com/ia32/packages/ --save --ssl_verify=no
+
+**Create an loop image**
+
+To create an image, run MIC in the terminal:
+::
+
+ $ sudo mic create loop tizen-min.ks
+
+How to add/remove packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can specific the packages you plan to install in the '%packages' section in ks file. Packages can be specified by group/pattern or by individual package name. The definition of the groups/pattern can be referred to in the repodata/\*comps.xml or repodata/pattern.xml file at the download server. For example: http://download.tizen.org/snapshots/latest/repos/base/ia32/packages/repodata/_.
+
+The %packages section is required to end with '%end'. Also, multiple '%packages' sections are allowed. Additionally, individual packages may be specified using globs. For example:
+::
+
+ %packages
+ ...
+ @Tizen Core # add a group named Tizen Core, and all the packages in this group would be added
+ e17-* # add all the packages with name starting with "e17-"
+ kernel # add kernel package
+ nss-server.armv7hl # add nss-server with arch armv7hl
+ -passwd # remove the package passwd
+ ...
+ %end
+
+Use local rpm package
+~~~~~~~~~~~~~~~~~~~~~
+
+"How can I install my own rpm into the image, so I can test my package with the image?"
+In such a case, using local package path would be very helpful. For example, if your rpm 'hello.rpm' is under directory 'localpath', run MIC like below:
+
+::
+
+ $ sudo mic create loop test.ks --local-pkgs-path=localpath
+
+From the output, MIC will tell you "Marked 'hellop.rpm' as installed", and it will install hello.rpm in the image. Be sure your rpm is not in the repo of ks file and that your rpm's version is newer or equal to the repo rpm version.
+
+How to set proxy
+~~~~~~~~~~~~~~~~
+
+**Proxy variable in bash**
+
+It's common to use the proxy variable in bash. In general, you can set the following environment variables to enable proxy support:
+
+::
+
+ export http_proxy=http://proxy.com:port
+ export https_proxy=http://proxy.com:port
+ export ftp_proxy=http://proxy.com:port
+ export no_proxy=localhost,127.0.0.0/8,.company.com
+
+You don't need all the variables. Check what you do need. When your repo url in your ks file starts with 'https', MIC will use https_proxy. Be especially aware of when you set no_proxy (it indicates which domain should be accessed directly). Don't leave blank space in the string.
+
+Because MIC needs sudo privilege, set /etc/sudoers, to keep the proxy environment, and add those proxy variables to "env_keep":
+
+::
+
+ Defaults env_keep += "http_proxy https_proxy ftp_proxy no_proxy"
+
+Note: Use "visudo" to modify /etc/sudoers
+
+However, if you don't want to change your /etc/sudoers, there is an alternative for you to set the proxy in mic.conf. See the next section.
+
+**Proxy setting in mic.conf**
+
+The proxy environment variables may disturb other program, so if you would like to enable proxy support only for MIC, set the proxy in /etc/mic/mic.conf like this:
+
+::
+
+ [create]
+ ; settings for create subcommand
+ tmpdir= /var/tmp/mic
+ cachedir= /var/tmp/mic/cache
+ outdir= .
+ pkgmgr = zypp
+ proxy = http://proxy.yourcompany.com:8080/
+ no_proxy = localhost,127.0.0.0/8,.yourcompany.com
+
+**Proxy setting in ks file**
+
+It's likely that you will need to enable proxy support only for a special repo url, and other things would remain at their existing proxy setting.
+Here's how to handle that case:
+
+::
+
+ repo --name=oss --baseurl=http://www.example.com/repos/oss/packages --proxy=http://host:port
+
+What's BootStrap?
+~~~~~~~~~~~~~~~~~
+When some important packages (like rpm) of the distribution (Tizen) is much different with native environment, the image created by native environment may be not bootable. Then a bootstrap environment will be required to create the image.
+
+To create an image of one distribution (Tizen), MIC will create a bootstrap for this distribution (Tizen) at first, and then create the image by chrooting this bootstrap. This way is called "Bootstrap Mode" for MIC. And from 0.15 on, MIC will use this mode by default.
+
+++ /dev/null
-[main]
-distro_name = tizen
-rootdir = /var/tmp/mic-bootstrap
-enable = true
-
-[tizen]
-optional: systemd syslinux syslinux-extlinux
-packages: setup filesystem tzdata libgcc eglibc-common eglibc ncurses-base
- ncurses ncurses-libs bash zlib libpython python-base libstdc++ popt
- libuuid libblkid libcom_err expat db4 nspr elfutils-libelf sqlite
- bzip2-libs bzip2 e2fsprogs-libs libss e2fsprogs libmount libpcre
- libfile libxml2 c-ares mtools dosfstools
- sed readline libattr libacl coreutils openssl gzip python util-linux
- nss-softokn-freebl nss nss-sysinit libidn libcurl curl python-pycurl
- xz-libs kmod libcap liblua rpm-libs rpm rpm-python satsolver-tools
- mkdevnodes udev libudev libzypp python-zypp mic grep pwdutils lua
- device-mapper device-mapper-libs psmisc kpartx parted which gawk
- cpio lsof file python-xml python-urlgrabber smack smack-utils
- libarchive attr xz qemu-arm-static rpm-security-plugin
- expat libxau info libxcb dbus dbus-libs pam
-
-[meego]
-packages: setup filesystem basesystem tzdata meego-release nss-softokn-freebl
- ncurses-base ncurses libgcc glibc-common glibc ncurses-libs bash zlib
- info popt libstdc++ bzip2-libs chkconfig readline libuuid db4 expat
- libcom_err libblkid sqlite file-libs sysvinit-tools shadow-utils passwd
- libgpg-error e2fsprogs-libs db4-utils bzip2 libusb pcre gamin glib2 grep
- sed libxml2 module-init-tools nspr xz-libs device-mapper-libs libcap
- elfutils-libelf liblua hwdata device-mapper kpartx btrfs-progs libgcrypt
- MAKEDEV libss e2fsprogs parted v8 usleep libidn cpio findutils mtools
- syslinux syslinux-extlinux squashfs-tools procps psmisc libffi mkdevnodes
- libksba mingetty libattr libacl coreutils pam openssl libcurl curl gzip
- wget sysvinit genisoimage nss-sysinit nss rpm rpm-libs satsolver-tools
- logrotate gawk rsync dosfstools gdbm python-libs python python-iniparse
- pykickstart m2crypto yum-metadata-parser python-pycurl rpm-python
- isomd5sum net-tools eggdbus dbus-glib util-linux-ng ConsoleKit-libs
- polkit sysklogd ConsoleKit dbus-libs fastinit dbus udev pacrunner
- pacrunner-python python-urlgrabber libudev pth gnupg2 gpgme pygpgme
- lua yum libzypp python-zypp mic2
projects / tools / mic.git / commitdiff