Added Troubleshooting page generated by makefaq.pl
authorPravin Shinde <pravin@black-perl.(none)>
Thu, 16 Jul 2009 10:06:52 +0000 (12:06 +0200)
committerPravin Shinde <pravin@black-perl.(none)>
Thu, 16 Jul 2009 10:06:52 +0000 (12:06 +0200)
FAQ.html [deleted file]
Troubleshooting.html
Troubleshooting/Makefile [new file with mode: 0644]
Troubleshooting/footer.txt [new file with mode: 0644]
Troubleshooting/header.txt [new file with mode: 0644]
Troubleshooting/makefaq.pl [new file with mode: 0755]
Troubleshooting/troubleshooting.txt [new file with mode: 0644]

diff --git a/FAQ.html b/FAQ.html
deleted file mode 100644 (file)
index 5b0c8c2..0000000
--- a/FAQ.html
+++ /dev/null
@@ -1,170 +0,0 @@
-<html>
-  <head>
-  <link rel="stylesheet" type="text/css" href="BKOStylesteet.css" />
-    <title>boot.kernel.org(BKO)</title>
-  </head>
-  <body>
-    <div id="logo">
-    <table border="0" width="100%" cellpadding="0" cellspacing="0">
-    <tr>
-      <td valign="middle" align="center">
-        <img src="boot.png" width="367" height="261">
-      </td>
-      <td valign="middle" align="left">
-        <span id="logotext">
-        <p>
-        boot.kernel.org(BKO) : Booting your machine over HTTP
-        </p>
-        </span>
-      </td>
-    </tr>
-    </table>
-    </div>
-    <div id="menubox">
-
-      <span id="menulink">
-        <a href="index.html">Home</a>
-      </span>
-      <span id="menulink">
-        <a href="index.html#download">Downloads</a>
-      </span>
-      <span id="menulink">
-        <a href="index.html#screenshots">Screenshots</a>
-      </span>
-      <span id="menulink">
-        <a href="index.html#howtouse">How to Use</a>
-      </span>
-      <span id="menulink">
-        Developer
-      </span>
-      <span id="menuact">
-        FAQ      
-      </span>
-      <span id="menulink">
-      <a href="Troubleshooting.html">Troubleshooting</a>
-      </span>
-      <span id="menulink">
-        <a href="index.html#contactus">Contact US</a>
-      </span>
-    </div>
-
-    <center><h1>FAQ for BKO</h1></center>
-<ul>
-  <li>
-    <p>Question: <b>When should I use BKO for booting?</b></p>
-    <p>
-      We envision following usage for BKO
-      <ol>
-        <li>
-          To experiment with different distributions available on this site, and install one which you like most.
-       </li>
-       <li>
-          To save your data/system when somehow your system is messed up and you want to recover it. You can use
-         many of the tools available on BKO to rescue yourself.
-       </li>
-       <li>
-         You can do automated mass booting and automated installation for large number of workstations.
-         This can be done by adding specific embedded script to BKO (or by having your private BKO server).
-       </li>
-       <li>
-          Other than these, if you find any other use for BKO, then please share with us. we will be glad to hear from you.
-       </li>
-      </ol>
-    </p>
-  </li>
-<li>
-  <p>Question : <b>Why it is slow?</b></p>
-  <p>
-    <ul>
-      <li>
-       Your entire Operating System is fetched over Internet from <i>far far away server</i> and this takes time.
-      </li>
-      <li>
-       The delay is mostly in booting process, once the system is booted, it should work faster.
-      </li>
-      <li>
-        We recommend you to choose closeby mirror, which will give you <strong>much</strong> better performance.
-      </li>
-      <li>
-        In most of the usage scinario's mentioned above, some delay is tolarable.
-      </li>
-      <li>
-        We recommend you to not to run your daily system from BKO, Please install one of the system available on BKO.
-      </li>
-    </ul>
-  </p>
-</li>
-
-<li>
-  <p>Question : <b>What about my privacy and security?</b></p>
-  <p>
-    We understand your concern, following clarifications should make matter clear for you. You are free to make any decision after that.
-    <ul>
-      <li>
-        Your machine will only download data from server and will never send to the server. So you need not worry about privacy.
-      </li>
-      <li>
-        We provide unmodified ISO's of all distributions, You are always welcome to verify the checksum with actual distribution provider.
-      </li>
-      <li>
-        Even better, you can provide the path of the ISO directly, and your machine will use only that ISO.
-      </li>
-      <li>
-        We only modify InitRAMFS, which is needed to boot over HTTPFS. This modified InitRAMFS is deleated once booting is complete.
-       Hence, if you trust the ISO used, you can trust the system.
-      </li>
-      <li>
-        This is Open Source project, you are welcome to review the code.
-      </li>
-      <li>
-        We also plan to support HTTPS for avoiding any data-tempering on the way.
-      </li>
-    </ul>
-  </p>
-</li>
-<li>
-   <a name="WhyBboUsb"></a>
-
-  <p>Question : <b>Why should I create BKO enabled USB? </b></p>
-  <p>
-    <ul>
-      <li>
-        Creating BKO enabled USB is one-time job, once it is created, you need not worry about upgradation, as it is taken care by BKO servers.
-       It will always let you boot with latest distributions and tools available on BKO.
-      </li>
-      <li>
-        You do not waste your USB as there is way to create BKO enabled USB which can be used as normal data storage device.
-       As BKO takes less than 1 MB of space, you have almost entire USB for data storage.
-      </li>
-      <li>
-        BKO enabled USB can be used to boot (almost) any system as long as there is Internet connectivity.<br/>
-       It is worth considering this ability against 1MB of space and few minutes for cretion of BKO enabled USB.
-      </li>
-    </ul>
-  </p>
-</li>
-
-<li>
-  <p>Question : <b>I am behind firewall, Will BKO boot me</b> </p>
-  <p>
-    BKO is based on HTTPFS and it uses only valid HTTP requests.  It means, if you have HTTP access, you can boot with BKO.<br/>
-    Only problem that may occuar is if you are behind HTTP proxy.  We plan to add support for HTTP proxy
-    in near future. Stay tuned till then.
-  </p>
-</li>
-
-<li>
-  <p>Question : <b>I just want to test BKO, without rebooting the system, Can I do it?</b></p>
-  <p>
-                 If you want to just test our solution without rebooting, then we will recomend you
-                 to download the floppy image of gpxe, and use qemu or other virtualization
-                 solutions to boot from gpxe you downloaded.  In case of qemu, you can use following command:
-                 <pre> qemu -fda gpxe.dsk</pre>
-  </p>
-</li>
-
-</ul>
-
-  </body>
-</html>
index 6f3ffdb..64f9b6c 100644 (file)
   
   We have tried to cover most of the problems that user may face in <a href="faq.html">FAQ</a> page.
   <br/>
