doc/html/archive_write_header.3.html

   1 <!-- Creator     : groff version 1.22.3 -->
   2 <!-- CreationDate: Sun Feb 19 09:11:18 2017 -->
   3 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   4 "http://www.w3.org/TR/html4/loose.dtd">
   5 <html>
   6 <head>
   7 <meta name="generator" content="groff -Thtml, see www.gnu.org">
   8 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   9 <meta name="Content-Style" content="text/css">
  10 <style type="text/css">
  11        p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
  12        pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
  13        table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
  14        h1      { text-align: center }
  15 </style>
  16 <title></title>
  17 </head>
  18 <body>
  19
  20 <hr>
  21
  22
  23 <p>ARCHIVE_WRITE_HEADER(3) BSD Library Functions Manual
  24 ARCHIVE_WRITE_HEADER(3)</p>
  25
  26 <p style="margin-top: 1em"><b>NAME</b></p>
  27
  28 <p style="margin-left:6%;"><b>archive_write_header</b>
  29 &mdash; functions for creating archives</p>
  30
  31 <p style="margin-top: 1em"><b>LIBRARY</b></p>
  32
  33 <p style="margin-left:6%;">Streaming Archive Library
  34 (libarchive, -larchive)</p>
  35
  36 <p style="margin-top: 1em"><b>SYNOPSIS</b></p>
  37
  38 <p style="margin-left:6%;"><b>#include
  39 &lt;archive.h&gt;</b></p>
  40
  41 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  42
  43
  44 <p style="margin-left:12%;"><b>archive_write_header</b>(<i>struct&nbsp;archive&nbsp;*</i>,
  45 <i>struct&nbsp;archive_entry&nbsp;*</i>);</p>
  46
  47 <p style="margin-top: 1em"><b>DESCRIPTION</b></p>
  48
  49 <p style="margin-left:6%;">Build and write a header using
  50 the data in the provided struct archive_entry structure. See
  51 archive_entry(3) for information on creating and populating
  52 struct archive_entry objects.</p>
  53
  54 <p style="margin-top: 1em"><b>RETURN VALUES</b></p>
  55
  56 <p style="margin-left:6%;">This function returns
  57 <b>ARCHIVE_OK</b> on success, or one of the following on
  58 error: <b>ARCHIVE_RETRY</b> for operations that might
  59 succeed if retried, <b>ARCHIVE_WARN</b> for unusual
  60 conditions that do not prevent further operations, and
  61 <b>ARCHIVE_FATAL</b> for serious errors that make remaining
  62 operations impossible.</p>
  63
  64 <p style="margin-top: 1em"><b>ERRORS</b></p>
  65
  66 <p style="margin-left:6%;">Detailed error codes and textual
  67 descriptions are available from the <b>archive_errno</b>()
  68 and <b>archive_error_string</b>() functions.</p>
  69
  70 <p style="margin-top: 1em"><b>SEE ALSO</b></p>
  71
  72 <p style="margin-left:6%;">tar(1), libarchive(3),
  73 archive_write_set_options(3), cpio(5), mtree(5), tar(5)</p>
  74
  75 <p style="margin-left:6%; margin-top: 1em">BSD
  76 February&nbsp;2, 2012 BSD</p>
  77 <hr>
  78 </body>
  79 </html>