ppcrcd/trunk/doc: README.AirPort2 README.chrp README.images README.netbooting README.opts README.usb...

sparky cvs at pld-linux.org
Mon Mar 20 00:11:12 CET 2006


Author: sparky
Date: Mon Mar 20 00:11:01 2006
New Revision: 7245

Modified:
   ppcrcd/trunk/doc/README.AirPort2
   ppcrcd/trunk/doc/README.chrp
   ppcrcd/trunk/doc/README.images
   ppcrcd/trunk/doc/README.netbooting
   ppcrcd/trunk/doc/README.opts
   ppcrcd/trunk/doc/README.usb_boot
   ppcrcd/trunk/doc/gendoc.pl
Log:
- nicer look


Modified: ppcrcd/trunk/doc/README.AirPort2
==============================================================================
--- ppcrcd/trunk/doc/README.AirPort2	(original)
+++ ppcrcd/trunk/doc/README.AirPort2	Mon Mar 20 00:11:01 2006
@@ -1,14 +1,14 @@
 === Fast AirPort 2 reference ===
 
-Prepare room for firmware (already in <*</etc/fstab>*>).
+    Prepare room for firmware (already in <*</etc/fstab>*>).
 | # <_<mount /lib/firmware/>_>
 | # <_<cd /lib/firmware/>_>
 
-If you have OS X installed ppcrcd should detect it and create mount point,
+    If you have OS X installed ppcrcd should detect it and create mount point,
 so you only have to mount it:
 | # <_<mount /mnt/hda3_Mac_OS_X/>_>
 
-And use fwcutter:
+    And use fwcutter:
 | # <_<bcm43xx-fwcutter /mnt/hda3_Mac_OS_X/System/Library/Extensions/AppleAirPort2.kext/Contents/MacOS/AppleAirPort2>_>
 | fwcutter can cut the firmware out of /mnt/hda3_Mac_OS_X/System/Library/Extensions/AppleAirPort2.kext/Contents/MacOS/AppleAirPort2
 |   filename :  AppleAirPort2
@@ -18,10 +18,10 @@
 | extracting bcm43xx_initval09.fw ...
 | extracting bcm43xx_initval10.fw ...
 
-Module should be loaded already, but if not:
+    Module should be loaded already, but if not:
 | # <_<echo "alias eth0 bcm43xx" >> /etc/modprobe.conf>_>
 
-Now edit config file:
+    Now edit config file:
 | # <_<vim /etc/sysconfig/interfaces/ifcfg-eth0>_>
 
 Some usual options are:
@@ -29,7 +29,7 @@
 | WLAN_ESSID="network_name"
 | WLAN_KEY="s:wep passwd"
 
-And the last thing is to start the interface:
+    And the last thing is to start the interface:
 | # <_<ifup eth0>_>
 | Determining IP information for eth0 (dhcpcd).......................[ DONE ]
 

Modified: ppcrcd/trunk/doc/README.chrp
==============================================================================
--- ppcrcd/trunk/doc/README.chrp	(original)
+++ ppcrcd/trunk/doc/README.chrp	Mon Mar 20 00:11:01 2006
@@ -1,16 +1,17 @@
 === booting on Pegasos 2 ===
-yaboot works on NewWorld Mac's and older chrp machines, but not on Pegasos 2
-for it's users there is
+    yaboot works on NewWorld Mac's and older chrp machines, but not on
+Pegasos 2 for it's users there is...
 
 == annother way for booting ppcrcd: ==
-vmlinuz is chrp-bootable kernel with initrd included, you can boot in directly
-from bios, on Pegasos 2, with SmartFirmware this one should work:
-| > <_<boot cd:0 boot/vmlinuz>_>
-you can optionally add kernel options:
-| > <_<boot cd:0 boot/vmlinuz tomempost>_>
-which will load whole image to memory, or any other options found in Options
+    vmlinuz is chrp-bootable kernel with initrd included, you can boot in
+directly, on Pegasos 2, with SmartFirmware this one should work:
+|	> <_<boot cd:0 boot/vmlinuz>_>
+
+    you can optionally add kernel options:
+|	> <_<boot cd:0 boot/vmlinuz tomempost>_>
+which will load whole image to memory; or add any other option found in Options
 readme
 
 == tips for instalation ==
