| .\" 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 other materials provided with the distribution. |
| .\" |
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
| .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| .\" SUCH DAMAGE. |
| .\" |
| .\" $FreeBSD$ |
| .\" |
| .Dd February 28, 2017 |
| .Dt ARCHIVE_WRITE_DATA 3 |
| .Os |
| .Sh NAME |
| .Nm archive_write_data , |
| .Nm archive_write_data_block |
| .Nd functions for creating archives |
| .Sh LIBRARY |
| Streaming Archive Library (libarchive, -larchive) |
| .Sh SYNOPSIS |
| .In archive.h |
| .Ft la_ssize_t |
| .Fn archive_write_data "struct archive *" "const void *" "size_t" |
| .Ft la_ssize_t |
| .Fn archive_write_data_block "struct archive *" "const void *" "size_t size" "int64_t offset" |
| .Sh DESCRIPTION |
| .Bl -tag -width indent |
| .It Fn archive_write_data |
| Write data corresponding to the header just written. |
| .It Fn archive_write_data_block |
| Write data corresponding to the header just written. |
| This is like |
| .Fn archive_write_data |
| except that it performs a seek on the file being |
| written to the specified offset before writing the data. |
| This is useful when restoring sparse files from archive |
| formats that support sparse files. |
| Returns number of bytes written or -1 on error. |
| (Note: This is currently not supported for |
| .Tn archive_write |
| handles, only for |
| .Tn archive_write_disk |
| handles. |
| .El |
| .\" .Sh EXAMPLE |
| .\" |
| .Sh RETURN VALUES |
| This function returns the number of bytes actually written, or |
| a negative error code on error. |
| .\" |
| .Sh ERRORS |
| Detailed error codes and textual descriptions are available from the |
| .Fn archive_errno |
| and |
| .Fn archive_error_string |
| functions. |
| .\" |
| .Sh BUGS |
| In libarchive 3.x, this function sometimes returns |
| zero on success instead of returning the number of bytes written. |
| Specifically, this occurs when writing to an |
| .Vt archive_write_disk |
| handle. |
| Clients should treat any value less than zero as an error |
| and consider any non-negative value as success. |
| .\" |
| .Sh SEE ALSO |
| .Xr tar 1 , |
| .Xr libarchive 3 , |
| .Xr archive_write_finish_entry 3 , |
| .Xr archive_write_set_options 3 , |
| .Xr cpio 5 , |
| .Xr mtree 5 , |
| .Xr tar 5 |
