|Original author(s)||Bruce Perens|
|Developer(s)||Erik Andersen, Rob Landley, Denys Vlasenko and others|
|Initial release||November 4, 1999|
|Stable release||1.32.1 (January 1, 2021)|
|Size||2.1 MB (compressed "tar.bz2")|
BusyBox is a software suite that provides several Unix utilities in a single executable file. It runs in a variety of POSIX environments such as Linux, Android, and FreeBSD, although many of the tools it provides are designed to work with interfaces provided by the Linux kernel. It was specifically created for embedded operating systems with very limited resources. The authors dubbed it "The Swiss Army knife of Embedded Linux", as the single executable replaces basic functions of more than 300 common commands. It is released as free software under the terms of the GNU General Public License, version 2.
Originally written by Bruce Perens in 1995 and declared complete for his intended usage in 1996, BusyBox initially aimed to put a complete bootable system on a single floppy disk that would serve both as a rescue disk and as an installer for the Debian distribution. Since that time, it has been extended to become the de facto standard core user space toolset for embedded Linux devices and Linux distribution installers. Since each Linux executable requires several kilobytes of overhead, having the BusyBox program combine over two hundred programs together often saves substantial disk space and system memory.
BusyBox was maintained by Enrique Zanardi and focused on the needs of the Debian boot-floppies installer system until early 1998, when Dave Cinege took it over for the Linux Router Project (LRP). Cinege made several additions, created a modularized build environment, and shifted BusyBox's focus into general high-level embedded systems. As LRP development slowed down in 1999, Erik Andersen, then of Lineo, Inc., took over the project and became the official maintainer between December 1999 and March 2006. During this time the Linux embedded marketplace exploded in growth, and BusyBox matured greatly, expanding both its user base and functionality. Rob Landley became the maintainer in 2005 until late 2006, then Denys Vlasenko took over as the current maintainer.
In September 2006, after heavy discussions and controversies between project maintainer Rob Landley and Bruce Perens, the BusyBox project decided against adopting the GNU Public License Version 3 (GPLv3); the BusyBox license was clarified as being GPL Version 2 (GPLv2) only.
In late 2007, BusyBox also came to prominence for actively prosecuting violations of the terms of its license (the GPL) in the United States District Court for the Southern District of New York.
What was claimed to be the first US lawsuit over a GPL violation concerned use of BusyBox in an embedded device. The lawsuit, case 07-CV-8205 was filed on September 20, 2007 by the Software Freedom Law Center (SFLC) on behalf of Andersen and Landley against Monsoon Multimedia Inc., after BusyBox code was discovered in a firmware upgrade and attempts to contact the company had apparently failed. The case was settled with release of the Monsoon version of the source and payment of an undisclosed amount of money to Andersen and Landley.
On November 21, 2007, the SFLC brought two similar lawsuits on behalf of Andersen and Landley against two more companies, Xterasys (case 07-CV-10455) and High-Gain Antennas (case 07-CV-10456). The Xterasys case was settled on December 17 for release of source code used and an undisclosed payment, and the High-Gain Antennas case on March 6, 2008 for active license compliance and an undisclosed payment. On December 7, 2007, a case was brought against Verizon Communications over its distribution of firmware for Actiontec routers; this case was settled March 17, 2008 on condition of license compliance, appointment of an officer to oversee future compliance with free software licenses, and payment of an undisclosed sum. Further suits were brought on June 9, 2008 against Bell Microproducts (case 08-CV-5270) and SuperMicro (case 08-CV-5269), the Super Micro case being settled on July 23, 2008. BusyBox and Bell Microproducts also settled out of court on October 17.
On December 14, 2009, a new lawsuit was filed naming fourteen defendants including Best Buy, JVC, Samsung and others. In February 2010 Samsung released its LN52A650 TV firmware under GPLv2, which was used later as a reference by the SamyGO community project.
On about August 3, 2010, BusyBox won from Westinghouse a default judgement of triple damages of $90,000 and lawyers' costs and fees of $47,865, and possession of "presumably a lot of high-def TVs" as infringing equipment in the lawsuit Software Freedom Conservancy v. Best Buy, et al., the GPL infringement case noted in the paragraph above.
No other developers, including original author Bruce Perens and maintainer Dave Cinege, were represented in these actions or party to the settlements. On December 15, 2009, Perens released a statement expressing his unhappiness with some aspects of the legal situation, and in particular alleged that the current BusyBox developers "appear to have removed some of the copyright statements of other BusyBox developers, and appear to have altered license statements".
BusyBox can be customized to provide a subset of over two hundred utilities. It can provide most of the utilities specified in the Single Unix Specification (SUS) plus many others that a user would expect to see on a Linux system. BusyBox uses the Almquist shell, also known as A Shell, ash and sh. An alternative for customization is the smaller 'hush' shell. "Msh" and "lash" used to be available.
The BusyBox Web site provides a full list of the utilities implemented.
Typical computer programs have a separate binary (executable) file for each application. BusyBox is a single binary, which is a conglomerate of many applications, each of which can be accessed by calling the single BusyBox binary with various names (supported by having a symbolic link or hard link for each different name) in a specific manner with appropriate arguments.
BusyBox benefits from the single binary approach, as it reduces the overhead introduced by the executable file format (typically ELF), and it allows code to be shared between multiple applications without requiring a library. This technique is similar to what is provided by the crunchgen command in FreeBSD, the difference being that BusyBox provides simplified versions of the utilities (for example, an ls command without file sorting ability), while a crunchgen generated sum of all the utilities would offer the fully functional versions.
Sharing of the common code, along with routines written with size-optimization in mind, can make a BusyBox system use much less storage space than a system built with the corresponding full versions of the utilities replaced by BusyBox. Research that compared GNU, BusyBox, asmutils and Perl implementations of the standard Unix commands showed that in some situations BusyBox may perform faster than other implementations, but not always.
The official BusyBox documentation lists an overview of the available commands and their command-line options.
List of BusyBox commands
- cat — Copy file content to stdout
- chmod — Change file modes
- cp — Copy
- date — Display system date/time
- dd — Copy a file with converting and formatting
- df — Print filesystem usage statistics
- echo — Display a specified line of text.
- grep — Search for PATTERN in each FILE or standard input.
- gunzip — Compressed file expansion.
- gzip — File compression.
- httpd — HTTP server deamon
- kill — Send a signal to a process.
- ln — Create a link named LINK_NAME or DIRECTORY to the specified TARGET.
- login — Begin a new session on the system
- ls — List of files or folders
- mdev — akin to udev
- mkdir — Create a folder
- more — View FILE or standard input one screen-full at a time
- mount — Mount file systems
- mv — move file
- nc — networking Swiss army knife.
- netstat — Display networking information.
- pidof — List PIDs of all processes with names that match NAMEs
- ping — Send ICMP ECHO_REQUEST packets to network hosts
- ps — Report process status
- pwd — Print working directory
- rm — Erase file
- rmdir — Remove directory
- rstats — Copyright of BusyBox
- sed — Text stream editor
- sha1sum — Compute and check SHA-1 message digest
- sha256sum — Compute and check SHA-512 message digest
- sleep — Suspend program execution for a specified time
- stty — Change and print terminal line settings
- su — Execute commands with privileges of another user account
- sum — Checksum and count blocks in a file
- switch root
- sync — Write all buffered file system blocks to disk
- tac — Concatenate and print files in reverse line order
- tail — Output last of file
- tee — Send output to multiple files
- timeout — Run a command with a time limit
- touch — Update the last-modified date on the given FILE[s]
- tr — Translate or delete characters
- udhcpc — Small DHCP client
- umount — Unmount file systems
- uname — Display system information
- uptime — Tell how long the system has been running.
- usleep — Pause for N [microseconds]
- vconfig — VLAN (802.1q) configuration program
- vi — (visual) Edit FILE
- vlock — Virtual Console lock program
- volname — Return volume name
- watch — Execute a program periodically
- watchdog — Software watchdog daemon
- wc — Word, line, and byte or character count
- which — Shows the full path of (shell) commands
- who — Display who is on the system
- whoami — Print effective userid
- xargs — Construct argument lists and invoke utility
- yes — to print a string repetitively
- zcat — Uncompress to stdout
Programs included in BusyBox can be run simply by adding their name as an argument to the BusyBox executable:
More commonly, the desired command names are linked (using hard or symbolic links) to the BusyBox executable; BusyBox reads argv to find the name by which it is called, and runs the appropriate command, for example just
after /bin/ls is linked to /bin/busybox. This works because the first argument passed to a program is the name used for the program call, in this case the argument would be "/bin/ls". BusyBox would see that its "name" is "ls" and act like the "ls" program.
Appliances and reception
BusyBox is used by several operating systems running on embedded systems and is an essential component of distributions such as OpenWrt, OpenEmbedded (including the Yocto Project) and Buildroot. The Sharp Zaurus utilizes BusyBox extensively for ordinary Unix-like tasks performed on the system's shell.
BusyBox is also an essential component of VMware ESXi.
It is necessary for several root applications on Android and is also preinstalled with some "1 Tap Root" solutions such as Kingo Root.
Controversy over Toybox
Toybox was started early 2006 under the GNU General Public License by former BusyBox maintainer Rob Landley as a result of the controversies around GPLv3/GPLv2 discussions. At the end of 2011 it was re-licensed under the BSD License after the project went dormant. On January 11, 2012, Tim Bird, a Sony employee, suggested creating an alternative to BusyBox which would not be under the GNU General Public License. He suggested it be based on the dormant Toybox. In January 2012 the proposal of creating a BSD licensed alternative to the GPL licensed BusyBox project drew harsh criticism from Matthew Garrett for taking away the only relevant tool for copyright enforcement of the Software Freedom Conservancy group. The starter of BusyBox based lawsuits, Rob Landley, responded that this was intentional as he came to the conclusion that the lawsuits resulted not in the hoped for positive outcomes and he wanted to stop them "in whatever way I see fit".
- "Erik Andersen's Homepage".
- Active Projects, Rob Landley's website
- Denys Vlasenko, BusyBox maintainer
- http://www.softwarefreedom.org/resources/2009/busybox-complaint-2009-12-14.pdf[permanent dead link]
- "Release history". Retrieved January 6, 2021.
- BitCubate X. "BusyBox Classic".
- "FreeBSD port overview".
- The slogan for 'The Swiss Army Knife of Embedded Linux' source
- Statement on Busybox Lawsuits on Bruce Perens' Weblog (December 15, 2009, archived)
- corbet (October 1, 2006). "Busy busy busybox". lwn.net. Retrieved November 21, 2015.
Since BusyBox can be found in so many embedded systems, it finds itself at the core of the GPLv3 anti-DRM debate. [...]The real outcomes, however, are this: BusyBox will be GPLv2 only starting with the next release. It is generally accepted that stripping out the "or any later version" is legally defensible, and that the merging of other GPLv2-only code will force that issue in any case
- Landley, Rob (September 9, 2006). "Re: Move GPLv2 vs v3 fun…". lwn.net. Retrieved November 21, 2015.
Don't invent a straw man argument please. I consider licensing BusyBox under GPLv3 to be useless, unnecessary, overcomplicated, and confusing, and in addition to that it has actual downsides. 1) Useless: We're never dropping GPLv2.
- GPL version 2 only for BusyBox 1.3.0. on lwn.net
- Landley, Robert (September 30, 2006). "I'm going out now. I may be some time". busybox (Mailing list).
- On Behalf of BusyBox Developers Andersen and Landley, SFLC Files First Ever U.S. GPL Violation Lawsuit (Software Freedom Law Center September 20, 2007)
- Byfield, Bruce (October 30, 2007). "Settlement reached in Busybox-Monsoon GPL case". Linux.com. Archived from the original on September 24, 2008.
- Linux legal team sues over GPL violations (Martin LaMonica, CNET News.com, November 21, 2007)
- "Second Round of GPL Infringement Lawsuits Filed on Behalf of BusyBox Developers".
- "BusyBox Developers and Xterasys Corporation Agree to Settle GPL Lawsuit".
- BusyBox Developers and High-Gain Antennas Agree to Dismiss GPL Lawsuit (SFLC press release)
- Gross, Grant (December 7, 2007). "Open-source legal group strikes again on BusyBox, suing Verizon". Computerworld.
- "BusyBox Developers File GPL Infringement Lawsuit Against Verizon Communications".
- Verizon Settles Open Source Software Lawsuit (Paul McDougell, InformationWeek, March 17, 2008)
- SFLC Files Another Round of GPL Violation Lawsuits on Behalf of BusyBox Developers (SFLC press release)
- BusyBox Developers and Supermicro Agree to End GPL Lawsuit: Good Faith Discussions Result in Dismissal of Copyright Infringement Case (SFLC press release)
- 2008. Andersen v. Bell Microproducts, Inc., No. 08-cv-5270, Doc. No. 16 (S.D.N.Y. Oct. 17, 2008) (notice of voluntary dismissal)
- Perlow, Jason (December 16, 2009). "How to avoid modern day public GPL floggings". zdnet.com. Retrieved March 24, 2016.
Public floggings and executions like the recent SFLC lawsuit could be avoided if actual standards and procedures for compliance with the GPL and other Free and Open Source licenses actually existed.
- Best Buy, Samsung, Westinghouse, 11 more named in GPL lawsuit on cnet.com
- The Software Freedom Conservancy, Inc. & Mr. Erik Andersen vs BestBuy, Samung, Westinghouse, JVC, Western Digital, Bosch, Phoebe Micro, Humax, ... (New York, 2009)
- Visual Display - Open Source on samsung.com "Please download the links below We use GPLv2 and LGPLv2.1, not GPLv3 and LGPLv3. Model: LN40A650 / LN52A650 / LN52A750 [...] LN52A750.zip" (archived 2010)
- Main_Page on samygo.tv
- Jones, Pamela (August 3, 2010). "BusyBox and the GPL Prevail Again - Updated 4Xs". Groklaw. Retrieved September 27, 2012.
- Bruce Perens, "Statement on Busybox lawsuits", perens.com (December 15, 2009).
- "ash variants". Archived from the original on March 10, 2010. Retrieved May 15, 2008.
- "Use the new 'select' option to make the shell config". August 8, 2003. Retrieved April 2, 2019.
The 'ash' shell adds about 60k in the default configuration and is the most complete and most pedantically correct shell included with busybox. This shell is actually a derivative of the Debian 'dash' shell (by Herbert Xu), which was created by porting the 'ash' shell (written by Kenneth Almquist) from NetBSD.
- BusyBox - The Swiss Army Knife of Embedded Linux
- "BusyBox simplifies embedded Linux systems: A small toolkit for small environments". IBM. Archived from the original on December 9, 2008.
- FreeBSD General Commands Manual –
- Thayer, Doug; Miller, Keith (April 16–17, 2004). "Four UNIX Programs in Four UNIX Collections: Seeking Consistency in an Open Source Icon" (PDF). Proceedings of Midwest Instruction and Computing Symposium. University of Minnesota, Morris.
- "BusyBox Command Help". Retrieved February 24, 2013.
- "Linux on the Road".
- Landley, Rob. "License change commit". Toybox mercurial repository. Retrieved July 24, 2015.
- "Busybox replacement project". January 11, 2012. Retrieved March 4, 2014.
- "Garrett: The ongoing fight against GPL enforcement". LWN.net. January 31, 2012. Retrieved March 4, 2014.
The real problem here is that the [Software Freedom Conservancy's] reliance on Busybox means that they're only able to target infringers who use that Busybox code. No significant kernel copyright holders have so far offered to allow the SFC to enforce their copyrights, with the result that enforcement action will grind to a halt as vendors move over to this Busybox replacement.
- "Garrett: The ongoing fight against GPL enforcement". LWN.net. January 31, 2012. Retrieved March 4, 2014.
>As the ex-maintainer of busybox who STARTED those lawsuits in the first place and now HUGELY REGRETS ever having done so, I think I'm entitled to stop the lawsuits in whatever way I see fit. They never resulted in a single line of code added to the busybox repository. They HAVE resulted in more than one company exiting Linux development entirely and switching to non-Linux operating systems for their embedded products, and they're a big part of the reason behind Android's "No GPL in userspace" policy.
- Proffitt, Brian (February 2, 2012). "GPL enforcement sparks community flames - Throwing the GPL baby out with the enforcement bath water?". ITworld. Retrieved March 4, 2015.
- Perens, Bruce (November 1, 2000). "Building Tiny Linux Systems with BusyBox—Part I". Linux Journal. Archived from the original on November 22, 2015. Retrieved November 22, 2015.
- Jones, M. Tim (August 15, 2006). "Busybox simplifies embedded Linux systems". Developer Works. IBM.
|The Wikibook Learning the vi Editor has a page on the topic of: BusyBox vi|