doc/th_set_from_stat.3

   1 .TH th_set_from_stat 3 "Jan 2001" "University of Illinois" "C Library Calls"
   2 .SH NAME
   3 th_set_from_stat, th_finish, th_set_type, th_set_path, th_set_link, th_set_device, th_set_user, th_set_group, th_set_mode, th_set_mtime, th_set_size \- set fields of a tar file header
   4 .SH SYNOPSIS
   5 .B #include <libtar.h>
   6 .P
   7 .BI "void th_set_from_stat(TAR *" t ", struct stat *" s ");"
   8
   9 .BI "void th_set_type(TAR *" t ", mode_t " mode ");"
  10
  11 .BI "void th_set_path(TAR *" t ", char *" pathname ");"
  12
  13 .BI "void th_set_link(TAR *" t ", char *" linkname ");"
  14
  15 .BI "void th_set_device(TAR *" t ", dev_t " device ");"
  16
  17 .BI "void th_set_user(TAR *" t ", uid_t " uid ");"
  18
  19 .BI "void th_set_group(TAR *" t ", gid_t " gid ");"
  20
  21 .BI "void th_set_mode(TAR *" t ", mode_t " mode ");"
  22
  23 .BI "void th_set_mtime(TAR *" t ", time_t " fmtime ");"
  24
  25 .BI "void th_set_size(TAR *" t ", off_t " fsize ");"
  26
  27 .BI "void th_finish(TAR *" t ");"
  28 .SH VERSION
  29 This man page documents version 1.2 of \fBlibtar\fP.
  30 .SH DESCRIPTION
  31 The \fBth_set_*\fP() functions each set an individual field of the
  32 current tar header associated with the \fITAR\fP handle \fIt\fP.  The
  33 \fBth_set_user\fP() and \fBth_set_group\fP() functions set both the
  34 numeric user/group ID fields and the user/group name text fields.
  35 The other functions set only the field that they refer to.
  36
  37 The \fBth_set_from_stat\fP() function uses the other \fBth_set_*\fP()
  38 functions to set all of the fields at once, based on the data passed to
  39 it in the argument \fIs\fP.
  40
  41 The \fBth_finish\fP() function sets the appropriate constants for the
  42 magic and version fields.  It then calculates the header checksum and
  43 fills in the checksum field.
  44 .SH SEE ALSO
  45 .BR lstat (2)