-Install kernel-lib package, this will prepare /boot/zImage-<version> kernel,
-bootable on chrp machines.
+    Install <_<kernel-libs>_> package, this will prepare
+<*</boot/zImage-<version>>*>, kernel bootable on chrp machines.

Modified: ppcrcd/trunk/doc/README.images
==============================================================================
--- ppcrcd/trunk/doc/README.images	(original)
+++ ppcrcd/trunk/doc/README.images	Mon Mar 20 00:11:01 2006
@@ -1,18 +1,18 @@
 === Aliases for kernel image, its functionality and options. ===
 
 == tomem ==
-Loads kernel and whole image in yaboot, then starts system normally.
+    Loads kernel and whole image in yaboot, then starts system normally.
 After booting CDROM will not be needed anymore. Requires 128Mb or
 more of ram. Should work with cdroms not connected to pmac-ide too.
 
 == fromcd ==
-Loads kernel and initrd, starts system. In initrd searches for cdrom,
+    Loads kernel and initrd, starts system. In initrd searches for cdrom,
 mounts it and mounts image from it. CDROM will be needed (and blocked)
 as image is not copied to memory. Should run with 32Mb of RAM.
 Only cdroms connected pmac-ide will work (for now).
-	
+
 == tomempost ==
-Like 'fromcd' loads kernel and initrd, starts system. In initrd
+    Like 'fromcd' loads kernel and initrd, starts system. In initrd
 searches for cdrom, mounts it, and then, copies image to root cd
 and mounts it from there. Umounts CDROM so drive can be used.
 Requires 128Mb of ram. Works only with cdroms connected to pmac-ide.
@@ -20,7 +20,7 @@
 on, try adding <_<ide1=ata66>_> or something similar (check ide help).
 
 == memtest ==
-Loads kernel and initrd. Searches for cdrom and mounts image as root
+    Loads kernel and initrd. Searches for cdrom and mounts image as root
 (/) read-only, umounts initrd and flushes ramdisk. Starts memtester
 with all memory minus 3Mb and reduces amount by 0.5Mb until memtester
 will not be killed.

Modified: ppcrcd/trunk/doc/README.netbooting
==============================================================================
--- ppcrcd/trunk/doc/README.netbooting	(original)
+++ ppcrcd/trunk/doc/README.netbooting	Mon Mar 20 00:11:01 2006
@@ -1,20 +1,21 @@
 === Booting from network ===
 
-== 1. install and prepare DHCP server ==
-in PLD you have only to add:
+= 1. install and prepare DHCP server =
+    in PLD you have only to add:
 | next-server <server_ip>;
 in <*</etc/dhcpd.conf>*>
 
-== 2. install and prepare tftp (tftp-hpa) server ==
+= 2. install and prepare tftp (tftp-hpa) server =
 
-== 3. mount ppcrcd image and execute <_<boot/prep-tftp-files.sh>_> ==
-for help try:
+= 3. mount ppcrcd image and execute <_<boot/prep-tftp-files.sh>_> =
+    for help try:
 | $ <_<prep-tftp-files.sh --help>_>
-remember you need write permisions to tftp dir
+Remember you need write permisions to tftp dir.
 
-== 4. reboot your PPC to Open Firmware ==
-to do it type Command+Option+O+F (Apple+Alt+O+F) on most Mac's,
-then type:
+= 4. reboot your PPC to Open Firmware =
+    to do it press Command+Option+O+F (Apple+Alt+O+F) when booting, should
+work on most Mac's, then type:
 | > <_<boot enet:,\ppc\bootinfo.txt>_>
 
-and wait until yaboot boots, in yaboot you should select 'tomem' image
+    And wait until yaboot boots, in yaboot you should select '<*<tomem>*>'
+image.

