summaryrefslogtreecommitdiff
path: root/libarchive/archive_write.3
diff options
context:
space:
mode:
authorRoman Neuhauser <neuhauser@sigpipe.cz>2011-03-28 05:17:27 -0400
committerRoman Neuhauser <neuhauser@sigpipe.cz>2011-03-28 05:17:27 -0400
commitbefc8c63c657c4e483d87e7f7bf99ffca26198c0 (patch)
tree9cac02d8c26d7f14bd28f243746d3f331bf288a1 /libarchive/archive_write.3
parent8fad8d05300852f55ae7dcf00d85d704d0eba87f (diff)
downloadlibarchive-befc8c63c657c4e483d87e7f7bf99ffca26198c0.tar.gz
archive_write_open.3: archive_write_open et al
SVN-Revision: 3095
Diffstat (limited to 'libarchive/archive_write.3')
-rw-r--r--libarchive/archive_write.392
1 files changed, 4 insertions, 88 deletions
diff --git a/libarchive/archive_write.3 b/libarchive/archive_write.3
index 2e53bae4..c23ab802 100644
--- a/libarchive/archive_write.3
+++ b/libarchive/archive_write.3
@@ -28,11 +28,6 @@
.Dt archive_write 3
.Os
.Sh NAME
-.Nm archive_write_open ,
-.Nm archive_write_open_fd ,
-.Nm archive_write_open_FILE ,
-.Nm archive_write_open_filename ,
-.Nm archive_write_open_memory ,
.Nm archive_write_header ,
.Nm archive_write_data ,
.Nm archive_write_finish_entry ,
@@ -43,27 +38,6 @@
.Sh SYNOPSIS
.In archive.h
.Ft int
-.Fo archive_write_open
-.Fa "struct archive *"
-.Fa "void *client_data"
-.Fa "archive_open_callback *"
-.Fa "archive_write_callback *"
-.Fa "archive_close_callback *"
-.Fc
-.Ft int
-.Fn archive_write_open_fd "struct archive *" "int fd"
-.Ft int
-.Fn archive_write_open_FILE "struct archive *" "FILE *file"
-.Ft int
-.Fn archive_write_open_filename "struct archive *" "const char *filename"
-.Ft int
-.Fo archive_write_open_memory
-.Fa "struct archive *"
-.Fa "void *buffer"
-.Fa "size_t bufferSize"
-.Fa "size_t *outUsed"
-.Fc
-.Ft int
.Fn archive_write_header "struct archive *" "struct archive_entry *"
.Ft ssize_t
.Fn archive_write_data "struct archive *" "const void *" "size_t"
@@ -96,72 +70,14 @@ and
.Ss Configure block size and padding
See
.Xr archive_write_blocksize 3 .
+.\"
+.Ss Open archive
+See
+.Xr archive_write_open 3 .
.Pp
The following summary describes the functions in approximately
the order they are ordinarily used:
.Bl -tag -width indent
-.It Fn archive_write_open
-Freeze the settings, open the archive, and prepare for writing entries.
-This is the most generic form of this function, which accepts
-pointers to three callback functions which will be invoked by
-the compression layer to write the constructed archive.
-.It Fn archive_write_open_fd
-A convenience form of
-.Fn archive_write_open
-that accepts a file descriptor.
-The
-.Fn archive_write_open_fd
-function is safe for use with tape drives or other
-block-oriented devices.
-.It Fn archive_write_open_FILE
-A convenience form of
-.Fn archive_write_open
-that accepts a
-.Ft "FILE *"
-pointer.
-Note that
-.Fn archive_write_open_FILE
-is not safe for writing to tape drives or other devices
-that require correct blocking.
-.It Fn archive_write_open_file
-A deprecated synonym for
-.Fn archive_write_open_filename .
-.It Fn archive_write_open_filename
-A convenience form of
-.Fn archive_write_open
-that accepts a filename.
-A NULL argument indicates that the output should be written to standard output;
-an argument of
-.Dq -
-will open a file with that name.
-If you have not invoked
-.Fn archive_write_set_bytes_in_last_block ,
-then
-.Fn archive_write_open_filename
-will adjust the last-block padding depending on the file:
-it will enable padding when writing to standard output or
-to a character or block device node, it will disable padding otherwise.
-You can override this by manually invoking
-.Fn archive_write_set_bytes_in_last_block
-before calling
-.Fn archive_write_open .
-The
-.Fn archive_write_open_filename
-function is safe for use with tape drives or other
-block-oriented devices.
-.It Fn archive_write_open_memory
-A convenience form of
-.Fn archive_write_open
-that accepts a pointer to a block of memory that will receive
-the archive.
-The final
-.Ft "size_t *"
-argument points to a variable that will be updated
-after each write to reflect how much of the buffer
-is currently in use.
-You should be careful to ensure that this variable
-remains allocated until after the archive is
-closed.
.It Fn archive_write_header
Build and write a header using the data in the provided
.Tn struct archive_entry