components/libarchive/patches/libarchive-archive_read.3.patch
author John Beck <John.Beck@Oracle.COM>
Tue, 28 May 2013 11:52:39 -0700
changeset 1316 22b5cf35a3ea
permissions -rw-r--r--
PSARC 2012/356 libarchive 15959922 add libarchive to Userland
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1316
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     1
This patch is needed to convert BSD-style section numbers to Solaris-style
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     2
section numbers.  It has not been fed back to the upstream community.  It
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     3
may need to be tweaked slightly for future releases.
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     4
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     5
--- libarchive/libarchive/archive_read.3.orig	Mon Mar 26 19:49:00 2012
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     6
+++ libarchive/libarchive/archive_read.3	Fri Nov  9 12:42:17 2012
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     7
@@ -25,7 +25,7 @@
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     8
 .\" $FreeBSD$
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     9
 .\"
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    10
 .Dd February 2, 2012
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    11
-.Dt ARCHIVE_READ 3
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    12
+.Dt ARCHIVE_READ 3ARCHIVE
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    13
 .Os
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    14
 .Sh NAME
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    15
 .Nm archive_read
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    16
@@ -44,7 +44,7 @@
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    17
 .\"
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    18
 .Ss Create archive object
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    19
 See
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    20
-.Xr archive_read_new 3 .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    21
+.Xr archive_read_new 3ARCHIVE .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    22
 .Pp
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    23
 To read an archive, you must first obtain an initialized
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    24
 .Tn struct archive
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    25
@@ -53,9 +53,9 @@
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    26
 .\"
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    27
 .Ss Enable filters and formats
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    28
 See
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    29
-.Xr archive_read_filter 3
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    30
+.Xr archive_read_filter 3ARCHIVE
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    31
 and
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    32
-.Xr archive_read_format 3 .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    33
+.Xr archive_read_format 3ARCHIVE .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    34
 .Pp
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    35
 You can then modify this object for the desired operations with the
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    36
 various
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    37
@@ -80,11 +80,11 @@
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    38
 .\"
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    39
 .Ss Set options
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    40
 See
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    41
-.Xr archive_read_set_options 3 .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    42
+.Xr archive_read_set_options 3ARCHIVE .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    43
 .\"
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    44
 .Ss Open archive
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    45
 See
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    46
-.Xr archive_read_open 3 .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    47
+.Xr archive_read_open 3ARCHIVE .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    48
 .Pp
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    49
 Once you have prepared the
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    50
 .Tn struct archive
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    51
@@ -105,10 +105,10 @@
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    52
 .\"
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    53
 .Ss Consume archive
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    54
 See
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    55
-.Xr archive_read_header 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    56
-.Xr archive_read_data 3
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    57
+.Xr archive_read_header 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    58
+.Xr archive_read_data 3ARCHIVE
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    59
 and
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    60
-.Xr archive_read_extract 3 .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    61
+.Xr archive_read_extract 3ARCHIVE .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    62
 .Pp
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    63
 Each archive entry consists of a header followed by a certain
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    64
 amount of data.
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    65
@@ -146,7 +146,7 @@
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    66
 .\"
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    67
 .Ss Release resources
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    68
 See
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    69
-.Xr archive_read_free 3 .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    70
+.Xr archive_read_free 3ARCHIVE .
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    71
 .Pp
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    72
 Once you have finished reading data from the archive, you
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    73
 should call
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    74
@@ -217,17 +217,16 @@
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    75
 .\" .Sh ERRORS
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    76
 .Sh SEE ALSO
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    77
 .Xr tar 1 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    78
-.Xr libarchive 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    79
-.Xr archive_read_new 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    80
-.Xr archive_read_data 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    81
-.Xr archive_read_extract 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    82
-.Xr archive_read_filter 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    83
-.Xr archive_read_format 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    84
-.Xr archive_read_header 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    85
-.Xr archive_read_open 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    86
-.Xr archive_read_set_options 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    87
-.Xr archive_util 3 ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    88
-.Xr tar 5
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    89
+.Xr libarchive 3LIB ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    90
+.Xr archive_read_new 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    91
+.Xr archive_read_data 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    92
+.Xr archive_read_extract 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    93
+.Xr archive_read_filter 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    94
+.Xr archive_read_format 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    95
+.Xr archive_read_header 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    96
+.Xr archive_read_open 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    97
+.Xr archive_read_set_options 3ARCHIVE ,
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    98
+.Xr archive_util 3ARCHIVE
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    99
 .Sh HISTORY
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   100
 The
22b5cf35a3ea PSARC 2012/356 libarchive
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   101
 .Nm libarchive