Blame doc/man/archive_write_finish_entry.3

Packit Service 1d0348
.TH ARCHIVE_WRITE_FINISH_ENTRY 3 "February 28, 2017" ""
Packit Service 1d0348
.SH NAME
Packit Service 1d0348
.ad l
Packit Service 1d0348
\fB\%archive_write_finish_entry\fP
Packit Service 1d0348
\- functions for creating archives
Packit Service 1d0348
.SH LIBRARY
Packit Service 1d0348
.ad l
Packit Service 1d0348
Streaming Archive Library (libarchive, -larchive)
Packit Service 1d0348
.SH SYNOPSIS
Packit Service 1d0348
.ad l
Packit Service 1d0348
\fB#include <archive.h>\fP
Packit Service 1d0348
.br
Packit Service 1d0348
\fIint\fP
Packit Service 1d0348
.br
Packit Service 1d0348
\fB\%archive_write_finish_entry\fP(\fI\%struct\ archive\ *\fP);
Packit Service 1d0348
.SH DESCRIPTION
Packit Service 1d0348
.ad l
Packit Service 1d0348
Close out the entry just written.
Packit Service 1d0348
In particular, this writes out the final padding required by some formats.
Packit Service 1d0348
Ordinarily, clients never need to call this, as it
Packit Service 1d0348
is called automatically by
Packit Service 1d0348
\fB\%archive_write_header\fP()
Packit Service 1d0348
and
Packit Service 1d0348
\fB\%archive_write_close\fP()
Packit Service 1d0348
as needed.
Packit Service 1d0348
For
Packit Service 1d0348
Tn archive_write_disk
Packit Service 1d0348
handles, this flushes pending file attribute changes like modification time.
Packit Service 1d0348
.SH RETURN VALUES
Packit Service 1d0348
.ad l
Packit Service 1d0348
This function returns
Packit Service 1d0348
\fBARCHIVE_OK\fP
Packit Service 1d0348
on success, or one of several non-zero
Packit Service 1d0348
error codes for errors.
Packit Service 1d0348
Specific error codes include:
Packit Service 1d0348
\fBARCHIVE_RETRY\fP
Packit Service 1d0348
for operations that might succeed if retried,
Packit Service 1d0348
\fBARCHIVE_WARN\fP
Packit Service 1d0348
for unusual conditions that do not prevent further operations, and
Packit Service 1d0348
\fBARCHIVE_FATAL\fP
Packit Service 1d0348
for serious errors that make remaining operations impossible.
Packit Service 1d0348
.SH ERRORS
Packit Service 1d0348
.ad l
Packit Service 1d0348
Detailed error codes and textual descriptions are available from the
Packit Service 1d0348
\fB\%archive_errno\fP()
Packit Service 1d0348
and
Packit Service 1d0348
\fB\%archive_error_string\fP()
Packit Service 1d0348
functions.
Packit Service 1d0348
.SH SEE ALSO
Packit Service 1d0348
.ad l
Packit Service 1d0348
\fBtar\fP(1),
Packit Service 1d0348
\fBlibarchive\fP(3),
Packit Service 1d0348
\fBarchive_write_data\fP(3),
Packit Service 1d0348
\fBarchive_write_set_options\fP(3),
Packit Service 1d0348
\fBcpio\fP(5),
Packit Service 1d0348
\fBmtree\fP(5),
Packit Service 1d0348
\fBtar\fP(5)