BusyBox

Collection of Unix tools

BusyBox


Original author(s)	Bruce Perens
Developer(s)	Erik Andersen, Rob Landley, Denys Vlasenko and others
Initial release	November 4, 1999; 25 years ago (1999-11-04)

Stable release	1.36.1 / 19 May 2023

Repository	git.busybox.net/busybox
Written in	C
Operating system	Unix-like
Size	2.1 MB (compressed "tar.bz2")
Type	Linux on embedded systems Linux for mobile devices
License	Since 1.3.0: GPL-2.0-only Until 1.2.2.1: GPL-2.0-or-later
Website	busybox.net

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 v2, after controversially deciding not to move to version 3.

History

Origins

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.

GPLv2/GPLv3 controversies

In September 2006, after heavy discussions and controversies between project maintainer Rob Landley and Bruce Perens, the BusyBox project decided against adopting the GNU General Public License Version 3 (GPLv3); the BusyBox license was clarified as being GPL-2.0-only.

Since October 2006, Denys Vlasenko has taken over maintainership of BusyBox from Rob Landley, who has started Toybox, also as a result of the license controversies.

GPL lawsuits

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".

Features

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.

As it is a complete bootstrap system, it will further replace the init daemon and udev (or the latter-day systemd) using itself to be called as init on startup and mdev at hotplug time.

The BusyBox website provides a full list of the utilities implemented.

Single binary

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.

Commands

The official BusyBox documentation lists an overview of the available commands and their command-line options.

List of BusyBox commands

acpid
adduser
adjtimex
ash
ar
arp — The Address Resolution Protocol (ARP)
arping — Send ARP REQUEST to a neighbour host
ash
basename — Return non-directory portion of a pathname removing suffix.
beep
blkid — Print type, label and UUID of filesystem on a block device or image.
brctl
bunzip2 — Decompress bzip2 files.
bzcat — Decompress bzip2 files to stdout.
bzip2 — Create bzip2 compressed files.
cal — Print a calendar.
cat — Print content of one or more files to stdout.
catv
chat
chattr — Change file attributes on a Linux file system.
chgrp — Change group of one or more files.
chmod — Change mode of listed files.
chown — Change owner of one or more files.
chpasswd
chpst
chroot — Run command within a new root directory.
chrt
chvt
cksum — For each file, output crc32 checksum value, length and name of file.
clear — Clear the screen.
cmp — Compare the contents of two files.
comm — Select or reject lines common to two files.
cp — Copy files.
cpio — Copy files into and out of a "newc" format cpio archive.
crond
crontab
cryptpw
cut — Print selected parts of lines from each FILE to standard output.
date — Set/get the current date/time.
dc
dd — Copy a file with converting and formatting.
deallocvt
delgroup
deluser
depmod
devmem
df — Print filesystem usage statistics.
dhcprelay
diff — Compare two files.
dirname — Show directory portion of path.
dnsd
dnsdomainname
dos2unix — Convert newline format from dos "\r\n" to unix "\n".
dpkg
du — Show disk usage, space consumed by files and directories.
dumpkmap
dumpleases
echo — Display a specified line of text.
ed
eject
env — Set the environment for command invocation, or list environment variables.
envdir
envuidgid
expand — Expand tabs to spaces according to tabstops.
expr
fakeidentd
false
fbset
fbsplash
fdflush
fdformat
fdisk
find
findfs
flash_lock
flash_unlock
fold
free
freeramdisk
fsck.minix
fsck
fsync
ftpd
ftpget
ftpput
fuser
getopt
getty
grep — Search for PATTERN in each FILE or standard input.
gunzip — Compressed file expansion.
gzip — File compression.
hd
hdparm
head
hexdump
hostid
hostname
httpd — HTTP server daemon
hush
hwclock
id
ifconfig
ifdown
ifenslave
ifplugd
ifup
inetd
inotifyd
insmod
install
ionice
ip
ipaddr
ipcalc
ipcrm
ipcs
iplink
iproute
iprule
iptunnel
kbd_mode
kill — Send a signal to a process.
killall
klogd
last
length
less
linux32
linux64
linuxrc
ln — Create a link named LINK_NAME or DIRECTORY to the specified TARGET.
loadfont
loadkmap
logger
login — Begin a new session on the system
logname
logread
losetup
lpd
lpq
lpr
ls — List of files or folders
lsattr
lsmod
lzmacat
lzop
lzopcat
makemime
man
md5sum
mdev — akin to udev
mesg
microcom
mkdir — Create a folder
mkdosfs
mkfifo
mkfs.minix
mkfs.vfat
mknod
mkpasswd
mkswap
mktemp
modprobe
more — View FILE or standard input one screen-full at a time
mount — Mount file systems
mountpoint
mt
mv — move file
nameif
nc — networking Swiss army knife.
netstat — Display networking information.
nice
nmeter
nohup
nslookup
ntpc
ntpsync
nvram
od
openvt
passwd
patch
pgrep
pidof — List PIDs of all processes with names that match NAMEs
ping6
ping — Send ICMP ECHO_REQUEST packets to network hosts
pipe_progress
pivot_root
pkill
popmaildir
printenv
printf
ps — Report process status
pscan
pwd — Print working directory
raidautorun
rdate
rdev
readlink
readprofile
reformime
renice
reset
resize
rm — Erase file
rmdir — Remove directory
rmmod
route
rpm
rstats — Copyright of BusyBox
rx
script
scriptreplay
sed — Text stream editor
sendmail
seq
setarch
setconsole
setfont
sh
sha1sum — Compute and check SHA-1 message digest
sha256sum — Compute and check SHA-256 message digest
sha512sum
showkey
slattach
sleep — Suspend program execution for a specified time
softlimit
sort
split
stat
strings
stty — Change and print terminal line settings
su — Execute commands with privileges of another user account
sum — Checksum and count blocks in a file
sv
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
tar
tee — Send output to multiple files
test — Built-in evaluation
time
top
touch — Update the last-modified date on the given FILE
tr — Translate or delete characters
true
tty
udhcpc — Small DHCP client
umount — Unmount file systems
uname — Display system information
uptime — Tell how long the system has been running.
uudecode
uuencode
usleep — Pause for N
vconfig — VLAN (802.1q) configuration program
vlock — Virtual Console lock program
vi — (visual) Edit FILE
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

