Correct the spelling of archive_write_set_format_shar_dump()

and update the documentation to reflect the new add_filter
naming.

SVN-Revision: 3023

diff --git a/libarchive/archive_write.3 b/libarchive/archive_write.3
index 245ddb92f17a6cab08ccac1cc3f49c5c436190ef..edfb75ca511238ffef68888bef0c1649cf9b56c8 100644 (file)
--- a/libarchive/archive_write.3
+++ b/libarchive/archive_write.3
@@ -33,16 +33,19 @@
 .Nm archive_write_set_format_pax ,
 .Nm archive_write_set_format_pax_restricted ,
 .Nm archive_write_set_format_shar ,
-.Nm archive_write_set_format_shar_binary ,
+.Nm archive_write_set_format_shar_dump ,
 .Nm archive_write_set_format_ustar ,
 .Nm archive_write_get_bytes_per_block ,
 .Nm archive_write_set_bytes_per_block ,
 .Nm archive_write_set_bytes_in_last_block ,
-.Nm archive_write_set_compression_bzip2 ,
-.Nm archive_write_set_compression_compress ,
-.Nm archive_write_set_compression_gzip ,
-.Nm archive_write_set_compression_none ,
-.Nm archive_write_set_compression_program ,
+.Nm archive_write_add_filter_bzip2 ,
+.Nm archive_write_add_filter_compress ,
+.Nm archive_write_add_filter_gzip ,
+.Nm archive_write_add_filter_lzip ,
+.Nm archive_write_add_filter_lzma ,
+.Nm archive_write_add_filter_none ,
+.Nm archive_write_add_filter_program ,
+.Nm archive_write_add_filter_xz ,
 .Nm archive_write_open ,
 .Nm archive_write_open_fd ,
 .Nm archive_write_open_FILE ,
@@ -66,15 +69,21 @@
 .Ft int
 .Fn archive_write_set_bytes_in_last_block "struct archive *" "int"
 .Ft int
-.Fn archive_write_set_compression_bzip2 "struct archive *"
+.Fn archive_write_add_filter_bzip2 "struct archive *"
 .Ft int
-.Fn archive_write_set_compression_compress "struct archive *"
+.Fn archive_write_add_filter_compress "struct archive *"
 .Ft int
-.Fn archive_write_set_compression_gzip "struct archive *"
+.Fn archive_write_add_filter_gzip "struct archive *"
 .Ft int
-.Fn archive_write_set_compression_none "struct archive *"
+.Fn archive_write_add_filter_lzip "struct archive *"
 .Ft int
-.Fn archive_write_set_compression_program "struct archive *" "const char * cmd"
+.Fn archive_write_add_filter_lzma "struct archive *"
+.Ft int
+.Fn archive_write_add_filter_none "struct archive *"
+.Ft int
+.Fn archive_write_add_filter_program "struct archive *" "const char * cmd"
+.Ft int
+.Fn archive_write_add_filter_xz "struct archive *"
 .Ft int
 .Fn archive_write_set_format_cpio "struct archive *"
 .Ft int
@@ -84,7 +93,7 @@
 .Ft int
 .Fn archive_write_set_format_shar "struct archive *"
 .Ft int
-.Fn archive_write_set_format_shar_binary "struct archive *"
+.Fn archive_write_set_format_shar_dump "struct archive *"
 .Ft int
 .Fn archive_write_set_format_ustar "struct archive *"
 .Ft int
@@ -172,7 +181,7 @@ A value of -1 here indicates that the library should use default values.
 .Fn archive_write_set_format_pax ,
 .Fn archive_write_set_format_pax_restricted ,
 .Fn archive_write_set_format_shar ,
-.Fn archive_write_set_format_shar_binary ,
+.Fn archive_write_set_format_shar_dump ,
 .Fn archive_write_set_format_ustar
 .Xc
 Sets the format that will be used for the archive.
@@ -185,7 +194,7 @@ traditional
 .Dq shar
 archives,
 enhanced
-.Dq binary
+.Dq dump
 shar archives that store a variety of file attributes and handle binary files,
 and
 POSIX-standard
@@ -199,14 +208,19 @@ is the library default; this is the same as pax format, but suppresses
 the pax extended header for most normal files.
 In most cases, this will result in ordinary ustar archives.
 .It Xo
-.Fn archive_write_set_compression_bzip2 ,
-.Fn archive_write_set_compression_compress ,
-.Fn archive_write_set_compression_gzip ,
-.Fn archive_write_set_compression_none
+.Fn archive_write_add_filter_bzip2 ,
+.Fn archive_write_add_filter_compress ,
+.Fn archive_write_add_filter_gzip ,
+.Fn archive_write_add_filter_lzip ,
+.Fn archive_write_add_filter_lzma ,
+.Fn archive_write_add_filter_xz ,
 .Xc
 The resulting archive will be compressed as specified.
 Note that the compressed output is always properly blocked.
-.It Fn archive_write_set_compression_program
+.It Fn archive_write_add_filter_none
+This is never necessary.
+It is provided only for backwards compatibility.
+.It Fn archive_write_add_filter_program
 The archive will be fed into the specified compression program.
 The output of that program is blocked and written to the client
 write callbacks.
@@ -446,7 +460,7 @@ write_archive(const char *outname, const char **filename)
 
   a = archive_write_new();
   mydata->name = outname;
-  archive_write_set_compression_gzip(a);
+  archive_write_add_filter_gzip(a);
   archive_write_set_format_ustar(a);
   archive_write_open(a, mydata, myopen, mywrite, myclose);
   while (*filename) {