mirror of
https://github.com/cmclark00/retro-imager.git
synced 2025-05-19 08:25:21 +01:00
227 lines
7.8 KiB
HTML
227 lines
7.8 KiB
HTML
<!-- Creator : groff version 1.22.3 -->
|
|
<!-- CreationDate: Tue Feb 11 22:58:44 2020 -->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
"http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<meta name="Content-Style" content="text/css">
|
|
<style type="text/css">
|
|
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
h1 { text-align: center }
|
|
</style>
|
|
<title></title>
|
|
</head>
|
|
<body>
|
|
|
|
<hr>
|
|
|
|
|
|
<p>ARCHIVE_READ_FORMAT(3) BSD Library Functions Manual
|
|
ARCHIVE_READ_FORMAT(3)</p>
|
|
|
|
<p style="margin-top: 1em"><b>NAME</b></p>
|
|
|
|
|
|
<p style="margin-left:6%;"><b>archive_read_support_format_7zip</b>,
|
|
<b>archive_read_support_format_all</b>,
|
|
<b>archive_read_support_format_ar</b>,
|
|
<b>archive_read_support_format_by_code</b>,
|
|
<b>archive_read_support_format_cab</b>,
|
|
<b>archive_read_support_format_cpio</b>,
|
|
<b>archive_read_support_format_empty</b>,
|
|
<b>archive_read_support_format_iso9660</b>,
|
|
<b>archive_read_support_format_lha</b>,
|
|
<b>archive_read_support_format_mtree</b>,
|
|
<b>archive_read_support_format_rar</b>,
|
|
<b>archive_read_support_format_raw</b>,
|
|
<b>archive_read_support_format_tar</b>,
|
|
<b>archive_read_support_format_xar</b>,
|
|
<b>archive_read_support_format_zip</b> — functions for
|
|
reading streaming archives</p>
|
|
|
|
<p style="margin-top: 1em"><b>LIBRARY</b></p>
|
|
|
|
<p style="margin-left:6%;">Streaming Archive Library
|
|
(libarchive, -larchive)</p>
|
|
|
|
<p style="margin-top: 1em"><b>SYNOPSIS</b></p>
|
|
|
|
<p style="margin-left:6%;"><b>#include
|
|
<archive.h></b></p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_7zip</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_all</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_ar</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_by_code</b>(<i>struct archive *</i>,
|
|
<i>int</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_cab</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_cpio</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_empty</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_iso9660</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_lha</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_mtree</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_rar</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_raw</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_tar</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_xar</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
|
|
|
|
|
|
<p style="margin-left:12%;"><b>archive_read_support_format_zip</b>(<i>struct archive *</i>);</p>
|
|
|
|
<p style="margin-top: 1em"><b>DESCRIPTION <br>
|
|
archive_read_support_format_7zip</b>(),
|
|
<b>archive_read_support_format_ar</b>(),
|
|
<b>archive_read_support_format_cab</b>(),
|
|
<b>archive_read_support_format_cpio</b>(),
|
|
<b>archive_read_support_format_iso9660</b>(),
|
|
<b>archive_read_support_format_lha</b>(),
|
|
<b>archive_read_support_format_mtree</b>(),
|
|
<b>archive_read_support_format_rar</b>(),
|
|
<b>archive_read_support_format_raw</b>(),
|
|
<b>archive_read_support_format_tar</b>(),
|
|
<b>archive_read_support_format_xar</b>(),
|
|
<b>archive_read_support_format_zip</b>()</p>
|
|
|
|
<p style="margin-left:17%;">Enables support---including
|
|
auto-detection code---for the specified archive format. For
|
|
example, <b>archive_read_support_format_tar</b>() enables
|
|
support for a variety of standard tar formats, old-style
|
|
tar, ustar, pax interchange format, and many common
|
|
variants.</p>
|
|
|
|
<p><b>archive_read_support_format_all</b>()</p>
|
|
|
|
<p style="margin-left:17%;">Enables support for all
|
|
available formats except the ’’raw’’
|
|
format (see below).</p>
|
|
|
|
<p><b>archive_read_support_format_by_code</b>()</p>
|
|
|
|
<p style="margin-left:17%;">Enables a single format
|
|
specified by the format code. This can be useful when
|
|
reading a single archive twice; use <b>archive_format</b>()
|
|
after reading the first time and pass the resulting code to
|
|
this function to selectively enable only the necessary
|
|
format support. Note: In statically-linked executables, this
|
|
will cause your program to include support for every format.
|
|
If executable size is a concern, you may wish to avoid using
|
|
this function.</p>
|
|
|
|
<p><b>archive_read_support_format_empty</b>()</p>
|
|
|
|
<p style="margin-left:17%;">Enables support for treating
|
|
empty files as empty archives. Because empty files are valid
|
|
for several different formats, it is not possible to
|
|
accurately determine a format for an empty file based purely
|
|
on contents. So empty files are treated by libarchive as a
|
|
distinct format.</p>
|
|
|
|
<p><b>archive_read_support_format_raw</b>()</p>
|
|
|
|
<p style="margin-left:17%;">The
|
|
’’raw’’ format handler allows
|
|
libarchive to be used to read arbitrary data. It treats any
|
|
data stream as an archive with a single entry. The pathname
|
|
of this entry is ’’data’’; all other
|
|
entry fields are unset. This is not enabled by
|
|
<b>archive_read_support_format_all</b>() in order to avoid
|
|
erroneous handling of damaged archives.</p>
|
|
|
|
<p style="margin-top: 1em"><b>RETURN VALUES</b></p>
|
|
|
|
<p style="margin-left:6%;">These functions return
|
|
<b>ARCHIVE_OK</b> on success, or <b>ARCHIVE_FATAL</b>.</p>
|
|
|
|
<p style="margin-top: 1em"><b>ERRORS</b></p>
|
|
|
|
<p style="margin-left:6%;">Detailed error codes and textual
|
|
descriptions are available from the <b>archive_errno</b>()
|
|
and <b>archive_error_string</b>() functions.</p>
|
|
|
|
<p style="margin-top: 1em"><b>SEE ALSO</b></p>
|
|
|
|
<p style="margin-left:6%;">tar(1), archive_read_data(3),
|
|
archive_read_filter(3), archive_read_set_options(3),
|
|
archive_util(3), libarchive(3), tar(5)</p>
|
|
|
|
<p style="margin-top: 1em"><b>BUGS</b></p>
|
|
|
|
<p style="margin-left:6%;">Many traditional archiver
|
|
programs treat empty files as valid empty archives. For
|
|
example, many implementations of tar(1) allow you to append
|
|
entries to an empty file. Of course, it is impossible to
|
|
determine the format of an empty file by inspecting the
|
|
contents, so this library treats empty files as having a
|
|
special ’’empty’’ format.</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em">Using the
|
|
’’raw’’ handler together with any
|
|
other handler will often work but can produce surprising
|
|
results.</p>
|
|
|
|
<p style="margin-left:6%; margin-top: 1em">BSD
|
|
February 2, 2012 BSD</p>
|
|
<hr>
|
|
</body>
|
|
</html>
|