HOME

TheInfoList



OR:

cpio is a general
file archiver In computing, a file archiver is utility software that combines computer file, files into a single archive file or in less common cases, multiple files. A minimally designed archiver might concatenate the content of files along with file file n ...
utility and its associated
file format A file format is a Computer standard, standard way that information is encoded for storage in a computer file. It specifies how bits are used to encode information in a digital storage medium. File formats may be either proprietary format, pr ...
. It is primarily installed on
Unix-like A Unix-like (sometimes referred to as UN*X, *nix or *NIX) operating system is one that behaves in a manner similar to a Unix system, although not necessarily conforming to or being certified to any version of the Single UNIX Specification. A Uni ...
computer operating systems. The
software utility Utility software is a program specifically designed to help manage and tune system or application software. It is used to support the computer infrastructure - in contrast to application software, which is aimed at directly performing tasks that b ...
was originally intended as a tape archiving program as part of the Programmer's Workbench (
PWB/UNIX The Programmer's Workbench (PWB/UNIX) was an early, now discontinued, version of the Unix operating system that had been created in the Bell Labs Computer Science Research Group of AT&T. Its stated goal was to provide a time-sharing working envi ...
), and has been a component of virtually every Unix operating system released thereafter. Its name is derived from the phrase ''copy in and out'', in close description of the program's use of
standard input In computer programming, standard streams are preconnected input and output communication channels between a computer program and its environment when it begins execution. The three input/output (I/O) connections are called standard input (stdin), ...
and
standard output Standard may refer to: Symbols * Colours, standards and guidons, kinds of military signs * Standard (emblem), a type of a large symbol or emblem used for identification Norms, conventions or requirements * Standard (metrology), an object t ...
in its operation. All variants of Unix also support other backup and archiving programs, such as
tar Tar is a dark brown or black viscous liquid of hydrocarbons and free carbon, obtained from a wide variety of organic materials through destructive distillation. Tar can be produced from coal, wood, petroleum, or peat. "a dark brown or black b ...
, which has become more widely recognized. The use of cpio by the
RPM Package Manager RPM Package Manager (RPM) (originally Red Hat Package Manager, now a recursive acronym) is a free and open-source package management system. The name RPM refers to the file format and the package manager program itself. RPM was intended primar ...
, in the initramfs of the
Linux kernel The Linux kernel is a Free and open-source software, free and open source Unix-like kernel (operating system), kernel that is used in many computer systems worldwide. The kernel was created by Linus Torvalds in 1991 and was soon adopted as the k ...
since version 2.6, and in Apple's
Installer Installation (or setup) of a computer program (including device drivers and plugins), is the act of making the program ready for execution. Installation refers to the particular configuration of software or hardware with a view to making it usabl ...
( pax) make cpio an important archiving tool. Since its original design, cpio and its archive file format have undergone several, sometimes incompatible, revisions. Most notable is the change, now an operational option, from the use of a binary format of archive file meta information to an
ASCII ASCII ( ), an acronym for American Standard Code for Information Interchange, is a character encoding standard for representing a particular set of 95 (English language focused) printable character, printable and 33 control character, control c ...
-based representation. cpio was removed from
POSIX.1-2001 The Portable Operating System Interface (POSIX; ) is a family of standards specified by the IEEE Computer Society for maintaining compatibility between operating systems. POSIX defines application programming interfaces (APIs), along with comma ...
in favor of pax, a similar utility which had been introduced in the previous version of the standard.


History

cpio appeared in
Version 7 Unix Version 7 Unix, also called Seventh Edition Unix, Version 7 or just V7, was an important early release of the Unix operating system. V7, released in 1979, was the last Bell Laboratories release to see widespread distribution before the commerc ...
as part of the Programmer's Workbench project.


Operation and archive format

cpio was originally designed to store backup file archives on a tape device in a sequential, contiguous manner. It does not compress any content, but resulting archives are often compressed using
gzip gzip is a file format and a software application used for file compression and decompression. The program was created by Jean-loup Gailly and Mark Adler as a free software replacement for the compress program used in early Unix systems, and ...
or other external compressors.


Archive creation