Modified: ppcrcd/trunk/doc/README.opts
==============================================================================
--- ppcrcd/trunk/doc/README.opts	(original)
+++ ppcrcd/trunk/doc/README.opts	Mon Mar 20 00:11:01 2006
@@ -1,30 +1,31 @@
 === PPCRCD kernel command-line options ===
-
+-------------------------------------------------------------------------------
 == Options which can be saved to nvram ==
-Each of options if specified in cmdline will overwrite nvram options.
+    Each of options if specified in cmdline will overwrite nvram options.
 nvram options can be disabled at boot time with <*<nonv<option>>*> specified in
 cmdline.
 
 <options "nv">
-
+-------------------------------------------------------------------------------
 
 == Command-line only options ==
 
 <options "">
-
+-------------------------------------------------------------------------------
 
 == Options used in initrd ==
 
 <options "initrd">
-
+-------------------------------------------------------------------------------
 
 == Options used in memtest script ==
 
 <options "memtest">
-
+-------------------------------------------------------------------------------
 
 == Options changing ppcrcd behaviour ==
 Those options will be passed by yaboot automatically when selecting image
 with same name.
 
 <options "bootoption">
+-------------------------------------------------------------------------------

Modified: ppcrcd/trunk/doc/README.usb_boot
==============================================================================
--- ppcrcd/trunk/doc/README.usb_boot	(original)
+++ ppcrcd/trunk/doc/README.usb_boot	Mon Mar 20 00:11:01 2006
@@ -1,10 +1,12 @@
 === Booting from usb-storage device ===
 
+-------------------------------------------------------------------------------
+
 === Prepare image on usb-storage ===
 
 == 1. the easiest way ==
 | $ <_<dd if=ppcrcd.iso of=/dev/sda>_>
-but you will not be able to put anything else on such device
+but you will not be able to put anything else on such device.
 
 
 == 2. prepare mac-partitions ==
@@ -13,59 +15,61 @@
 | /dev/sda2           Apple_HFS PPCRCD 122880 @ 64     ( 60.0M) HFS
 | /dev/sda3     Apple_UNIX_SVR2 Data   880576 @ 122944 (430.0M) Linux native
 
-format as HFS
+    format as HFS
 | $ <_<hformat -l PPCRCD /dev/sda2>_>
 
