Bernhard Fischer:
[oweals/busybox.git] / docs / busybox.net / FAQ.html
index 294e219a7f0e0c18c13b3f097c6aa74a9b1f32e3..7931d5dc40b6c14909b2219af0e73175e19236fd 100644 (file)
@@ -15,6 +15,7 @@ have additions to this FAQ document, we would love to add them,
 <li><a href="#bugs">I think I found a bug in BusyBox!  What should I do?!</a>
 <li><a href="#job_control">Why do I keep getting "sh: can't access tty; job control
        turned off" errors?  Why doesn't Control-C work within my shell?</a>
+<li><a href="#getting_started">How can I get started using BusyBox?</a>
 <li><a href="#demanding">I demand that you to add &lt;favorite feature&gt; right now!   How come
        you don't answer all my questions on the mailing list instantly?  I demand
        that you help me with all of my problems <em>Right Now</em>!</a>
@@ -22,7 +23,10 @@ have additions to this FAQ document, we would love to add them,
 <li><a href="#contracts">I need you to add &lt;favorite feature&gt;!  Are the BusyBox developers willing to
        be paid in order to fix bugs or add in &lt;favorite feature&gt;?  Are you willing to provide
        support contracts?</a>
+<li><a href="#external">Where can I find other small utilities since busybox does not include the features I want?</a></li>
 <li><a href="#support">I think you guys are great and I want to help support your work!</a>
+<li><a href="#optimize">I want to make busybox even smaller, how do I go about it?</a>
+
 
 
 </ol>
@@ -69,63 +73,48 @@ have additions to this FAQ document, we would love to add them,
 
 <hr />
 <p>
-<h2><a name="commercial">Can I include BusyBox as part of the software on my device?</h2>
+<h2><a name="commercial">Can I include BusyBox as part of the software on my device?</a></h2>
 
     Yes.  As long as you <a href="http://busybox.net/license.html">fully comply
     with the generous terms of the GPL BusyBox license</a> you can ship BusyBox
     as part of the software on your device.
 
+    <br>
     <a href="#support">Please consider sharing some of the money you make.</a>
 
 
 <hr />
 <p>
-<h2><a name="bugs">I think I found a bug in BusyBox!  What should I do?</h2>
+<h2><a name="bugs">I think I found a bug in BusyBox!  What should I do?</a></h2>
 <p>
 
-    If you find a problem with BusyBox, please submit a detailed bug report to
-    the BusyBox mailing list at <a href="mailto:busybox@mail.busybox.net">
-    busybox@mail.busybox.net</a>.  Please do not send private email to Erik
-    (the maintainer of BusyBox) asking for private help unless you are planning
-    on paying for consulting services.  When we answer questions on the BusyBox
-    mailing list, it helps everyone, while private answers help only you...
-
-    <p>
-
-    If you find bugs, please submit a detailed bug report to the BusyBox mailing
-    list at busybox@mail.busybox.net.  A well-written bug report should include a
-    transcript of a shell session that demonstrates the bad behavior and enables
-    anyone else to duplicate the bug on their own machine. The following is such
-    an example:
-
-<pre>
-       To: busybox@mail.busybox.net
-       From: diligent@testing.linux.org
-       Subject: /bin/date doesn't work
-
-       Package: BusyBox
-       Version: 1.00
 
-       When I execute BusyBox 'date' it produces unexpected results.
-       With GNU date I get the following output:
+<p>
 
-               $ date
-               Fri Oct  8 14:19:41 MDT 2004
+    If you simply need help with using or configuring BusyBox, please submit a
+    detailed description of your problem to the BusyBox mailing list at <a
+    href="mailto:busybox@mail.busybox.net"> busybox@mail.busybox.net</a>.
+    Please do not send private email to Erik (the maintainer of BusyBox) asking
+    for private help unless you are planning on paying for consulting services.
+    When we answer questions on the BusyBox mailing list, it helps everyone,
+    while private answers help only you...
 
-       But when I use BusyBox date I get this instead:
+    <p>
 
-               $ date
-               illegal instruction
+    The developers of BusyBox are busy people, and have only so much they can
+    keep in their brains at a time.  As a result, bug reports sometimes get
+    lost when posted to the mailing list.  To prevent your bug report from
+    getting lost, if you find a bug in BusyBox, please use the <a
+    href="http://bugs.busybox.net/">BusyBox Bug and Patch Tracking System</a>
+    to submit a detailed bug report.
 
-       I am using Debian unstable, kernel version 2.4.27 on a x86 system,
-       and the latest uClibc from CVS.  Thanks for the wonderful program!
+    <p>
 