When creating archives during the ''copy-out'' operation, initiated with the command line flag, cpio reads file and directory path names from its standard input channel and writes the resulting archive byte stream to its standard output. Cpio is therefore typically used with other utilities that generate the list of files to be archived, such as the find program. The resulting cpio archive is a sequence of files and directories concatenated into a single archive, separated by header sections with file meta information, such as filename, inode number, ownership, permissions, and timestamps. By convention, the file name of an archive is usually given the file extension ''cpio''. This example uses the ''find'' utility to generate a list of path names starting in the current directory to create an archive of the directory tree: $ find . -depth -print , cpio -o > /path/archive.cpio


Extraction

During the ''copy-in'' operation, initiated by the command line flag , cpio reads an archive from its standard input and recreates the archived files in the operating system's file system. $ cpio -i -vd < archive.cpio Command line flag tells cpio to construct directories as necessary. Flag (''verbose'') lists file names as they are extracted. Any remaining command line arguments other than the option flags are shell-like globbing-patterns; only files in the archive with matching names are copied from the archive. The following example extracts the file '' /etc/fstab'' from the archive: $ cpio -i -d /etc/fstab < archive.cpio


List

The files contained in a cpio archive may be listed with this invocation: $ cpio -t < archive.cpio List may be useful since a cpio archive may contain absolute rather than relative paths (e.g., ''/bin/ls'' vs. ''bin/ls'').


Copy

Cpio supports a third type of operation which copies files. It is initiated with the ''pass-through'' option flag (). This mode combines the copy-out and copy-in steps without actually creating any file archive. In this mode, cpio reads path names on standard input like the ''copy-out'' operation, but instead of creating an archive, it recreates the directories and files at a different location in the file system, as specified by the path given as a command line argument. This example copies the directory tree starting at the current directory to another path ''new-path'' in the file system, preserving files modification times (flag ), creating directories as needed (), replacing any existing files unconditionally (), while producing a progress listing on standard output (): $ find . -depth -print , cpio -p -dumv new-path


POSIX standardization

The ''cpio'' utility is standardized in
POSIX The Portable Operating System Interface (POSIX; ) is a family of standards specified by the IEEE Computer Society for maintaining compatibility between operating systems. POSIX defines application programming interfaces (APIs), along with comm ...
.1-1988, but was omitted from ''POSIX.1-2001'' because of its file size and other limitations. For example, the GNU version offers various output format options, such as "bin" (default, and obsolete) and "ustar" (POSIX tar), having a file size limitations of 2,147,483,647 bytes (2 GB) and 8,589,934,591 bytes (8 GB), respectively. The cpio, ustar, and pax file formats are defined by ''POSIX.1-2001'' for the pax utility, which is currently ''POSIX 1003.1-2008'' compliant, and so it can read and write cpio and ustar formatted archives.


Implementations

Most
Linux distribution A Linux distribution, often abbreviated as distro, is an operating system that includes the Linux kernel for its kernel functionality. Although the name does not imply product distribution per se, a distro—if distributed on its own—is oft ...
s provide the GNU version of cpio.
FreeBSD FreeBSD is a free-software Unix-like operating system descended from the Berkeley Software Distribution (BSD). The first version was released in 1993 developed from 386BSD, one of the first fully functional and free Unix clones on affordable ...
and
macOS macOS, previously OS X and originally Mac OS X, is a Unix, Unix-based operating system developed and marketed by Apple Inc., Apple since 2001. It is the current operating system for Apple's Mac (computer), Mac computers. With ...
use the BSD-licensed bsdcpio provided with
libarchive libarchive is a free and open-source library for reading and writing various archive and compression formats. It is written in C and works on most Unix-like systems and Windows. History libarchive's development was started in 2003 as part of ...
.


See also

*
List of Unix commands This is a list of the shell commands of the most recent version of the Portable Operating System Interface (POSIX) IEEE Std 1003.1-2024 which is part of the Single UNIX Specification (SUS). These commands are implemented in many shells on moder ...
*
List of archive formats This is a list of file formats used by file archiver, archivers and data compression, compressors used to create Archive file, archive files. Archive formats by purpose Archive formats are used for backups, mobility, and archiving. Many archive ...


References


External links


cpio
in The Single UNIX ® Specification, Version 2, 1997, opengroup.org – indicates applications should migrate to pax utility

in The Open Group Base Specifications Issue 6, 2004 Edition, opengroup.org – indicates cpio as removed * – 8th Edition of Bell Labs' Unix * – manual from GNU * * * * {{Archive formats 1977 software Unix archivers and compression-related utilities Free backup software Archive formats File archivers GNU Project software