1 .\" Copyright (c) 2003-2011 Tim Kientzle
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
28 .Dt ARCHIVE_WRITE_OPEN 3
31 .Nm archive_write_open ,
32 .Nm archive_write_open_fd ,
33 .Nm archive_write_open_FILE ,
34 .Nm archive_write_open_filename ,
35 .Nm archive_write_open_memory
36 .Nd functions for creating archives
38 Streaming Archive Library (libarchive, -larchive)
42 .Fo archive_write_open
43 .Fa "struct archive *"
44 .Fa "void *client_data"
45 .Fa "archive_open_callback *"
46 .Fa "archive_write_callback *"
47 .Fa "archive_close_callback *"
50 .Fn archive_write_open_fd "struct archive *" "int fd"
52 .Fn archive_write_open_FILE "struct archive *" "FILE *file"
54 .Fn archive_write_open_filename "struct archive *" "const char *filename"
56 .Fo archive_write_open_memory
57 .Fa "struct archive *"
59 .Fa "size_t bufferSize"
63 .Bl -tag -width indent
64 .It Fn archive_write_open
65 Freeze the settings, open the archive, and prepare for writing entries.
66 This is the most generic form of this function, which accepts
67 pointers to three callback functions which will be invoked by
68 the compression layer to write the constructed archive.
69 .It Fn archive_write_open_fd
71 .Fn archive_write_open
72 that accepts a file descriptor.
74 .Fn archive_write_open_fd
75 function is safe for use with tape drives or other
76 block-oriented devices.
77 .It Fn archive_write_open_FILE
79 .Fn archive_write_open
84 .Fn archive_write_open_FILE
85 is not safe for writing to tape drives or other devices
86 that require correct blocking.
87 .It Fn archive_write_open_file
88 A deprecated synonym for
89 .Fn archive_write_open_filename .
90 .It Fn archive_write_open_filename
92 .Fn archive_write_open
93 that accepts a filename.
94 A NULL argument indicates that the output should be written to standard output;
97 will open a file with that name.
98 If you have not invoked
99 .Fn archive_write_set_bytes_in_last_block ,
101 .Fn archive_write_open_filename
102 will adjust the last-block padding depending on the file:
103 it will enable padding when writing to standard output or
104 to a character or block device node, it will disable padding otherwise.
105 You can override this by manually invoking
106 .Fn archive_write_set_bytes_in_last_block
108 .Fn archive_write_open .
110 .Fn archive_write_open_filename
111 function is safe for use with tape drives or other
112 block-oriented devices.
113 .It Fn archive_write_open_memory
114 A convenience form of
115 .Fn archive_write_open
116 that accepts a pointer to a block of memory that will receive
120 argument points to a variable that will be updated
121 after each write to reflect how much of the buffer
123 You should be careful to ensure that this variable
124 remains allocated until after the archive is
127 More information about the
129 object and the overall design of the library can be found in the
134 To use this library, you will need to define and register
135 callback functions that will be invoked to write data to the
137 These functions are registered by calling
138 .Fn archive_write_open :
139 .Bl -item -offset indent
142 .Fn archive_open_callback "struct archive *" "void *client_data"
145 The open callback is invoked by
146 .Fn archive_write_open .
149 if the underlying file or data source is successfully
151 If the open fails, it should call
152 .Fn archive_set_error
153 to register an error code and message and return
155 .Bl -item -offset indent
157 .Ft typedef la_ssize_t
158 .Fo archive_write_callback
159 .Fa "struct archive *"
160 .Fa "void *client_data"
161 .Fa "const void *buffer"
166 The write callback is invoked whenever the library
167 needs to write raw bytes to the archive.
168 For correct blocking, each call to the write callback function
169 should translate into a single
172 This is especially critical when writing archives to tape drives.
173 On success, the write callback should return the
174 number of bytes actually written.
175 On error, the callback should invoke
176 .Fn archive_set_error
177 to register an error code and message and return -1.
178 .Bl -item -offset indent
181 .Fn archive_close_callback "struct archive *" "void *client_data"
184 The close callback is invoked by archive_close when
185 the archive processing is complete.
186 The callback should return
189 On failure, the callback should invoke
190 .Fn archive_set_error
191 to register an error code and message and
195 Note that if the client-provided write callback function
196 returns a non-zero value, that error will be propagated back to the caller
197 through whatever API function resulted in that call, which
199 .Fn archive_write_header ,
200 .Fn archive_write_data ,
201 .Fn archive_write_close ,
202 .Fn archive_write_finish ,
204 .Fn archive_write_free .
205 The client callback can call
206 .Fn archive_set_error
207 to provide values that can then be retrieved by
210 .Fn archive_error_string .
213 These functions return
219 Detailed error codes and textual descriptions are available from the
222 .Fn archive_error_string
228 .Xr archive_write 3 ,
229 .Xr archive_write_filter 3 ,
230 .Xr archive_write_format 3 ,
231 .Xr archive_write_new 3 ,
232 .Xr archive_write_set_options 3 ,