diff options
author | Roman Neuhauser <neuhauser@sigpipe.cz> | 2011-03-28 05:17:40 -0400 |
---|---|---|
committer | Roman Neuhauser <neuhauser@sigpipe.cz> | 2011-03-28 05:17:40 -0400 |
commit | 435c44b65ee074c8a9b19802aad5e5dee6bd3b09 (patch) | |
tree | 3e0fe4c626fa79d2604910e6e2f937db03262a59 | |
parent | 52364cbb64f581fd9e8acc0028f120e0f18b76b0 (diff) | |
download | libarchive-435c44b65ee074c8a9b19802aad5e5dee6bd3b09.tar.gz |
archive_write_data.3: archive_write_data man page
SVN-Revision: 3097
-rw-r--r-- | libarchive/archive_write.3 | 18 | ||||
-rw-r--r-- | libarchive/archive_write_data.3 | 57 |
2 files changed, 60 insertions, 15 deletions
diff --git a/libarchive/archive_write.3 b/libarchive/archive_write.3 index 08be6da2..9df773af 100644 --- a/libarchive/archive_write.3 +++ b/libarchive/archive_write.3 @@ -28,7 +28,6 @@ .Dt archive_write 3 .Os .Sh NAME -.Nm archive_write_data , .Nm archive_write_finish_entry , .Nm archive_write_close , .Nm archive_write_finish , @@ -36,8 +35,6 @@ .Nd functions for creating archives .Sh SYNOPSIS .In archive.h -.Ft ssize_t -.Fn archive_write_data "struct archive *" "const void *" "size_t" .Ft int .Fn archive_write_finish_entry "struct archive *" .Ft int @@ -74,14 +71,13 @@ See .\" .Ss Produce archive See -.Xr archive_write_header 3 . +.Xr archive_write_header 3 +and +.Xr archive_write_data 3 . .Pp The following summary describes the functions in approximately the order they are ordinarily used: .Bl -tag -width indent -.It Fn archive_write_data -Write data corresponding to the header just written. -Returns number of bytes written or -1 on error. .It Fn archive_write_finish_entry Close out the entry just written. In particular, this writes out the final padding required by some formats. @@ -294,14 +290,6 @@ and .Fn archive_error_string functions can be used to retrieve an appropriate error code and a textual error message. -.Pp -.Fn archive_write_data -returns a count of the number of bytes actually written. -On error, -1 is returned and the -.Fn archive_errno -and -.Fn archive_error_string -functions will return appropriate values. Note that if the client-provided write callback function returns a non-zero value, that error will be propagated back to the caller through whatever API function resulted in that call, which diff --git a/libarchive/archive_write_data.3 b/libarchive/archive_write_data.3 new file mode 100644 index 00000000..db7cfd8f --- /dev/null +++ b/libarchive/archive_write_data.3 @@ -0,0 +1,57 @@ +.\" 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: head/lib/libarchive/archive_write.3 201110 2009-12-28 03:31:29Z kientzle $ +.\" +.Dd March 23, 2011 +.Dt archive_write 3 +.Os +.Sh NAME +.Nm archive_write_data +.Nd functions for creating archives +.Sh SYNOPSIS +.In archive.h +.Ft ssize_t +.Fn archive_write_data "struct archive *" "const void *" "size_t" +.Sh DESCRIPTION +Write data corresponding to the header just written. +.\" .Sh EXAMPLE +.\" +.Sh RETURN VALUES +This function returns the number of bytes actually written, or +.Li -1 +on error. +.Pp +Detailed error codes and textual descriptions are available from the +.Fn archive_errno +and +.Fn archive_error_string +functions. +.Sh SEE ALSO +.Xr tar 1 , +.Xr libarchive 3 , +.Xr archive_write_set_options 3 , +.Xr cpio 5 , +.Xr mtree 5 , +.Xr tar 5 |