1.\" Copyright (c) 2003-2011 Tim Kientzle 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd February 28, 2017 28.Dt ARCHIVE_WRITE_DATA 3 29.Os 30.Sh NAME 31.Nm archive_write_data , 32.Nm archive_write_data_block 33.Nd functions for creating archives 34.Sh LIBRARY 35Streaming Archive Library (libarchive, -larchive) 36.Sh SYNOPSIS 37.In archive.h 38.Ft la_ssize_t 39.Fn archive_write_data "struct archive *" "const void *" "size_t" 40.Ft la_ssize_t 41.Fn archive_write_data_block "struct archive *" "const void *" "size_t size" "int64_t offset" 42.Sh DESCRIPTION 43.Bl -tag -width indent 44.It Fn archive_write_data 45Write data corresponding to the header just written. 46.It Fn archive_write_data_block 47Write data corresponding to the header just written. 48This is like 49.Fn archive_write_data 50except that it performs a seek on the file being 51written to the specified offset before writing the data. 52This is useful when restoring sparse files from archive 53formats that support sparse files. 54Returns number of bytes written or -1 on error. 55(Note: This is currently not supported for 56.Tn archive_write 57handles, only for 58.Tn archive_write_disk 59handles. 60.El 61.\" .Sh EXAMPLE 62.\" 63.Sh RETURN VALUES 64This function returns the number of bytes actually written, or 65a negative error code on error. 66.\" 67.Sh ERRORS 68Detailed error codes and textual descriptions are available from the 69.Fn archive_errno 70and 71.Fn archive_error_string 72functions. 73.\" 74.Sh BUGS 75In libarchive 3.x, this function sometimes returns 76zero on success instead of returning the number of bytes written. 77Specifically, this occurs when writing to an 78.Vt archive_write_disk 79handle. 80Clients should treat any value less than zero as an error 81and consider any non-negative value as success. 82.\" 83.Sh SEE ALSO 84.Xr tar 1 , 85.Xr archive_write_finish_entry 3 , 86.Xr archive_write_set_options 3 , 87.Xr libarchive 3 , 88.Xr cpio 5 , 89.Xr mtree 5 , 90.Xr tar 5 91