-  <a name="customizedGpxe">
-  <h2>Customized gpxe images</h2>
+<ul>
+<li><a href="#customizedGpxe"> Creating customized gpxe images</a><br/><br/></li>
+<li><a href="#BKODhcp"> Script for DHCP networking</a><br/><br/></li>
+<li><a href="#BKOStatic"> Script for static networking at boot time</a><br/><br/></li>
+<li><a href="#BKOStaticCompile"> script for network configuration at compile time.</a><br/><br/></li>
+</ul>
+
+<a id="customizedGpxe"></a><div class="qbox" >
+<table class="qtable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="qmrk" width="1px"><span class="question">Q.</span></td>
+<td class="qtd">
+<div class="query"> Creating customized gpxe images
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="abox">
+<table class="atable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="amrk" width="1px"><span class="answer">A.</span></td>
+<td class="atd">
+<div class="reply"> <p>
   You can create your own customized gpxe images tailered for your network card and
+
    also add embedded script
+
   which will use BKO for booting.  
+
   This is extended <a href="http://rom-o-matic.net">rom-o-matic.net</a> to allow you
+
   embedd any gpxe script.
+
    Please visit <a href="http://rom.etherboot.org/share/pravin/rom-o-matic-BKO.net/">
+
   BKO enabled rom-o-matic.net</a> for creating BKO enabled gpxe images.<br>
+
   You can follow the <u>Configure</u> option which will let you add your own gpxe script.
-  
+
   We are providing few gpxe scripts here, which can be used to create customized gpxe with BKO support.
-  <br/>
-  <b>Script for DHCP networking</b>
-<pre>
-#!gpxe
+
+  </p>
+
+
+
+
+</div>
+</td>
+</tr>
+</table>
+</div><a id="BKODhcp"></a><div class="qbox" >
+<table class="qtable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="qmrk" width="1px"><span class="question">Q.</span></td>
+<td class="qtd">
+<div class="query"> Script for DHCP networking
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="abox">
+<table class="atable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="amrk" width="1px"><span class="answer">A.</span></td>
+<td class="atd">
+<div class="reply"> <p> This gpxe script make sure that machine will boot with DHCP networking.        
+<pre>#!gpxe
+
 echo "Hi, We will be using PXEKnife from URL http://rom.etherboot.org/BKO"
