X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=README;h=b940e357a7395e5c992045239503cc7b7ede9fc1;hb=8b59b2c13ededb2c82e36193b6d6e969df36531c;hp=8d6b76a3379af45474d39bc6e3eef4025e063f5f;hpb=d27d3be6cdf177b8b75e5159f246a87a41b7276a;p=oweals%2Fbusybox.git diff --git a/README b/README index 8d6b76a33..b940e357a 100644 --- a/README +++ b/README @@ -1,15 +1,16 @@ Please see the LICENSE file for details on copying and usage. +Please refer to the INSTALL file for instructions on how to build. 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 - utilities you usually find in bzip2, coreutils, file, findutils, gawk, grep, - inetutils, 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. @@ -40,18 +41,19 @@ Using busybox: The behavior of busybox is determined by the name it's called under: as "cp" it behaves like cp, as "sed" it behaves like sed, and so on. Called as "busybox" it takes the second argument as the name of the applet to - run (I.E. "./busybox ls -l /proc"). + 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 - commands. Use the PREFIX environment variable to specify where to install - the busybox binary and symlink forest. (i.e., 'make PREFIX=/tmp/foo install', - or 'make PREFIX=/tmp/foo install-hardlinks' if you prefer hard links.) + 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"). ---------------- @@ -63,17 +65,12 @@ Downloading the current source code: http://busybox.net/downloads/ You can browse the up to the minute source code and change history online. - The "stable" series is at: - http://www.busybox.net/cgi-bin/viewcvs.cgi/branches/busybox_1_00_stable/busybox/ + http://git.busybox.net/busybox/ - And the development series is at: + Anonymous GIT access is available. For instructions, check out: - http://www.busybox.net/cgi-bin/viewcvs.cgi/trunk/busybox/ - - Anonymous SVN 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: @@ -81,13 +78,16 @@ Downloading the current source code: 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 - 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 @@ -95,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 @@ -122,7 +122,7 @@ bugs: 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 @@ -169,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 - 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. - 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: @@ -196,6 +194,11 @@ Supported hardware: ---------------- Please feed suggestions, bug reports, insults, and bribes back to the busybox -maintainer: - Erik Andersen - +mailing list: + + busybox@busybox.net + +and/or maintainer: + + Denys Vlasenko +