Move febootstrap-supermin-helper into helper/ subdirectory.
[febootstrap.git] / README
1 febootstrap - Bootstrap a basic Fedora system
2 by Richard W.M. Jones (rjones@redhat.com)
3 http://people.redhat.com/~rjones/febootstrap
4 ----------------------------------------------------------------------
5
6 febootstrap is a Fedora equivalent to Debian's debootstrap.  You can
7 use it to create a basic Fedora filesystem.
8
9 There are currently some restrictions compared to debootstrap.
10
11 For instructions, restrictions, examples etc. please read the manpage
12 febootstrap(8).
13
14 Requirements
15 ------------
16
17   fakeroot
18     - Tested with version 1.11.
19
20   fakechroot >= 2.9 or 2.8 + patch
21     - **** NB. KNOWN NOT TO WORK WITH 2.8 *****  You MUST apply
22       the patch 'fakechroot-2.8-relchroot.patch' to the fakechroot
23       sources and recompile.  Hopefully this patch will be included
24       in future versions of fakechroot.
25
26   yum
27     - Tested with version 3.2 (works best with 3.2.21 or above)
28     - Needs network access to a Fedora repository, or a local
29       Fedora mirror.
30
31   perldoc
32     - This is just used to generate the manpage.
33
34   bash
35
36   gcc
37
38   qemu
39     - If you want to test-run your systems.
40
41 Building and installing
42 -----------------------
43
44   ./configure
45   make
46   sudo make install
47
48 Note, if you want to run the scripts locally without installing,
49 you have to set the $PATH to the current directory, ie:
50
51   PATH=$(pwd):$PATH
52   febootstrap [...]
53
54 Debugging
55 ---------
56
57 If you get segfaults while running febootstrap or errors in the %post
58 scripts, these are often caused by some incompatibility in the
59 emulation provided by fakeroot/fakechroot.  You can track them down by
60 running the yum command explicitly.  Try:
61
62   fakeroot fakechroot -s \
63     yum -y -c /tmp/repo \
64       --disablerepo=\* --enablerepo=febootstrap \
65       --noplugins --nogpgcheck \
66       --installroot=/tmp/root \
67       install "@Core"
68
69 where /tmp/repo would be a file like this (change repo and arch
70 parameters as appropriate):
71
72   [febootstrap]
73   name=febootstrap
74   failovermethod=priority
75   enabled=1
76   gpgcheck=0
77   mirrorlist=http://mirrors.fedoraproject.org/mirrorlist?repo=rawhide&arch=x86_64
78
79 You can insert gdb in the appropriate place in the fakeroot /
80 fakechroot / yum command.
81
82 Feedback and bugs
83 -----------------
84
85 Send feedback to rjones@redhat.com.  You can file bugs in
86 http://bugzilla.redhat.com/