Changeset 2097

Show
Ignore:
Timestamp:
10/07/07 08:17:25 (1 year ago)
Author:
alexander
Message:

Adapted README.txt to the Markdown syntax instead of asciidoc

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/minimal/doc/README.txt

    r2093 r2097  
    7777 
    7878You can compile other programs from sources directly on the CD. All locations 
    79 on the CD can be written to (including '/usr'). 
     79on the CD can be written to (including /usr). 
    8080 
    8181VMWARE ISSUE 
    …… 
    8585VMware Workstation 5.x or earlier or VMware Server 1.0.x or earlier. This is 
    8686a known VMware bug. The solution is to upgrade to VMware Workstation 6.x, or 
    87 to choose 'BusLogic' as the virtual SCSI controller type instead of the 
    88 default 'LSI Logic'. 
     87to choose "BusLogic" as the virtual SCSI controller type instead of the 
     88default "LSI Logic". 
    8989 
    9090The same issue will be present on an LFS system built from this CD. 
    …… 
    9797background. If it is not correct to acquire the network settings via DHCP 
    9898in your location, or if you want to use dialup or GPRS connection, run the 
    99 'net-setup' command. 
     99"net-setup" command. 
    100100 
    101101If you don't want the CD to start dhcpcd on the detected network cards, 
    102 type 'linux nodhcp' at the boot loader prompt. This may be required for 
     102type "linux nodhcp" at the boot loader prompt. This may be required for 
    103103wireless connections that utilize WEP or WPA encryption. 
    104104 
    105105Users of wireless cards based on the Atheros chipset have to install the 
    106 proprietary 'madwifi' driver. The driver is provided in the precompiled form 
    107 in the '/drivers' directory (if you loaded the CD contents to RAM, you have to 
    108 mount the CD and look into '/media/cdrom/drivers' instead). To install it, 
     106proprietary "madwifi" driver. The driver is provided in the precompiled form 
     107in the /drivers directory (if you loaded the CD contents to RAM, you have to 
     108mount the CD and look into /media/cdrom/drivers instead). To install it, 
    109109run the following commands: 
    110110 
    111  cd /drivers 
    112  tar -C / -xf madwifi-x86-6.3-r2052-kernel-[kernel_version].tgz 
    113  tar -C / -xf madwifi-x86-6.3-r2052-tools.tgz 
    114  depmod -ae 
    115  modprobe ath_pci 
     111    cd /drivers 
     112    tar -C / -xf madwifi-x86-6.3-r2052-kernel-[kernel_version].tgz 
     113    tar -C / -xf madwifi-x86-6.3-r2052-tools.tgz 
     114    depmod -ae 
     115    modprobe ath_pci 
    116116 
    117117CUSTOMIZING THE CD CONTENTS 
    …… 
    120120It is possible to burn a customized version of the official Linux From 
    121121Scratch LiveCD, with your own files added. To do that, follow the 
    122 instructions in the '/root/lfscd-remastering-howto.txt' file. 
     122instructions in the /root/lfscd-remastering-howto.txt file. 
    123123 
    124124AUTOSSHD 
    …… 
    128128you have to customize the CD. Create the following files: 
    129129 
    130 '/.autosshd':: 
     130/.autosshd: 
    131131    This is the file that indicates that the sshd daemon should be 
    132132    started automatically. It should be empty. 
    133133 
    134 '/root/.ssh/authorized_keys':: 
     134/root/.ssh/authorized_keys: 
    135135    Add your public key to that file in order to be able to log in. 
    136     Alternatively, modify '/etc/shadow'. 
    137  
    138 '/etc/shadow':: 
     136    Alternatively, modify /etc/shadow. 
     137 
     138/etc/shadow: 
    139139    Edit this file if you want to allow root to login using a password via 
    140140    ssh. It is more secure to use public key based authentication instead. 
    141141 
    142 '/etc/ssh/ssh_host_dsa_key', '/etc/ssh/ssh_host_rsa_key':: 
    143     Create those files as described in the 'ssh-keygen(1)' manual page. If you 
     142/etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key: 
     143    Create those files as described in the *ssh-keygen(1)* manual page. If you 
    144144    do not do that, random host keys will be generated for you automatically 
    145145    during the boot process. This is less secure, because you cannot verify 
    146146    them. 
    147147 
    148 '/etc/sysconfig/network-devices/ifconfig.eth0':: 
     148/etc/sysconfig/network-devices/ifconfig.eth0: 
    149149    Configure a known static IP address there, as described in the LFS book, 
    150     section '7.12. Configuring the network Script'. 
     150    section "7.12. Configuring the network Script". 
    151151 
    152152INTERNATIONALIZATION 
    …… 
    155155It is possible to specify the locale using the bootloader prompt, like this: 
    156156 
    157  linux LANG=es_ES@euro 
     157    linux LANG=es_ES@euro 
    158158 
    159159The CD tries to guess the proper screen font and keymap based on this 
    …… 
    161161following parameters: 
    162162 
    163 KEYMAP:: 
     163KEYMAP: 
    164164  specifies the console keymap(s) to load (actually the arguments to 
    165   the 'loadkeys' program separated by the "+" sign), e.g: 'KEYMAP=es+euro1' 
    166  
    167 LEGACY_CHARSET:: 
     165  the "loadkeys" program separated by the "+" sign) 
     166 
     167Example: "KEYMAP=es+euro1" 
     168 
     169LEGACY_CHARSET: 
    168170  sometimes a ready-made UTF-8 keymap is not available and 
    169171  must be obtained by converting an existing keymap from this charset to UTF-8. 
    170   E.g.: 'LEGACY_CHARSET=iso-8859-15'. 
    171172  This parameter is not used in non-UTF-8 locales. 
    172173 
    173 FONT:: 
     174Example: "LEGACY_CHARSET=iso-8859-15". 
     175 
     176FONT: 
    174177  specifies the screen font to set (actually, the arguments to the 
    175   'setfont' program separated by the "+" sign), e.g: 
    176   'FONT=LatArCyrHeb-16+-m+8859-15' 
     178  "setfont" program separated by the "+" sign). 
     179 
     180Example: "FONT=LatArCyrHeb-16+-m+8859-15" 
    177181 
    178182Alternatively, these items can be configured interactively using dialog-based 
    179183interface if the locale is not specified on the boot prompt. 
    180184 
    181 For some locales (e.g. 'lv_LV.ISO-8859-13') there is no valid console keymap, 
     185For some locales (e.g. lv_LV.ISO-8859-13) there is no valid console keymap, 
    182186but there is a keymap for X. In this case, the only solution is to use a CD 
    183187with X. 
    184188 
    185 While this CD configures the 'LANG' environment variable, console font and 
     189While this CD configures the "LANG" environment variable, console font and 
    186190keymap for you, it is your responsibility to configure other locale-dependent 
    187 parameters manually. You have to explicitly specify the 'iocharset' and 
    188 'codepage' options when mounting filesystems with Windows origin 
    189 (e.g., 'vfat' and 'isofs'). 
     191parameters manually. You have to explicitly specify the "iocharset" and 
     192"codepage" options when mounting filesystems with Windows origin 
     193(e.g., vfat and isofs). 
    190194 
    191195BRAILLE DISPLAY SUPPORT 
    192196----------------------- 
    193197 
    194 The LiveCD includes the 'brltty' program that allows a blind person to read 
     198The LiveCD includes the "brltty" program that allows a blind person to read 
    195199the contents of the Linux text console on a Braille display. In order to 
    196200activate it, insert the CD into the drive, reboot the computer. Some BIOSes 
    …… 
    200204upon startup), type: 
    201205 
    202    linux brltty=eu,ttyS0 
     206    linux brltty=eu,ttyS0 
    203207 
    204208[NOTE] 
    205209This example assumes that the EuroBraille device is connected to the 
    206 first serial port. For other device types, the 'brltty' parameter will 
     210first serial port. For other device types, the "brltty" parameter will 
    207211be different. 
    208212 
    209213[NOTE] 
    210 In some locales, 'brltty' displays incorrect Braille patterns. This is 
     214In some locales, "brltty" displays incorrect Braille patterns. This is 
    211215related to the fact that Braille tables in brltty are indexed with 
    212216encoding-dependent bytes representing the character. Such representation 
    213217becomes invalid when another encoding for the same language is used. 
    214 E.g., that is why the 'ru' table (designed for the KOI8-R encoding) produces 
    215 wrong result in the 'ru_RU.CP1251' locale. 
    216  
    217 Known non-working cases 
    218 ~~~~~~~~~~~~~~~~~~~~~~~ 
    219  
    220  * All CP1251-based locales (no CP1251 Braille table in 'brltty') 
     218E.g., that is why the "ru" table (designed for the KOI8-R encoding) produces 
     219wrong result in the ru_RU.CP1251 locale. 
     220 
     221### Known non-working cases ### 
     222 
     223 * All CP1251-based locales (no CP1251 Braille table in "brltty") 
    221224 
    222225 * All UTF-8 locales (kernel deficiency) 
    223226 
    224227 * zh_TW (configuration instructions available in Chinese only). If you use 
    225    this locale, please send mail to 
    226    mailto:livecd@linuxfromscratch.org[the LiveCD development list] 
     228   this locale, please send mail to <livecd@linuxfromscratch.org> 
    227229   and help us add support for it. 
    228230 
    …… 
    232234the en_US locale, thus avoiding the use of non-ASCII characters. If you know how 
    233235to fix this problem for your locale, mail this information to 
    234 mailto:livecd@linuxfromscratch.org[the LiveCD development list]. 
     236<livecd@linuxfromscratch.org>. 
    235237 
    236238RESUMING THE BUILD 
    237239------------------ 
    238240 
    239 There is a hint: 
    240  
    241 http://www.linuxfromscratch.org/hints/downloads/files/stages-stop-and-resume.txt[How to resume your work after a break at different LFS stages] 
     241There is a hint "How to resume your work after a break at different 
     242-LFS stages" available at: 
     243 
     244<http://www.linuxfromscratch.org/hints/downloads/files/stages-stop-and-resume.txt> 
    242245 
    243246Instructions from there should work on this CD, however, there is a simpler 
    244 method ('hibernation') described below. 
     247method ("hibernation") described below. 
    245248 
    246249Make sure you have (or are planning to create) a swap partition not used 
    247250by other Linux systems installed on your hard drive. The text below assumes 
    248 that '/dev/hda2' is your (existing or planned) swap partition. 
    249  
    250 Pass 'resume=/dev/hda2' as one of the kernel arguments when booting this CD. 
     251that /dev/hda2 is your (existing or planned) swap partition. 
     252 
     253Pass "resume=/dev/hda2" as one of the kernel arguments when booting this CD. 
    251254I.e., the complete boot line may look as: 
    252255   
    253    linux LANG=ru_RU.UTF-8 TZ=Asia/Yekaterinburg resume=/dev/hda2 
     256    linux LANG=ru_RU.UTF-8 TZ=Asia/Yekaterinburg resume=/dev/hda2 
    254257 
    255258Alternatively, once the system is running, you can activate hibernation by 
    …… 
    257260such: 
    258261 
    259    # ls -l /dev/hda2 
    260    brw-rw---- 1 root disk 3, 2 2006-07-10 17:51 /dev/hda2 
    261    # echo 3:2 >/sys/power/resume 
     262    # ls -l /dev/hda2 
     263    brw-rw---- 1 root disk 3, 2 2006-07-10 17:51 /dev/hda2 
     264    # echo 3:2 >/sys/power/resume 
    262265 
    263266At this point, the system is up and running. If you do not already have a 
    …… 
    267270Follow the book as your time permits. 
    268271 
    269 When your time runs out, execute the 'hibernate' command as root. It is not 
     272When your time runs out, execute the "hibernate" command as root. It is not 
    270273necessary to stop the compilation, but running this command during a 
    271274testsuite may lead to failures that would not occur otherwise. 
    …… 
    278281 
    279282On some systems, hibernation refuses to work due to a broken ACPI 
    280 implementation, with the following message in 'dmesg | tail'  output: 
    281  
    282    acpi_pm_prepare does not support 4 
     283implementation, with the following message in "dmesg | tail"  output: 
     284 
     285    acpi_pm_prepare does not support 4 
    283286 
    284287Possible solutions: 
    285288 
    286    a. run the following command before hibernating the computer: 
    287  
    288        echo shutdown >/sys/power/disk 
    289  
    290    b. disable ACPI completely by adding 'acpi=off' to the kernel arguments. 
     289   1. run the following command before hibernating the computer: 
     290 
     291        echo shutdown >/sys/power/disk 
     292 
     293   2. disable ACPI completely by adding "acpi=off" to the kernel arguments. 
    291294 
    292295The computer will save its state to your swap partition and power down. 
    …… 
    294297 
    295298When you are ready to resume the build, boot this CD again and pass exactly 
    296 the same 'vga=...' and 'resume=...' arguments that you used earlier. 
     299the same "vga=..." and "resume=..." arguments that you used earlier. 
    297300 
    298301The computer will load its state from the swap partition and behave as if 
    …… 
    303306or on software RAID. In this case, instead of passing the 'resume=...' argument, 
    304307you should boot the CD as usual and make actions needed for the kernel to see 
    305 the swap device (for LVM, that is 'vgchange -ay'). After doing that, note 
     308the swap device (for LVM, that is "vgchange -ay"). After doing that, note 
    306309the major and minor device number for that device (assigning persistent numbers 
    307 is highly recommended), and echo them to '/sys/power/resume'. E.g., for LVM: 
    308  
    309  # ls -lL /dev/myvg/swap 
    310  brw------- 1 root root 254, 3 2006-07-10 17:51 /dev/myvg/swap 
    311  # echo 254:3 >/sys/power/resume 
     310is highly recommended), and echo them to /sys/power/resume. E.g., for LVM: 
     311 
     312    # ls -lL /dev/myvg/swap 
     313    brw------- 1 root root 254, 3 2006-07-10 17:51 /dev/myvg/swap 
     314    # echo 254:3 >/sys/power/resume 
    312315 
    313316In the case of the first boot, this will store the device numbers to be used 
    314 for hibernation. On the second boot (i.e., after hibernating), this 'echo' 
     317for hibernation. On the second boot (i.e., after hibernating), this "echo" 
    315318command will restore the computer state from the swap device. 
    316319 
    …… 
    318321-------------------- 
    319322 
    320 This CD comes with the 'jhalfs' tool that allows extracting commands from the 
     323This CD comes with the "jhalfs" tool that allows extracting commands from the 
    321324XML version of the LFS or CLFS book into Makefiles and shell scripts. You can 
    322 find the jhalfs installation in the home directory of the 'jhalfs' user, and the 
    323 XML LFS book is in '/usr/share/LFS-BOOK-6.3-XML'. In order to use 'jhalfs', 
     325find the jhalfs installation in the home directory of the "jhalfs" user, and the 
     326XML LFS book is in /usr/share/LFS-BOOK-6.3-XML. In order to use jhalfs, 
    324327you have to: 
    325328 
    326329 * create a directory for your future LFS system and mount a partition there 
    327330 
    328  * change the ownership of that directory to the 'jhalfs' user 
    329  
    330  * run 'su - jhalfs' in order to become that user 
    331  
    332  * as user 'jhalfs', follow the instructions in the 
    333  '/home/jhalfs/jhalfs-<version>/README' file 
    334  
    335 Note that this user already has the required root access (via 'sudo') to 
     331 * change the ownership of that directory to the "jhalfs" user 
     332 
     333 * run "su - jhalfs" in order to become that user 
     334 
     335 * as user "jhalfs", follow the instructions in the jhalfs README file 
     336 
     337Note that this user already has the required root access (via "sudo") to 
    336338complete the build. 
    337339 
    …… 
    343345purposes (e.g., for watching a DVD while compiling LFS). 
    344346 
    345 To load the CD contents to RAM, type 'linux toram' at the boot prompt. 
     347To load the CD contents to RAM, type "linux toram" at the boot prompt. 
    346348 
    347349The minimum required amount of RAM is 512 MB. If you have less than 768 MB of 
    …… 
    350352NOTE: in order to save RAM, sources and proprietary drivers are not loaded 
    351353there. In order to access them, please mount this CD and look into 
    352 '/media/cdrom/sources' and '/media/cdrom/drivers'. 
     354/media/cdrom/sources and /media/cdrom/drivers. 
    353355 
    354356BOOTING FROM ISO IMAGE 
    …… 
    359361Store the ISO image of this CD as a file on a partition formatted with 
    360362one of the following filesystems: 
    361 'vfat', 'ntfs', 'ext2', 'ext3', 'ext4', 'jfs', 'reiserfs', 'reiser4', 'xfs' 
    362  
    363 Copy the 'boot/isolinux/{linux,initramfs_data.cpio.gz}' files from the CD 
     363vfat, ntfs, ext2, ext3, ext4, jfs, reiserfs, reiser4, xfs 
     364 
     365Copy the boot/isolinux/{linux,initramfs_data.cpio.gz} files from the CD 
    364366to your hard disk 
    365367 
    366 Configure the boot loader to load 'linux' as a kernel image and 
    367 'initramfs_data.cpio.gz' as an initrd. The following parameters have to 
     368Configure the boot loader to load "linux" as a kernel image and 
     369"initramfs_data.cpio.gz" as an initrd. The following parameters have to 
    368370be passed to the kernel: 
    369371 
    370    rw root=iso:/dev/XXX:/path/to/lfslivecd.iso rootfstype=fs_type 
    371  
    372 where '/dev/XXX' is a partition where you stored the LiveCD image, and 
    373 'fs_type' is the type of the filesystem on that partition. You may 
    374 also want to add 'rootflags=...' option if mounting this partition requires 
     372    rw root=iso:/dev/XXX:/path/to/lfslivecd.iso rootfstype=fs_type 
     373 
     374where /dev/XXX is a partition where you stored the LiveCD image, and 
     375fs_type is the type of the filesystem on that partition. You may 
     376also want to add "rootflags=..." option if mounting this partition requires 
    375377special flags. 
    376378 
    377379If there is only Windows on the target computer, please use grub4dos as a boot 
    378 loader. It is available from 
    379 http://sourceforge.net/projects/grub4dos[grub4dos project page]. 
     380loader. It is available from <http://sourceforge.net/projects/grub4dos>. 
    380381 
    381382MAKING A BOOTABLE USB DRIVE 
    …… 
    387388computer: 
    388389 
    389  * Use the persistent symlink such as '/dev/disk/by-uuid/890C-F46A' to identify 
     390 * Use the persistent symlink such as "/dev/disk/by-uuid/890C-F46A" to identify 
    390391   the target partition. 
    391392 
    392  * Add 'rootdelay=20' to the kernel arguments. 
     393 * Add "rootdelay=20" to the kernel arguments. 
    393394 
    394395THANKS