Blame doc/text/archive_write_data.3.txt

Packit 08bd4c
ARCHIVE_WRITE_DATA(3)	 BSD Library Functions Manual	 ARCHIVE_WRITE_DATA(3)
Packit 08bd4c
Packit 08bd4c
NAME
Packit 08bd4c
     archive_write_data, archive_write_data_block — functions for creating ar‐
Packit 08bd4c
     chives
Packit 08bd4c
Packit 08bd4c
LIBRARY
Packit 08bd4c
     Streaming Archive Library (libarchive, -larchive)
Packit 08bd4c
Packit 08bd4c
SYNOPSIS
Packit 08bd4c
     #include <archive.h>
Packit 08bd4c
Packit 08bd4c
     la_ssize_t
Packit 08bd4c
     archive_write_data(struct archive *, const void *, size_t);
Packit 08bd4c
Packit 08bd4c
     la_ssize_t
Packit 08bd4c
     archive_write_data_block(struct archive *, const void *, size_t size,
Packit 08bd4c
	 int64_t offset);
Packit 08bd4c
Packit 08bd4c
DESCRIPTION
Packit 08bd4c
     archive_write_data()
Packit 08bd4c
	     Write data corresponding to the header just written.
Packit 08bd4c
Packit 08bd4c
     archive_write_data_block()
Packit 08bd4c
	     Write data corresponding to the header just written.  This is
Packit 08bd4c
	     like archive_write_data() except that it performs a seek on the
Packit 08bd4c
	     file being written to the specified offset before writing the
Packit 08bd4c
	     data.  This is useful when restoring sparse files from archive
Packit 08bd4c
	     formats that support sparse files.  Returns number of bytes writ‐
Packit 08bd4c
	     ten or -1 on error.  (Note: This is currently not supported for
Packit 08bd4c
	     archive_write handles, only for archive_write_disk handles.
Packit 08bd4c
Packit 08bd4c
RETURN VALUES
Packit 08bd4c
     This function returns the number of bytes actually written, or a negative
Packit 08bd4c
     error code on error.
Packit 08bd4c
Packit 08bd4c
ERRORS
Packit 08bd4c
     Detailed error codes and textual descriptions are available from the
Packit 08bd4c
     archive_errno() and archive_error_string() functions.
Packit 08bd4c
Packit 08bd4c
BUGS
Packit 08bd4c
     In libarchive 3.x, this function sometimes returns zero on success
Packit 08bd4c
     instead of returning the number of bytes written.	Specifically, this
Packit 08bd4c
     occurs when writing to an archive_write_disk handle.  Clients should
Packit 08bd4c
     treat any value less than zero as an error and consider any non-negative
Packit 08bd4c
     value as success.
Packit 08bd4c
Packit 08bd4c
SEE ALSO
Packit 08bd4c
     tar(1), libarchive(3), archive_write_finish_entry(3),
Packit 08bd4c
     archive_write_set_options(3), cpio(5), mtree(5), tar(5)
Packit 08bd4c
Packit 08bd4c
BSD			       February 28, 2017			   BSD