archive_write_header (3)

Leading comments

Copyright (c) 2003-2011 Tim Kientzle
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or ...

(The comments found at the beginning of the groff file "man3/archive_write_header.3".)

NAME

archive_write_header - functions for creating archives

LIBRARY

Streaming Archive Library (libarchive, -larchive)

SYNOPSIS

In archive.h Ft int Fn archive_write_header struct archive * struct archive_entry *

DESCRIPTION

Build and write a header using the data in the provided struct archive_entry structure. See archive_entry3 for information on creating and populating struct archive_entry objects.

RETURN VALUES

This function returns ARCHIVE_OK on success, or one of the following on error: ARCHIVE_RETRY for operations that might succeed if retried, ARCHIVE_WARN for unusual conditions that do not prevent further operations, and ARCHIVE_FATAL for serious errors that make remaining operations impossible.

ERRORS

Detailed error codes and textual descriptions are available from the Fn archive_errno and Fn archive_error_string functions.

SEE ALSO

tar(1), libarchive(3), archive_write_set_options3, cpio(5), mtree(5), tar(5)