+
 echo "It is assumed that you have dhcp networking"
+
 ifopen net0
+
 dhcp net0
+
 set 209:string pxelinux.cfg/default
+
 set 210:string http://rom.etherboot.org/BKO/
+
 echo "Here we go"
+
 chain http://rom.etherboot.org/BKO/pxelinux.0
+
 echo "PxeKnife booting cancelled, using local disk instead.."
+
  </pre>  
-  <hr/>
-  <br/>
-  <b>Script for static networking</b>
-  <pre>
-#!gpxe
-echo "As you dont have DHCP, you need to give details about network configuration"
-echo "Soon, you will be presented with interface to provide details about network configuration"
-echo "Please provide, IP address, Netmask, Gateway and Router"
+
+</p>
+
+
+
+
+</div>
+</td>
+</tr>
+</table>
+</div><a id="BKOStatic"></a><div class="qbox" >
+<table class="qtable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="qmrk" width="1px"><span class="question">Q.</span></td>
+<td class="qtd">
+<div class="query"> Script for static networking at boot time
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="abox">
+<table class="atable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="amrk" width="1px"><span class="answer">A.</span></td>
+<td class="atd">
+<div class="reply"> Following script provides you an interface at boot time, where you can provide the network configuration. 
+<pre>#!gpxe
+
+echo As you dont have DHCP, you need to give details about network configuration
+
+echo Soon, you will be presented with interface to provide details about network configuration
+
+echo Please provide, IP address, Netmask, Gateway and Router
+
 ifopen net0
+
 set net0/ip 10.0.2.15
+
 set net0/netmask 255.255.255.0
+
 set net0/gateway 10.0.2.2
+
 set net0/dns 10.0.2.3
+
 sleep 3
-config
+
+config net0
+
 set 209:string pxelinux.cfg/default
+
 set 210:string http://rom.etherboot.org/BKO/
+
 echo "Here we go"
+
 chain http://rom.etherboot.org/BKO/pxelinux.0
-echo "PxeKnife booting cancelled, using local disk instead.."
+
+echo PxeKnife booting cancelled, using local disk instead..
+
 </pre>
- <hr/>
-  
-  <hr/>
-  </body>
+
+</p>
+
+
+
+
+</div>
+</td>
+</tr>
+</table>
+</div><a id="BKOStaticCompile"></a><div class="qbox" >
+<table class="qtable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="qmrk" width="1px"><span class="question">Q.</span></td>
+<td class="qtd">
+<div class="query"> script for network configuration at compile time.
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="abox">
+<table class="atable" width="100%" border="0" cellpadding="5" cellspacing="0">
+<tr>
+<td class="amrk" width="1px"><span class="answer">A.</span></td>
+<td class="atd">
+<div class="reply"> <p>
+You can also provide your network configuration at pxe compilation time. This way
+
+it will not prompt the user at boot time.
+
+<pre>#!gpxe
+
+ifopen net0
+
+set net0/ip 10.0.2.15
+
+set net0/netmask 255.255.255.0
+
+set net0/gateway 10.0.2.2
+
+set net0/dns 10.0.2.3
+
+set 209:string pxelinux.cfg/default
+
+set 210:string http://rom.etherboot.org/BKO/
+
+echo "Here we go"
+
+chain http://rom.etherboot.org/BKO/pxelinux.0
+
+echo PxeKnife booting cancelled, using local disk instead..
+
+</pre>
+
+If you compare this script with above, we have just removed the <italic>config net0</italic> which 
+
+is responsible for providing you with user interface.
+
+<p>You can modify above scripts to suit your needs</p>
+
+</p>
+
+</div>
+</td>
+</tr>
+</table>
+</div><hr/>
+</body>
 </html>
