summaryrefslogtreecommitdiff
path: root/archivers/libarchive/files/doc/text/archive_write_data.3.txt
diff options
context:
space:
mode:
Diffstat (limited to 'archivers/libarchive/files/doc/text/archive_write_data.3.txt')
-rw-r--r--archivers/libarchive/files/doc/text/archive_write_data.3.txt37
1 files changed, 37 insertions, 0 deletions
diff --git a/archivers/libarchive/files/doc/text/archive_write_data.3.txt b/archivers/libarchive/files/doc/text/archive_write_data.3.txt
new file mode 100644
index 00000000000..69f4282cabc
--- /dev/null
+++ b/archivers/libarchive/files/doc/text/archive_write_data.3.txt
@@ -0,0 +1,37 @@
+ARCHIVE_WRITE_DATA(3) BSD Library Functions Manual ARCHIVE_WRITE_DATA(3)
+
+NAME
+ archive_write_data — functions for creating archives
+
+LIBRARY
+ Streaming Archive Library (libarchive, -larchive)
+
+SYNOPSIS
+ #include <archive.h>
+
+ la_ssize_t
+ archive_write_data(struct archive *, const void *, size_t);
+
+DESCRIPTION
+ Write data corresponding to the header just written.
+
+RETURN VALUES
+ This function returns the number of bytes actually written, or a negative
+ error code on error.
+
+ERRORS
+ Detailed error codes and textual descriptions are available from the
+ archive_errno() and archive_error_string() functions.
+
+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 archive_write_disk handle. Clients should
+ treat any value less than zero as an error and consider any non-negative
+ value as success.
+
+SEE ALSO
+ tar(1), libarchive(3), archive_write_finish_entry(3),
+ archive_write_set_options(3), cpio(5), mtree(5), tar(5)
+
+BSD February 2, 2012 BSD