-         -Diligent
-</pre>
+    The same also applies to patches... Regardless of whether your patch is a
+    bug fix or adds shiney new features, please post your patch to the <a
+    href="http://bugs.busybox.net/">BusyBox Bug and Patch Tracking System</a>
+    to make certain it is properly considered.
 
-    Note the careful description and use of examples showing not only what BusyBox
-    does, but also a counter example showing what an equivalent GNU app does.  Bug
-    reports lacking proper detail may never be fixed...  Thanks for understanding.
 
 <hr />
 <p>
@@ -144,6 +133,27 @@ have additions to this FAQ document, we would love to add them,
     run your shell on a real console...
 
 
+<hr />
+<p>
+<h2><a name="getting_started">How can I get started using BusyBox?</a></h2>
+<p>
+
+    An easy method to build your own basic BusyBox based system, is to
+    follow these simple steps:
+    <ul>
+       <li> Point your web browser <a href="http://buildroot.uclibc.org/">here</a>
+       <li> Download a copy of buildroot
+       <li> Unpack the tarball on your Linux system somewhere
+       <li> run 'make' and configure things to taste.
+       <li> run 'unset CC'.   Some Linux systems (i.e. Gentoo) set 'CC'
+           in the system environment which messes up cross compiles.
+       <li> run 'make'
+       <li> go have lunch, drink a pop, call a friend, play a video game, etc
+               till it finishes downloading software and compiling things.
+       <li> You should now have a shiny new BusyBox based system.
+    </ul>
+
+
 <hr />
 <p>
 <h2><a name="demanding">I demand that you to add &lt;favorite feature&gt; right now!   How come
@@ -198,8 +208,16 @@ have additions to this FAQ document, we would love to add them,
        href="http://codepoet-consulting.com/">CodePoet Consulting</a> to bid
     on your project.  If Erik is too busy to personally add your feature, there
     are many other active BusyBox contributors who will almost certainly be able
-    to help you out.  Erik can contact them and ask them about their availability,
-    and may even ask you to post your request for services on the mailing list.
+    to help you out.  Erik can contact them privately, and may even let you to
+    post your request for services on the mailing list.
+
+
+<hr />
+<p>
+<h2><a name="external">Where can I find other small utilities since busybox 
+       does not include the features I want?</a></h2>
+<p>
+       We maintain such a <a href="tinyutils.html">list</a> on this site!
 
 
 <hr />
@@ -207,10 +225,8 @@ have additions to this FAQ document, we would love to add them,
 <h2><a name="support">I think you guys are great and I want to help support your work!</a></h2>
 <p>
 
-    Wow, that would be great!  Erik personally pays for all the bandwidth, and
-    all servers used for busybox.net out of his own pocket.  If you would like
-    to make a donation to help support BusyBox, and/or request features, you
-    can click here:
+    Wow, that would be great!  If you would like to make a donation to help
+    support BusyBox, and/or request features, you can click here:
 
     <!-- Begin PayPal Logo -->
     <center>
@@ -218,7 +234,7 @@ have additions to this FAQ document, we would love to add them,
        <input type="hidden" name="cmd" value="_xclick">
        <input type="hidden" name="business" value="andersen@codepoet.org">
        <input type="hidden" name="item_name" value="Support BusyBox">
-       <input type="hidden" name="image_url" value="https://codepoet-consulting.com/images/codepoet.png">
+       <input type="hidden" name="image_url" value="http://codepoet-consulting.com/images/codepoet.png">
        <input type="hidden" name="no_shipping" value="1">
        <input type="image" src="images/donate.png" name="submit" alt="Make donation using PayPal">
     </form>
@@ -232,71 +248,27 @@ have additions to this FAQ document, we would love to add them,
     trust PayPal...
 
 <hr />
+<p>
+<h2><a name="optimize">I want to make busybox even smaller, how do I go about it?</a></h2>
+<p>
+       To conserve bytes it's good to know where they're being used, and the
+       size of the final executable isn't always a reliable indicator of
+       the size of the components (since various structures are rounded up,
+       so a small change may not even be visible by itself, but many small
+       savings add up).
+</p>
+<p>
+       The busybox Makefile can generate a report of how much space is actually
+       being used by each function and variable.  Run "<b>make sizes</b>" (preferably
+       with CONFIG_DEBUG off) to get a list of symbols and the amount of
+       space allocated for each one, sorted by size.
+</p>
+<hr />
+
+
 
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
-<br>
 <br>
 <br>
 <br>
 
 <!--#include file="footer.html" -->
-