doc/text/archive_write_format.3.txt

   1 ARCHIVE_WRITE_FORMAT(3)  BSD Library Functions Manual  ARCHIVE_WRITE_FORMAT(3)
   2
   3 1mNAME0m
   4      1marchive_write_set_format22m, 1marchive_write_set_format_7zip22m,
   5      1marchive_write_set_format_ar22m, 1marchive_write_set_format_ar_bsd22m,
   6      1marchive_write_set_format_ar_svr422m, 1marchive_write_set_format_by_name22m,
   7      1marchive_write_set_format_cpio22m, 1marchive_write_set_format_cpio_newc22m,
   8      1marchive_write_set_format_filter_by_ext22m,
   9      1marchive_write_set_format_filter_by_ext_def22m,
  10      1marchive_write_set_format_gnutar22m, 1marchive_write_set_format_iso966022m,
  11      1marchive_write_set_format_mtree22m, 1marchive_write_set_format_mtree_classic22m,
  12      1marchive_write_set_format_mtree_default22m, 1marchive_write_set_format_pax22m,
  13      1marchive_write_set_format_pax_restricted22m, 1marchive_write_set_format_raw22m,
  14      1marchive_write_set_format_shar22m, 1marchive_write_set_format_shar_dump22m,
  15      1marchive_write_set_format_ustar22m, 1marchive_write_set_format_v7tar22m,
  16      1marchive_write_set_format_warc22m, 1marchive_write_set_format_xar22m,
  17      1marchive_write_set_format_zip22m, — functions for creating archives
  18
  19 1mLIBRARY0m
  20      Streaming Archive Library (libarchive, -larchive)
  21
  22 1mSYNOPSIS0m
  23      1m#include <archive.h>0m
  24
  25      4mint0m
  26      1marchive_write_set_format22m(4mstruct24m 4marchive24m 4m*24m, 4mint24m 4mcode24m);
  27
  28      4mint0m
  29      1marchive_write_set_format_7zip22m(4mstruct24m 4marchive24m 4m*24m);
  30
  31      4mint0m
  32      1marchive_write_set_format_ar22m(4mstruct24m 4marchive24m 4m*24m);
  33
  34      4mint0m
  35      1marchive_write_set_format_ar_bsd22m(4mstruct24m 4marchive24m 4m*24m);
  36
  37      4mint0m
  38      1marchive_write_set_format_ar_svr422m(4mstruct24m 4marchive24m 4m*24m);
  39
  40      4mint0m
  41      1marchive_write_set_format_by_name22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*name24m);
  42
  43      4mint0m
  44      1marchive_write_set_format_cpio22m(4mstruct24m 4marchive24m 4m*24m);
  45
  46      4mint0m
  47      1marchive_write_set_format_cpio_newc22m(4mstruct24m 4marchive24m 4m*24m);
  48
  49      4mint0m
  50      1marchive_write_set_format_filter_by_ext22m(4mstruct24m 4marchive24m 4m*24m,
  51          4mconst24m 4mchar24m 4m*filename24m);
  52
  53      4mint0m
  54      1marchive_write_set_format_filter_by_ext_def22m(4mstruct24m 4marchive24m 4m*24m,
  55          4mconst24m 4mchar24m 4m*filename24m, 4mconst24m 4mchar24m 4m*def_ext24m);
  56
  57      4mint0m
  58      1marchive_write_set_format_gnutar22m(4mstruct24m 4marchive24m 4m*24m);
  59
  60      4mint0m
  61      1marchive_write_set_format_iso966022m(4mstruct24m 4marchive24m 4m*24m);
  62
  63      4mint0m
  64      1marchive_write_set_format_mtree22m(4mstruct24m 4marchive24m 4m*24m);
  65
  66      4mint0m
  67      1marchive_write_set_format_pax22m(4mstruct24m 4marchive24m 4m*24m);
  68
  69      4mint0m
  70      1marchive_write_set_format_pax_restricted22m(4mstruct24m 4marchive24m 4m*24m);
  71
  72      4mint0m
  73      1marchive_write_set_format_raw22m(4mstruct24m 4marchive24m 4m*24m);
  74
  75      4mint0m
  76      1marchive_write_set_format_shar22m(4mstruct24m 4marchive24m 4m*24m);
  77
  78      4mint0m
  79      1marchive_write_set_format_shar_dump22m(4mstruct24m 4marchive24m 4m*24m);
  80
  81      4mint0m
  82      1marchive_write_set_format_ustar22m(4mstruct24m 4marchive24m 4m*24m);
  83
  84      4mint0m
  85      1marchive_write_set_format_v7tar22m(4mstruct24m 4marchive24m 4m*24m);
  86
  87      4mint0m
  88      1marchive_write_set_format_warc22m(4mstruct24m 4marchive24m 4m*24m);
  89
  90      4mint0m
  91      1marchive_write_set_format_xar22m(4mstruct24m 4marchive24m 4m*24m);
  92
  93      4mint0m
  94      1marchive_write_set_format_zip22m(4mstruct24m 4marchive24m 4m*24m);
  95
  96 1mDESCRIPTION0m
  97      These functions set the format that will be used for the archive.
  98
  99      The library can write a variety of common archive formats.
 100
 101
 102      1marchive_write_set_format22m()
 103              Sets the format based on the format code (see 4marchive.h24m for the
 104              full list of format codes).  In particular, this can be used in
 105              conjunction with 1marchive_format22m() to create a new archive with
 106              the same format as an existing archive.
 107
 108      1marchive_write_set_format_by_name22m()
 109              Sets the corresponding format based on the common name.
 110
 111      1marchive_write_set_format_filter_by_ext22m(),
 112              1marchive_write_set_format_filter_by_ext_def22m()
 113              Sets both filters and format based on the output filename.  Sup‐
 114              ported extensions: .7z, .zip, .jar, .cpio, .iso, .a, .ar, .tar,
 115              .tgz, .tar.gz, .tar.bz2, .tar.xz
 116
 117      1marchive_write_set_format_7zip22m() 1marchive_write_set_format_ar_bsd22m(),
 118              1marchive_write_set_format_ar_svr422m(),
 119              1marchive_write_set_format_cpio22m()
 120              1marchive_write_set_format_cpio_newc22m()
 121              1marchive_write_set_format_gnutar22m()
 122              1marchive_write_set_format_iso966022m()
 123              1marchive_write_set_format_mtree22m()
 124              1marchive_write_set_format_mtree_classic22m()
 125              1marchive_write_set_format_pax22m()
 126              1marchive_write_set_format_pax_restricted22m()
 127              1marchive_write_set_format_raw22m() 1marchive_write_set_format_shar22m()
 128              1marchive_write_set_format_shar_dump22m()
 129              1marchive_write_set_format_ustar22m() 1marchive_write_set_format_v7tar22m()
 130              1marchive_write_set_format_warc22m() 1marchive_write_set_format_xar22m()
 131              1marchive_write_set_format_zip22m()
 132              Set the format as specified.  More details on the formats sup‐
 133              ported by libarchive can be found in the libarchive-formats(5)
 134              manual page.
 135
 136 1mRETURN VALUES0m
 137      These functions return 1mARCHIVE_OK 22mon success, or 1mARCHIVE_FATAL22m.
 138
 139 1mERRORS0m
 140      Detailed error codes and textual descriptions are available from the
 141      1marchive_errno22m() and 1marchive_error_string22m() functions.
 142
 143 1mSEE ALSO0m
 144      tar(1), libarchive(3), archive_write(3), archive_write_set_options(3),
 145      cpio(5), libarchive-formats(5), mtree(5), tar(5)
 146
 147 BSD                            February 14, 2013                           BSD