Blame doc/man/archive_write_finish_entry.3

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