-mount destination and copy all files from CD image:
+    mount destination and copy all files from CD image:
 | $ <_<sudo mount -t hfs /dev/sda2 mnt>_>
 | $ <_<sudo cp -a /path/to/cd/* mnt/>_>
 | $ <_<sudo umount mnt>_>
 
-set chrp-script atribute:
+    set chrp-script atribute:
 | $ <_<hmount /dev/sda2>_>
 | $ <_<hattrib -b :ppc>_>
 | $ <_<hcd ppc>_>
 | $ <_<hattrib -t tbxi -c TBXI bootinfo.txt>_>
 | $ <_<humount>_>
 
-this way you have rest of disk for use under linux
+    This way you have rest of disk for use under linux.
 
 
 == 3. prapare dos partition ==
-it must be FAT
+    It must be FAT
 | /dev/sda1		1	1011	501425	b  W95 FAT32
 
-format as vfat
+    Format as vfat
 | $ <_<mkfs.vfat -n PPCRCD /dev/sda1>_>
 
-copy all files as they are to this partition
+    Copy all files as they are to this partition.
 
 = NOTE 1: =
-As it isn't hfs partition you won't be able to call tbxi to boot, you
+    As it isn't hfs partition you won't be able to call </<tbxi>/> to boot, you
 have to specify file manually:
 |	0 > <_<boot usb1/disk at 1:1,\ppc\bootinfo.txt>_>
 or directly boot yaboot:
 |	0 > <_<boot usb1/disk at 1:1,\boot\yaboot>_>
 
 = NOTE 2: =
-I don't know does all open firmwares have fat support, you can check if
+    I don't know does all open firmwares have fat support, you can check if
 your has typing in OF:
 |	0 > <_<dev /packages ls>_>
 or under linux:
 |	$ <_<ls /proc/device-tree/packages>_>
-and looking for /fat-files
+and looking for <*</fat-files>*>.
+
 
+-------------------------------------------------------------------------------
 
 === Now, how to boot ===
 
-== 1. connect usb-disk and reboot ==
+= 1. connect usb-disk and reboot =
 
-== 2. press Command-Option-O-F (Apple-Alt-O-F) to enter open firmware ==
+= 2. press Command-Option-O-F (Apple-Alt-O-F) to enter open firmware =
 
-== 3. look for usb* aliases ==
+= 3. look for usb* aliases =
 |	0 > <_<devalias>_>
 
-== 4. check for one with usb-disk ==
+= 4. check for one with usb-disk =
 |	0 > <_<dev usb0 ls>_>
 |	 ok
 |	0 > <_<dev usb1 ls>_>
@@ -74,11 +78,10 @@
 |	0 > <_<dev usb2 ls>_>
 |	 ok
 
-== 5. boot script ==
+= 5. boot tbxi script, or yaboot =
 |	0 > <_<boot usb1/disk at 1:2,\\:tbxi>_>
 
-where:
+    where:
     </<usb1/disk at 1>/> is device path
     </<2>/> is partition where PPCRCD files are
     </<\\:tbxi>/> is chrp-script file
-

Modified: ppcrcd/trunk/doc/gendoc.pl
==============================================================================
--- ppcrcd/trunk/doc/gendoc.pl	(original)
+++ ppcrcd/trunk/doc/gendoc.pl	Mon Mar 20 00:11:01 2006
@@ -40,14 +40,16 @@
 	s#&lt;_&lt;(.*?)&gt;_&gt;#<u>$1</u>#gs;
 	s#&lt;\*&lt;(.*?)&gt;\*&gt;#<b>$1</b>#gs;
 	s#&lt;/&lt;(.*?)&gt;/&gt;#<i>$1</i>#gs;
-	s#^===\s*(.*)\s*===$#<h1>$1</h1>#gm;
-	s#^==\s*(.*)\s*==$#<h2>$1</h2>#gm;
-	s#^=\s*(.*)\s*=$#<h3>$1</h3>#gm;
+	s#^===\s*(.*?)\s*===$#<h1>$1</h1>#gm;
+	s#^==\s*(.*?)\s*==$#<h2>$1</h2>#gm;
+	s#^=\s*(.*?)\s*=$#<h3>$1</h3>#gm;
+	s#^-------*$#<hr/>#gm;
 	return $_;
 }
 
 sub htmlize {
 	my $pre = 0;
+	my $par = 0;
 	my $out = "";
 	foreach my $line ( split /\n/, html($_[0]) ) {
 		if ( $line =~ s/^\|\s// ) {
@@ -62,17 +64,26 @@
 				$out .= "</pre>\n";
 			}
 		}
+		if ($par and $line =~ /(\<h[1-3]\>|&lt;options "[a-z]*"&gt;)/) {
+			$out =~ s#(.)(\s*)$#$1</p>$2#;
+			$par = 0;
+		}
 		unless ( $pre ) {
 			if ( $line =~ s/^    (\S)/$1/ ) {
-				chomp $out;
-				$out .= "<br />\n";
+				if ($par) {
+					$out =~ s#(.)(\s*)$#$1</p>$2#;
+				}
+				$out .= "<p>";
+				$par = 1;
 			}
 		}
 		$out .= $line . "\n";
 	}
 	if ($pre) {
-		chomp $out;
-		$out .= "</pre>\n";
+		$out =~ s#(.)(\s*)$#$1</pre>$2#;
+	}
+	if ($par) {
+		$out =~ s#(.)(\s*)$#$1</p>$2#;
 	}
 	return $out;
 }
@@ -127,6 +138,9 @@
 			div {
 				padding: 5px;
 			}
+			p {
+				text-indent: 15px;
+			}
 		</style>
 	</head>
 	<body>


More information about the pld-cvs-commit mailing list