-    
\ No newline at end of file
diff --git a/Troubleshooting/Makefile b/Troubleshooting/Makefile
new file mode 100644 (file)
index 0000000..5c37807
--- /dev/null
@@ -0,0 +1,13 @@
+PERL    = perl
+
+GENFILES = Troubleshooting.html
+
+all : $(GENFILES)
+
+clean :
+       rm -f $(GENFILES)
+
+Troubleshooting.html : troubleshooting.txt header.txt footer.txt makefaq.pl
+       $(PERL) makefaq.pl > $@.new
+       mv -f $@.new ../$@
+
diff --git a/Troubleshooting/footer.txt b/Troubleshooting/footer.txt
new file mode 100644 (file)
index 0000000..133381d
--- /dev/null
@@ -0,0 +1,3 @@
+<hr/>
+</body>
+</html>
diff --git a/Troubleshooting/header.txt b/Troubleshooting/header.txt
new file mode 100644 (file)
index 0000000..39ae6a3
--- /dev/null
@@ -0,0 +1,57 @@
+<html>
+  <head>
+  <link rel="stylesheet" type="text/css" href="BKOStylesteet.css" />
+    <title>boot.kernel.org(BKO)</title>
+  </head>
+  <body>
+    <div id="logo">
+    <table border="0" width="100%" cellpadding="0" cellspacing="0">
+    <tr>
+      <td valign="middle" align="center">
+        <img src="boot.png" width="367" height="261">
+      </td>
+      <td valign="middle" align="left">
+        <span id="logotext">
+        <p>
+        boot.kernel.org(BKO) : Booting your machine over HTTP
+        </p>
+        </span>
+      </td>
+    </tr>
+    </table>
+    </div>
+    <div id="menubox">
+      <span id="menulink">
+        <a href="index.html">Home</a>
+      </span>
+      <span id="menulink">
+        <a href="index.html#download">Downloads</a>
+      </span>
+      <span id="menulink">
+        <a href="index.html#screenshots">Screenshots</a>
+      </span>
+      <span id="menulink">
+        <a href="index.html#howtouse">How to Use</a>
+      </span>
+      <span id="menulink">
+        Developer
+      </span>
+      <span id="menulink">
+        <a href="faq.html">FAQ</a>      
+      </span>
+      <span id="menuact">
+      Troubleshooting
+      </span>
+      <span id="menulink">
+        <a href="index.html#contactus">Contact US</a>
+      </span>
+    </div>
+
+    <center><h1>Troubleshooting</h1></center>    
+  <hr/>
+  This page is still under development.   We are looking forward for feedback from our
+  users which will give us good picture about the problems that one may face in booting with BKO. <br>
+  
+  We have tried to cover most of the problems that user may face in <a href="faq.html">FAQ</a> page.
+  <br/>
diff --git a/Troubleshooting/makefaq.pl b/Troubleshooting/makefaq.pl
new file mode 100755 (executable)
index 0000000..b352f6a
--- /dev/null
@@ -0,0 +1,79 @@
+#!/usr/bin/perl
+
+# makefaq.pl
+# Author: John "warthog9" Hawley
+# License: GPL
+# Date Created: 09/30/2005
+# Description:
+#      Basically this is just a quick slap together script I wrote
+#      to deal with the generation of the FAQ file.  This was due
+#      to the fact I wanted the questions seperate from the surrounding 
+#      page structure.  If it changes it should be a LOT easier to adjust
+#      to them.
+#
+# Changelog:
+#--------------------------------------------
+#   Date:    | Who           | Description
+#------------+---------------+---------------
+# 09/30/2005 | JH "warthog9" |  Initial Creation 
+#            |               |
+#            |               |
+#            |               |
+
+
+$questionsfile = "troubleshooting.txt";
+$headerfile = "header.txt";
+$footerfile = "footer.txt";
+
+$question_pre = "<div class=\"qbox\" >\n<table class=\"qtable\" width=\"100%\" border=\"0\" cellpadding=\"5\" cellspacing=\"0\">\n<tr>\n<td class=\"qmrk\" width=\"1px\"><span class=\"question\">Q.</span></td>\n<td class=\"qtd\">\n<div class=\"query\">";
+$question_post = "\n</div>\n</td>\n</tr>\n</table>\n</div>";
+$answer_pre = "<div class=\"abox\">\n<table class=\"atable\" width=\"100%\" border=\"0\" cellpadding=\"5\" cellspacing=\"0\">\n<tr>\n<td class=\"amrk\" width=\"1px\"><span class=\"answer\">A.</span></td>\n<td class=\"atd\">\n<div class=\"reply\">";
+$answer_post = "\n</div>\n</td>\n</tr>\n</table>\n</div>";
+
+open( FH, $headerfile ) || die "No Header file found\n";
+
+while ( <FH> ){
+       print $_;
+}
+
+close(FH);
+
+$questionindex = "";
+$qasection = "";
+undef $tagname;
+
+open( FH, $questionsfile) || die "No Question file found\n";
+$answertail = '';
+
+
+while ( <FH> ){
+       if (/^\#(\S+)/) {
+           $qasection .= $answertail;
+           $answertail = '';
+           $tagname = $1;
+           next;
+       } elsif(/^Q\.(.*)/) {
+           $q = $1;
+           $foo = $1;
+           $foo =~ s/[^a-zA-Z0-9_]/_/g;
+           $tagname = $foo unless ( defined($tagname) );
+           $questionindex .= "<li><a href=\"#$tagname\">$q</a><br/><br/></li>\n";
+           $qasection .= "<a id=\"$tagname\"></a>". $question_pre . $q . $question_post ."\n";
+           undef $tagname;
+       } elsif(/^A\.(.*)/) {
+           $qasection .= $answer_pre . $1 . "\n";
+           $answertail = $answer_post;
+       } else {
+           $qasection .= $_ . "\n";
+       }
+}
+close( FH );
+$qasection .= $answertail;
+
+print "<ul>\n". $questionindex ."</ul>\n\n". $qasection;
+
+open( FH, $footerfile ) || die "No Footer file found\n";
+while ( <FH> ){
+       print $_;
+}
+close( FH );
diff --git a/Troubleshooting/troubleshooting.txt b/Troubleshooting/troubleshooting.txt
new file mode 100644 (file)
index 0000000..aa7b0b7
--- /dev/null
@@ -0,0 +1,73 @@
+#customizedGpxe
+Q. Creating customized gpxe images
+A. <p>
+  You can create your own customized gpxe images tailered for your network card and
+   also add embedded script
+  which will use BKO for booting.  
+  This is extended <a href="http://rom-o-matic.net">rom-o-matic.net</a> to allow you
+  embedd any gpxe script.
+   Please visit <a href="http://rom.etherboot.org/share/pravin/rom-o-matic-BKO.net/">
+  BKO enabled rom-o-matic.net</a> for creating BKO enabled gpxe images.<br>
+  You can follow the <u>Configure</u> option which will let you add your own gpxe script.
+  We are providing few gpxe scripts here, which can be used to create customized gpxe with BKO support.
+  </p>
+
+#BKODhcp
+Q. Script for DHCP networking
+A. <p> This gpxe script make sure that machine will boot with DHCP networking. 
+<pre>#!gpxe
+echo "Hi, We will be using PXEKnife from URL http://rom.etherboot.org/BKO"
+echo "It is assumed that you have dhcp networking"
+ifopen net0
+dhcp net0
+set 209:string pxelinux.cfg/default
+set 210:string http://rom.etherboot.org/BKO/
+echo "Here we go"
+chain http://rom.etherboot.org/BKO/pxelinux.0
+echo "PxeKnife booting cancelled, using local disk instead.."
+ </pre>  
+</p>
+
+#BKOStatic
+Q. Script for static networking at boot time
+A. Following script provides you an interface at boot time, where you can provide the network configuration. 
+<pre>#!gpxe
+echo As you dont have DHCP, you need to give details about network configuration
+echo Soon, you will be presented with interface to provide details about network configuration
+echo Please provide, IP address, Netmask, Gateway and Router
+ifopen net0
+set net0/ip 10.0.2.15
+set net0/netmask 255.255.255.0
+set net0/gateway 10.0.2.2
+set net0/dns 10.0.2.3
+sleep 3
+config net0
+set 209:string pxelinux.cfg/default
+set 210:string http://rom.etherboot.org/BKO/
+echo "Here we go"
+chain http://rom.etherboot.org/BKO/pxelinux.0
+echo PxeKnife booting cancelled, using local disk instead..
+</pre>
+</p>
+
+#BKOStaticCompile
+Q. script for network configuration at compile time.
+A. <p>
+You can also provide your network configuration at pxe compilation time. This way
+it will not prompt the user at boot time.
+<pre>#!gpxe
+ifopen net0
+set net0/ip 10.0.2.15
+set net0/netmask 255.255.255.0
+set net0/gateway 10.0.2.2
+set net0/dns 10.0.2.3
+set 209:string pxelinux.cfg/default
+set 210:string http://rom.etherboot.org/BKO/
+echo "Here we go"
+chain http://rom.etherboot.org/BKO/pxelinux.0
+echo PxeKnife booting cancelled, using local disk instead..
+</pre>
+If you compare this script with above, we have just removed the <italic>config net0</italic> which 
+is responsible for providing you with user interface.
+<p>You can modify above scripts to suit your needs</p>
+</p>
\ No newline at end of file