115 lines
4.1 KiB
Groff
115 lines
4.1 KiB
Groff
.\" 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$
|
|
.\"
|
|
.Dd February 2, 2012
|
|
.Dt ARCHIVE_WRITE_BLOCKSIZE 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm archive_write_get_bytes_per_block ,
|
|
.Nm archive_write_set_bytes_per_block ,
|
|
.Nm archive_write_get_bytes_in_last_block ,
|
|
.Nm archive_write_set_bytes_in_last_block
|
|
.Nd functions for creating archives
|
|
.Sh LIBRARY
|
|
Streaming Archive Library (libarchive, -larchive)
|
|
.Sh SYNOPSIS
|
|
.In archive.h
|
|
.Ft int
|
|
.Fn archive_write_get_bytes_per_block "struct archive *"
|
|
.Ft int
|
|
.Fn archive_write_set_bytes_per_block "struct archive *" "int bytes_per_block"
|
|
.Ft int
|
|
.Fn archive_write_get_bytes_in_last_block "struct archive *"
|
|
.Ft int
|
|
.Fn archive_write_set_bytes_in_last_block "struct archive *" "int"
|
|
.Sh DESCRIPTION
|
|
.Bl -tag -width indent
|
|
.It Fn archive_write_set_bytes_per_block
|
|
Sets the block size used for writing the archive data.
|
|
Every call to the write callback function, except possibly the last one, will
|
|
use this value for the length.
|
|
The default is to use a block size of 10240 bytes.
|
|
Note that a block size of zero will suppress internal blocking
|
|
and cause writes to be sent directly to the write callback as they occur.
|
|
.It Fn archive_write_get_bytes_per_block
|
|
Retrieve the block size to be used for writing.
|
|
A value of -1 here indicates that the library should use default values.
|
|
A value of zero indicates that internal blocking is suppressed.
|
|
.It Fn archive_write_set_bytes_in_last_block
|
|
Sets the block size used for writing the last block.
|
|
If this value is zero, the last block will be padded to the same size
|
|
as the other blocks.
|
|
Otherwise, the final block will be padded to a multiple of this size.
|
|
In particular, setting it to 1 will cause the final block to not be padded.
|
|
For compressed output, any padding generated by this option
|
|
is applied only after the compression.
|
|
The uncompressed data is always unpadded.
|
|
The default is to pad the last block to the full block size (note that
|
|
.Fn archive_write_open_filename
|
|
will set this based on the file type).
|
|
Unlike the other
|
|
.Dq set
|
|
functions, this function can be called after the archive is opened.
|
|
.It Fn archive_write_get_bytes_in_last_block
|
|
Retrieve the currently-set value for last block size.
|
|
A value of -1 here indicates that the library should use default values.
|
|
.El
|
|
.\" .Sh EXAMPLE
|
|
.Sh RETURN VALUES
|
|
.Fn archive_write_set_bytes_per_block
|
|
and
|
|
.Fn archive_write_set_bytes_in_last_block
|
|
return
|
|
.Cm ARCHIVE_OK
|
|
on success, or
|
|
.Cm ARCHIVE_FATAL .
|
|
.Pp
|
|
.Fn archive_write_get_bytes_per_block
|
|
and
|
|
.Fn archive_write_get_bytes_in_last_block
|
|
return currently configured block size
|
|
.Po
|
|
.Li -1
|
|
indicates the default block size
|
|
.Pc ,
|
|
or
|
|
.Cm ARCHIVE_FATAL .
|
|
.\"
|
|
.Sh ERRORS
|
|
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
|