Examples

This section does not cite any sources. Please help improve this section by adding citations to reliable sources. Unsourced material may be challenged and removed. (November 2022) (Learn how and when to remove this message)

Programs included in BusyBox can be run simply by adding their name as an argument to the BusyBox executable:

/bin/busybox ls

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

/bin/ls

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, Tiny Core Linux, SliTaz 5(Rolling), and Alpine Linux, all of which are not embedded distributions.

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 GPL-2.0-only license by former BusyBox maintainer Rob Landley as a result of the controversies around GPLv3/GPLv2 discussions. At the end of 2011 it was relicensed under the BSD-2-Clause license after the project went dormant. In March 2013, it was relicensed again under the 0BSD license. 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".

References

"Erik Andersen's Homepage". Archived from the original on June 13, 2010. Retrieved December 23, 2009.
Active Projects Archived July 29, 2010, at the Wayback Machine, Rob Landley's website
Denys Vlasenko Archived September 5, 2017, at the Wayback Machine, BusyBox maintainer
"busybox-complaint-2009-12-14" (PDF). Software Freedom Law Center. Archived from the original (PDF) on September 24, 2015. Retrieved June 30, 2022.
"BusyBox 1.36.1 (stable)".
^ "BusyBox". Archived from the original on February 24, 2018. Retrieved February 23, 2018.
"busybox-1.2.2.1.tar.bz2". Archived from the original on March 31, 2022. Retrieved June 29, 2021. From changelog: This is the last release of BusyBox under the old "GPLv2 or later" dual license. Future versions (containing changes after svn 16112) will just be GPLv2 only, without the "or later".
BitCubate X. "BusyBox Classic". Archived from the original on October 27, 2022. Retrieved August 8, 2017.
"Port details". Archived from the original on July 9, 2023. Retrieved September 27, 2024.
"The slogan for 'The Swiss Army Knife of Embedded Linux' source". Archived from the original on February 24, 2018. Retrieved February 23, 2018.
Landley, Rob. "BusyBox forensic analysis" (TXT). Archived from the original on October 25, 2021. Retrieved November 11, 2022.
^ Bruce Perens (December 15, 2009). "Statement on Busybox Lawsuits". Archived from the original on December 20, 2009.
^ Corbet, Jonathan (October 1, 2006). "Busy busy busybox". LWN.net. Archived from the original on January 7, 2016. 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. Archived from the original on September 16, 2017. 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. Archived September 14, 2016, at the Wayback Machine on lwn.net
Landley, Robert (September 30, 2006). "I'm going out now. I may be some time". busybox (Mailing list). Archived from the original on July 18, 2016. Retrieved July 21, 2016.
^ On Behalf of BusyBox Developers Andersen and Landley, SFLC Files First Ever U.S. GPL Violation Lawsuit Archived October 6, 2007, at the Wayback Machine (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 Archived December 13, 2007, at the Wayback Machine (Martin LaMonica, CNET News.com, November 21, 2007)
"Second Round of GPL Infringement Lawsuits Filed on Behalf of BusyBox Developers". Archived from the original on November 24, 2007. Retrieved November 25, 2007.
"BusyBox Developers and Xterasys Corporation Agree to Settle GPL Lawsuit". Archived from the original on December 19, 2007. Retrieved December 18, 2007.
BusyBox Developers and High-Gain Antennas Agree to Dismiss GPL Lawsuit Archived March 9, 2008, at the Wayback Machine (SFLC press release)
Gross, Grant (December 7, 2007). "Open-source legal group strikes again on BusyBox, suing Verizon". Computerworld. Archived from the original on April 6, 2024. Retrieved September 27, 2024.
"BusyBox Developers File GPL Infringement Lawsuit Against Verizon Communications". Archived from the original on December 30, 2007. Retrieved December 22, 2007.
Verizon Settles Open Source Software Lawsuit Archived March 21, 2008, at the Wayback Machine (Paul McDougell, InformationWeek, March 17, 2008)
SFLC Files Another Round of GPL Violation Lawsuits on Behalf of BusyBox Developers Archived June 11, 2008, at the Wayback Machine (SFLC press release)
BusyBox Developers and Supermicro Agree to End GPL Lawsuit: Good Faith Discussions Result in Dismissal of Copyright Infringement Case Archived July 27, 2008, at the Wayback Machine (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. Archived from the original on March 13, 2016. 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.
Andrew Nusca. "Best Buy, Samsung, Westinghouse, 11 more named in GPL lawsuit". cnet.com.
"The Software Freedom Conservancy, Inc. & Mr. Erik Andersen vs BestBuy, Samsung, Westinghouse, JVC, Western Digital, Bosch, Phoebe Micro, Humax, ..." (PDF). January 19, 2017. Archived from the original (PDF) on May 25, 2024.
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 Archived February 16, 2017, at the Wayback Machine on samygo.tv
Jones, Pamela (August 3, 2010). "BusyBox and the GPL Prevail Again - Updated 4Xs". Groklaw. Archived from the original on August 4, 2010. Retrieved September 27, 2012.
"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. Archived from the original on April 1, 2019. 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". Archived from the original on February 2, 2018. Retrieved February 23, 2018.
"BusyBox simplifies embedded Linux systems: A small toolkit for small environments". IBM. Archived from the original on December 9, 2008.
crunchgen(1) – 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. Archived (PDF) from the original on October 3, 2011. Retrieved December 5, 2011.
"BusyBox Command Help". Archived from the original on February 2, 2018. Retrieved February 24, 2013.
"Linux on the Road". Archived from the original on September 7, 2018. Retrieved August 27, 2018.
Landley, Rob. "License change commit". Toybox mercurial repository. Archived from the original on July 24, 2015. Retrieved July 24, 2015.
"Toybox news". Archived from the original on September 9, 2015. Retrieved September 14, 2015.
Landley, Rob. "Simplify license text, as mentioned on the mailing list". Toybox mercurial repository. Archived from the original on July 28, 2021. Retrieved June 29, 2021.
"Busybox replacement project". January 11, 2012. Archived from the original on February 18, 2015. Retrieved March 4, 2014.
"Garrett: The ongoing fight against GPL enforcement". LWN.net. January 31, 2012. Archived from the original on September 14, 2016. Retrieved March 4, 2014. The real problem here is that the 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. Archived from the original on September 14, 2016. 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. Archived from the original on January 7, 2016. Retrieved March 4, 2015.

External links

Official website

v t e Embedded systems
General terms	ASIC Board support package Bootloader Consumer electronics Cross compiler Embedded database Embedded hypervisor Embedded OS Embedded software FPGA IoT Memory footprint Microcontroller Single-board computer Raspberry Pi SoC
Firmware and controls	Firmware Custom firmware Proprietary firmware Closed platform Crippleware Defective by Design Hacking of consumer electronics Homebrew (video games) iOS jailbreaking PlayStation 3 Jailbreak Rooting (Android) UEFI Vendor lock-in
Boot loaders	U-Boot Barebox
Software libraries	uClibc dietlibc Embedded GLIBC lwIP musl
Programming tools	Almquist shell BitBake Buildroot BusyBox OpenEmbedded Stand-alone shell Toybox Yocto Project
Operating systems	Linux on embedded systems Linux for mobile devices Light-weight Linux distribution Real-time operating system Windows IoT Win CE
Programming languages	Ada Assembly language CAPL Embedded C Embedded C++ Embedded Java MISRA C MicroPython
Lightweight browsers List of open-source hardware Open-source robotics

Categories:

Misplaced Pages