~ubuntu-branches/ubuntu/utopic/cmake/utopic

« back to all changes in this revision

Viewing changes to Utilities/cmlibarchive/libarchive/archive_write_free.3

  • Committer: Package Import Robot
  • Author(s): Harald Sitter
  • Date: 2013-10-10 12:54:39 UTC
  • mfrom: (1.14.7)
  • Revision ID: package-import@ubuntu.com-20131010125439-h0ahaj004on6oj92
Tags: 2.8.12-0ubuntu1
New upstream release LP: #1246701

Show diffs side-by-side

added added

removed removed

Lines of Context:
24
24
.\"
25
25
.\" $FreeBSD$
26
26
.\"
27
 
.Dd March 23, 2011
 
27
.Dd February 2, 2012
28
28
.Dt ARCHIVE_WRITE_FREE 3
29
29
.Os
30
30
.Sh NAME
 
31
.Nm archive_write_fail ,
31
32
.Nm archive_write_close ,
32
33
.Nm archive_write_finish ,
33
34
.Nm archive_write_free
34
35
.Nd functions for creating archives
 
36
.Sh LIBRARY
 
37
Streaming Archive Library (libarchive, -larchive)
35
38
.Sh SYNOPSIS
36
39
.In archive.h
37
40
.Ft int
 
41
.Fn archive_write_fail "struct archive *"
 
42
.Ft int
38
43
.Fn archive_write_close "struct archive *"
39
44
.Ft int
40
45
.Fn archive_write_finish "struct archive *"
42
47
.Fn archive_write_free "struct archive *"
43
48
.Sh DESCRIPTION
44
49
.Bl -tag -width indent
 
50
.It Fn archive_write_fail
 
51
Always returns
 
52
.Cm ARCHIVE_FATAL .
 
53
This marks the archive object as being unusable;
 
54
after calling this function, the only call that can succeed is
 
55
.Fn archive_write_free
 
56
to release the resources.
 
57
This can be used to speed recovery when the archive creation
 
58
must be aborted.
 
59
Note that the created archive is likely to be malformed in this case; 
45
60
.It Fn archive_write_close
46
61
Complete the archive and invoke the close callback.
47
62
.It Fn archive_write_finish