Fix find -follow support

[oweals/busybox.git] / README

diff --git a/README b/README
index da39fdf19da34cf824b9712bc9b39c597cf9d1ef..b940e357a7395e5c992045239503cc7b7ede9fc1 100644 (file)
--- a/README
+++ b/README
@@ -5,12 +5,12 @@ What is busybox:
 
   BusyBox combines tiny versions of many common UNIX utilities into a single
   small executable.  It provides minimalist replacements for most of the
 
   BusyBox combines tiny versions of many common UNIX utilities into a single
   small executable.  It provides minimalist replacements for most of the

-  utilities you usually find in bzip2, coreutils, e2fsprogs, file, findutils,
-  gawk, grep, inetutils, less, modutils, net-tools, procps, sed, shadow,
-  sysklogd, sysvinit, tar, util-linux, and vim.  The utilities in BusyBox
-  often have fewer options than their full-featured cousins; however, the
-  options that are included provide the expected functionality and behave
-  very much like their larger counterparts.
+  utilities you usually find in bzip2, coreutils, dhcp, diffutils, e2fsprogs,
+  file, findutils, gawk, grep, inetutils, less, modutils, net-tools, procps,
+  sed, shadow, sysklogd, sysvinit, tar, util-linux, and vim.  The utilities
+  in BusyBox often have fewer options than their full-featured cousins;
+  however, the options that are included provide the expected functionality
+  and behave very much like their larger counterparts.

 
   BusyBox has been written with size-optimization and limited resources in
   mind, both to produce small binaries and to reduce run-time memory usage.
 
   BusyBox has been written with size-optimization and limited resources in
   mind, both to produce small binaries and to reduce run-time memory usage.


@@ -44,16 +44,16 @@ Using busybox:
   run (I.E. "./busybox ls -l /proc").
 
   The "standalone shell" mode is an easy way to try out busybox; this is a
   run (I.E. "./busybox ls -l /proc").
 
   The "standalone shell" mode is an easy way to try out busybox; this is a

-  command shell that calls the builtin applets without needing them to be
+  command shell that calls the built-in applets without needing them to be

   installed in the path.  (Note that this requires /proc to be mounted, if
   testing from a boot floppy or in a chroot environment.)
 
   The build automatically generates a file "busybox.links", which is used by
   'make install' to create symlinks to the BusyBox binary for all compiled in
   installed in the path.  (Note that this requires /proc to be mounted, if
   testing from a boot floppy or in a chroot environment.)
 
   The build automatically generates a file "busybox.links", which is used by
   'make install' to create symlinks to the BusyBox binary for all compiled in

-  commands.  This uses the PREFIX environment variable to specify where to
-  install, and installs hardlinks or symlinks depending on the configuration
-  preferences.  (You can also manually run the install script at
-  "applets/install.sh").
+  commands.  This uses the CONFIG_PREFIX environment variable to specify
+  where to install, and installs hardlinks or symlinks depending
+  on the configuration preferences.  (You can also manually run
+  the install script at "applets/install.sh").

 
 ----------------
 
 
 ----------------
 


@@ -66,11 +66,11 @@ Downloading the current source code:
 
   You can browse the up to the minute source code and change history online.
 
 
   You can browse the up to the minute source code and change history online.
 

-    http://www.busybox.net/cgi-bin/viewcvs.cgi/trunk/busybox/
+    http://git.busybox.net/busybox/

 
 

-  Anonymous SVN access is available.  For instructions, check out:
+  Anonymous GIT access is available.  For instructions, check out:

 
 

-    http://busybox.net/subversion.html
+    http://www.busybox.net/source.html

 
   For those that are actively contributing and would like to check files in,
   see:
 
   For those that are actively contributing and would like to check files in,
   see:


@@ -78,13 +78,16 @@ Downloading the current source code:
     http://busybox.net/developer.html
 
   The developers also have a bug and patch tracking system
     http://busybox.net/developer.html
 
   The developers also have a bug and patch tracking system

-  (http://bugs.busybox.net) although posting a bug/patch to the mailing list
+  (https://bugs.busybox.net) although posting a bug/patch to the mailing list

   is generally a faster way of getting it fixed, and the complete archive of
   is generally a faster way of getting it fixed, and the complete archive of

-  what happened is the subversion changelog.
+  what happened is the git changelog.
+
+  Note: if you want to compile busybox in a busybox environment you must
+  select CONFIG_DESKTOP.

 
 ----------------
 
 
 ----------------
 

-getting help:
+Getting help:

 
   when you find you need help, you can check out the busybox mailing list
   archives at http://busybox.net/lists/busybox/ or even join
 
   when you find you need help, you can check out the busybox mailing list
   archives at http://busybox.net/lists/busybox/ or even join


@@ -92,7 +95,7 @@ getting help:
 
 ----------------
 
 
 ----------------
 

-bugs:
+Bugs:

 
   if you find bugs, please submit a detailed bug report to the busybox mailing
   list at busybox@busybox.net.  a well-written bug report should include a
 
   if you find bugs, please submit a detailed bug report to the busybox mailing
   list at busybox@busybox.net.  a well-written bug report should include a


@@ -119,7 +122,7 @@ bugs:
        illegal instruction
 
     i am using debian unstable, kernel version 2.4.25-vrs2 on a netwinder,
        illegal instruction
 
     i am using debian unstable, kernel version 2.4.25-vrs2 on a netwinder,

-    and the latest uclibc from cvs.  thanks for the wonderful program!
+    and the latest uclibc from cvs.

 
        -diligent
 
 
        -diligent
 


@@ -166,14 +169,12 @@ Portability:
   MacOS X, Solaris, Cygwin, or the BSD Fork Du Jour).  This generally involves
   a different kernel and a different C library at the same time.  While it
   should be possible to port the majority of the code to work in one of
   MacOS X, Solaris, Cygwin, or the BSD Fork Du Jour).  This generally involves
   a different kernel and a different C library at the same time.  While it
   should be possible to port the majority of the code to work in one of

-  these environments, don't be suprised if it doesn't work out of the box.  If
+  these environments, don't be surprised if it doesn't work out of the box.  If

   you're into that sort of thing, start small (selecting just a few applets)
   and work your way up.
 
   you're into that sort of thing, start small (selecting just a few applets)
   and work your way up.
 

-  Shaun Jackman has recently (2005) ported busybox to a combination of newlib
-  and libgloss, and some of his patches have been integrated.  This platform
-  may join glibc/uclibc and Linux as a supported combination with the 1.1
-  release, but is not supported in 1.0.
+  In 2005 Shaun Jackman has ported busybox to a combination of newlib
+  and libgloss, and some of his patches have been integrated.

 
 Supported hardware:
 
 
 Supported hardware:
 


@@ -193,6 +194,11 @@ Supported hardware:
 ----------------
 
 Please feed suggestions, bug reports, insults, and bribes back to the busybox
 ----------------
 
 Please feed suggestions, bug reports, insults, and bribes back to the busybox

-maintainer:
-       Rob Landley
-       <rob@landley.net>
+mailing list:
+
+       busybox@busybox.net
+
+and/or maintainer:
+
+       Denys Vlasenko
+       <vda.linux@googlemail.com>