summaryrefslogtreecommitdiff
path: root/libarchive/libarchive-2.8.0/doc/wiki/ManPageBsdcpio1.wiki
diff options
context:
space:
mode:
Diffstat (limited to 'libarchive/libarchive-2.8.0/doc/wiki/ManPageBsdcpio1.wiki')
-rw-r--r--libarchive/libarchive-2.8.0/doc/wiki/ManPageBsdcpio1.wiki386
1 files changed, 386 insertions, 0 deletions
diff --git a/libarchive/libarchive-2.8.0/doc/wiki/ManPageBsdcpio1.wiki b/libarchive/libarchive-2.8.0/doc/wiki/ManPageBsdcpio1.wiki
new file mode 100644
index 0000000..d3c24f5
--- /dev/null
+++ b/libarchive/libarchive-2.8.0/doc/wiki/ManPageBsdcpio1.wiki
@@ -0,0 +1,386 @@
+#summary BSDCPIO 1 manual page
+== NAME ==
+*cpio*
+- copy files to and from archives
+== SYNOPSIS ==
+<br>
+*cpio*
+{*-i*}
+`[`_options_`]`
+`[`_pattern_ ...`]`
+`[`_`<`_ archive`]`
+<br>
+*cpio*
+{*-o*}
+`[`_options_`]`
+_`<`_ name-list
+`[`_>_ archive`]`
+<br>
+*cpio*
+{*-p*}
+`[`_options_`]`
+_dest-dir_
+_`<`_ name-list
+== DESCRIPTION ==
+*cpio*
+copies files between archives and directories.
+This implementation can extract from tar, pax, cpio, zip, jar, ar,
+and ISO 9660 cdrom images and can create tar, pax, cpio, ar,
+and shar archives.
+
+The first option to
+*cpio*
+is a mode indicator from the following list:
+<dl>
+<dt>*-i*</dt><dd>
+Input.
+Read an archive from standard input (unless overriden) and extract the
+contents to disk or (if the
+*-t*
+option is specified)
+list the contents to standard output.
+If one or more file patterns are specified, only files matching
+one of the patterns will be extracted.
+</dd><dt>*-o*</dt><dd>
+Output.
+Read a list of filenames from standard input and produce a new archive
+on standard output (unless overriden) containing the specified items.
+</dd><dt>*-p*</dt><dd>
+Pass-through.
+Read a list of filenames from standard input and copy the files to the
+specified directory.
+</dd></dl>
+
+== OPTIONS ==
+Unless specifically stated otherwise, options are applicable in
+all operating modes.
+<dl>
+<dt>*-0*</dt><dd>
+Read filenames separated by NUL characters instead of newlines.
+This is necessary if any of the filenames being read might contain newlines.
+</dd><dt>*-A*</dt><dd>
+(o mode only)
+Append to the specified archive.
+(Not yet implemented.)
+</dd><dt>*-a*</dt><dd>
+(o and p modes)
+Reset access times on files after they are read.
+</dd><dt>*-B*</dt><dd>
+(o mode only)
+Block output to records of 5120 bytes.
+</dd><dt>*-C* _size_</dt><dd>
+(o mode only)
+Block output to records of
+_size_
+bytes.
+</dd><dt>*-c*</dt><dd>
+(o mode only)
+Use the old POSIX portable character format.
+Equivalent to
+*--format* _odc_.
+</dd><dt>*-d*</dt><dd>
+(i and p modes)
+Create directories as necessary.
+</dd><dt>*-E* _file_</dt><dd>
+(i mode only)
+Read list of file name patterns from
+_file_
+to list and extract.
+</dd><dt>*-F* _file_</dt><dd>
+Read archive from or write archive to
+_file_.
+</dd><dt>*-f* _pattern_</dt><dd>
+(i mode only)
+Ignore files that match
+_pattern_.
+</dd><dt>*--format* _format_</dt><dd>
+(o mode only)
+Produce the output archive in the specified format.
+Supported formats include:
+
+<dl>
+<dt>_cpio_</dt><dd>
+Synonym for
+_odc_.
+</dd><dt>_newc_</dt><dd>
+The SVR4 portable cpio format.
+</dd><dt>_odc_</dt><dd>
+The old POSIX.1 portable octet-oriented cpio format.
+</dd><dt>_pax_</dt><dd>
+The POSIX.1 pax format, an extension of the ustar format.
+</dd><dt>_ustar_</dt><dd>
+The POSIX.1 tar format.
+</dd></dl>
+
+The default format is
+_odc_.
+See
+*libarchive_formats*(5)
+for more complete information about the
+formats currently supported by the underlying
+*libarchive*(3)
+library.
+</dd><dt>*-H* _format_</dt><dd>
+Synonym for
+*--format*.
+</dd><dt>*-h*, *--help*</dt><dd>
+Print usage information.
+</dd><dt>*-I* _file_</dt><dd>
+Read archive from
+_file_.
+</dd><dt>*-i*</dt><dd>
+Input mode.
+See above for description.
+</dd><dt>*--insecure*</dt><dd>
+(i and p mode only)
+Disable security checks during extraction or copying.
+This allows extraction via symbolic links and path names containing
+Sq ..
+in the name.
+</dd><dt>*-J*</dt><dd>
+(o mode only)
+Compress the file with xz-compatible compression before writing it.
+In input mode, this option is ignored; xz compression is recognized
+automatically on input.
+</dd><dt>*-j*</dt><dd>
+Synonym for
+*-y*.
+</dd><dt>*-L*</dt><dd>
+(o and p modes)
+All symbolic links will be followed.
+Normally, symbolic links are archived and copied as symbolic links.
+With this option, the target of the link will be archived or copied instead.
+</dd><dt>*-l*</dt><dd>
+(p mode only)
+Create links from the target directory to the original files,
+instead of copying.
+</dd><dt>*-lzma*</dt><dd>
+(o mode only)
+Compress the file with lzma-compatible compression before writing it.
+In input mode, this option is ignored; lzma compression is recognized
+automatically on input.
+</dd><dt>*-m*</dt><dd>
+(i and p modes)
+Set file modification time on created files to match
+those in the source.
+</dd><dt>*-n*</dt><dd>
+(i mode, only with
+*-t*)
+Display numeric uid and gid.
+By default,
+*cpio*
+displays the user and group names when they are provided in the
+archive, or looks up the user and group names in the system
+password database.
+</dd><dt>*-no-preserve-owner*</dt><dd>
+(i mode only)
+Do not attempt to restore file ownership.
+This is the default when run by non-root users.
+</dd><dt>*-O* _file_</dt><dd>
+Write archive to
+_file_.
+</dd><dt>*-o*</dt><dd>
+Output mode.
+See above for description.
+</dd><dt>*-p*</dt><dd>
+Pass-through mode.
+See above for description.
+</dd><dt>*-preserve-owner*</dt><dd>
+(i mode only)
+Restore file ownership.
+This is the default when run by the root user.
+</dd><dt>*--quiet*</dt><dd>
+Suppress unnecessary messages.
+</dd><dt>*-R* `[`user`]``[`:`]``[`group`]`</dt><dd>
+Set the owner and/or group on files in the output.
+If group is specified with no user
+(for example,
+*-R* _:wheel_)
+then the group will be set but not the user.
+If the user is specified with a trailing colon and no group
+(for example,
+*-R* _root:_)
+then the group will be set to the user's default group.
+If the user is specified with no trailing colon, then
+the user will be set but not the group.
+In
+*-i*
+and
+*-p*
+modes, this option can only be used by the super-user.
+(For compatibility, a period can be used in place of the colon.)
+</dd><dt>*-r*</dt><dd>
+(All modes.)
+Rename files interactively.
+For each file, a prompt is written to
+_/dev/tty_
+containing the name of the file and a line is read from
+_/dev/tty_.
+If the line read is blank, the file is skipped.
+If the line contains a single period, the file is processed normally.
+Otherwise, the line is taken to be the new name of the file.
+</dd><dt>*-t*</dt><dd>
+(i mode only)
+List the contents of the archive to stdout;
+do not restore the contents to disk.
+</dd><dt>*-u*</dt><dd>
+(i and p modes)
+Unconditionally overwrite existing files.
+Ordinarily, an older file will not overwrite a newer file on disk.
+</dd><dt>*-v*</dt><dd>
+Print the name of each file to stderr as it is processed.
+With
+*-t*,
+provide a detailed listing of each file.
+</dd><dt>*--version*</dt><dd>
+Print the program version information and exit.
+</dd><dt>*-y*</dt><dd>
+(o mode only)
+Compress the archive with bzip2-compatible compression before writing it.
+In input mode, this option is ignored;
+bzip2 compression is recognized automatically on input.
+</dd><dt>*-Z*</dt><dd>
+(o mode only)
+Compress the archive with compress-compatible compression before writing it.
+In input mode, this option is ignored;
+compression is recognized automatically on input.
+</dd><dt>*-z*</dt><dd>
+(o mode only)
+Compress the archive with gzip-compatible compression before writing it.
+In input mode, this option is ignored;
+gzip compression is recognized automatically on input.
+</dd></dl>
+== ENVIRONMENT ==
+The following environment variables affect the execution of
+*cpio*:
+<dl>
+<dt>*LANG*
+The locale to use.
+See
+*environ*(7)
+for more information.
+</dt><dt>*TZ*
+The timezone to use when displaying dates.
+See
+*environ*(7)
+for more information.
+</dt></dl>
+== EXIT STATUS ==
+The *cpio* utility exits 0 on success, and >0 if an error occurs.
+== EXAMPLES ==
+The
+*cpio*
+command is traditionally used to copy file heirarchies in conjunction
+with the
+*find*(1)
+command.
+The first example here simply copies all files from
+_src_
+to
+_dest_:
+{{{
+find src | cpio -pmud dest
+}}}
+
+By carefully selecting options to the
+*find*(1)
+command and combining it with other standard utilities,
+it is possible to exercise very fine control over which files are copied.
+This next example copies files from
+_src_
+to
+_dest_
+that are more than 2 days old and whose names match a particular pattern:
+{{{
+find src -mtime _+2_ | grep foo[bar] | cpio -pdmu dest
+}}}
+
+This example copies files from
+_src_
+to
+_dest_
+that are more than 2 days old and which contain the word
+"foobar":
+{{{
+find src -mtime _+2_ | xargs grep -l foobar | cpio -pdmu dest
+}}}
+== COMPATIBILITY ==
+The mode options i, o, and p and the options
+a, B, c, d, f, l, m, r, t, u, and v comply with SUSv2.
+
+The old POSIX.1 standard specified that only
+*-i*,
+*-o*,
+and
+*-p*
+were interpreted as command-line options.
+Each took a single argument of a list of modifier
+characters.
+For example, the standard syntax allows
+*-imu*
+but does not support
+*-miu*
+or
+*-i* *-m* *-u*,
+since
+_m_
+and
+_u_
+are only modifiers to
+*-i*,
+they are not command-line options in their own right.
+The syntax supported by this implementation is backwards-compatible
+with the standard.
+For best compatibility, scripts should limit themselves to the
+standard syntax.
+== SEE ALSO ==
+*bzip2*(1),
+*tar*(1),
+*gzip*(1),
+*mt*(1),
+*pax*(1),
+*libarchive*(3),
+*cpio*(5),
+*libarchive-formats*(5),
+*tar*(5)
+== STANDARDS ==
+There is no current POSIX standard for the cpio command; it appeared
+in
+ISO/IEC 9945-1:1996 (``POSIX.1'')
+but was dropped from
+IEEE Std 1003.1-2001 (``POSIX.1'').
+
+The cpio, ustar, and pax interchange file formats are defined by
+IEEE Std 1003.1-2001 (``POSIX.1'')
+for the pax command.
+== HISTORY ==
+The original
+*cpio*
+and
+*find*
+utilities were written by Dick Haight
+while working in AT&T's Unix Support Group.
+They first appeared in 1977 in PWB/UNIX 1.0, the
+"Programmer's Work Bench"
+system developed for use within AT&T.
+They were first released outside of AT&T as part of System III Unix in 1981.
+As a result,
+*cpio*
+actually predates
+*tar*,
+even though it was not well-known outside of AT&T until some time later.
+
+This is a complete re-implementation based on the
+*libarchive*(3)
+library.
+== BUGS ==
+The cpio archive format has several basic limitations:
+It does not store user and group names, only numbers.
+As a result, it cannot be reliably used to transfer
+files between systems with dissimilar user and group numbering.
+Older cpio formats limit the user and group numbers to
+16 or 18 bits, which is insufficient for modern systems.
+The cpio archive formats cannot support files over 4 gigabytes,
+except for the
+"odc"
+variant, which can support files up to 8 gigabytes.