Blame doc/man/archive_entry_time.3

Packit 08bd4c
.TH ARCHIVE_ENTRY_TIME 3 "February 2, 2012" ""
Packit 08bd4c
.SH NAME
Packit 08bd4c
.ad l
Packit 08bd4c
\fB\%archive_entry_atime\fP,
Packit 08bd4c
\fB\%archive_entry_atime_nsec\fP,
Packit 08bd4c
\fB\%archive_entry_atime_is_set\fP,
Packit 08bd4c
\fB\%archive_entry_set_atime\fP,
Packit 08bd4c
\fB\%archive_entry_unset_atime\fP,
Packit 08bd4c
\fB\%archive_entry_birthtime\fP,
Packit 08bd4c
\fB\%archive_entry_birthtime_nsec\fP,
Packit 08bd4c
\fB\%archive_entry_birthtime_is_set\fP,
Packit 08bd4c
\fB\%archive_entry_set_birthtime\fP,
Packit 08bd4c
\fB\%archive_entry_unset_birthtime\fP,
Packit 08bd4c
\fB\%archive_entry_ctime\fP,
Packit 08bd4c
\fB\%archive_entry_ctime_nsec\fP,
Packit 08bd4c
\fB\%archive_entry_ctime_is_set\fP,
Packit 08bd4c
\fB\%archive_entry_set_ctime\fP,
Packit 08bd4c
\fB\%archive_entry_unset_ctime\fP,
Packit 08bd4c
\fB\%archive_entry_mtime\fP,
Packit 08bd4c
\fB\%archive_entry_mtime_nsec\fP,
Packit 08bd4c
\fB\%archive_entry_mtime_is_set\fP,
Packit 08bd4c
\fB\%archive_entry_set_mtime\fP,
Packit 08bd4c
\fB\%archive_entry_unset_mtime\fP,
Packit 08bd4c
\- functions for manipulating times in archive entry descriptions
Packit 08bd4c
.SH LIBRARY
Packit 08bd4c
.ad l
Packit 08bd4c
Streaming Archive Library (libarchive, -larchive)
Packit 08bd4c
.SH SYNOPSIS
Packit 08bd4c
.ad l
Packit 08bd4c
\fB#include <archive_entry.h>\fP
Packit 08bd4c
.br
Packit 08bd4c
\fItime_t\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_atime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIlong\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_atime_nsec\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIint\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_atime_is_set\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_set_atime\fP(\fI\%struct\ archive_entry\ *a\fP, \fI\%time_t\ sec\fP, \fI\%long\ nanosec\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_unset_atime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fItime_t\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_birthtime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIlong\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_birthtime_nsec\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIint\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_birthtime_is_set\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_set_birthtime\fP(\fI\%struct\ archive_entry\ *a\fP, \fI\%time_t\ sec\fP, \fI\%long\ nanosec\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_unset_birthtime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fItime_t\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_ctime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIlong\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_ctime_nsec\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIint\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_ctime_is_set\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_set_ctime\fP(\fI\%struct\ archive_entry\ *a\fP, \fI\%time_t\ sec\fP, \fI\%long\ nanosec\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_unset_ctime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fItime_t\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_mtime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIlong\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_mtime_nsec\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIint\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_mtime_is_set\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_set_mtime\fP(\fI\%struct\ archive_entry\ *a\fP, \fI\%time_t\ sec\fP, \fI\%long\ nanosec\fP);
Packit 08bd4c
.br
Packit 08bd4c
\fIvoid\fP
Packit 08bd4c
.br
Packit 08bd4c
\fB\%archive_entry_unset_mtime\fP(\fI\%struct\ archive_entry\ *a\fP);
Packit 08bd4c
.SH DESCRIPTION
Packit 08bd4c
.ad l
Packit 08bd4c
These functions create and manipulate the time fields in an
Packit 08bd4c
Vt archive_entry.
Packit 08bd4c
Supported time fields are atime (access time), birthtime (creation time),
Packit 08bd4c
ctime (last time an inode property was changed) and mtime (modification time).
Packit 08bd4c
.PP
Packit 08bd4c
\fBlibarchive\fP(3)
Packit 08bd4c
provides a high-resolution interface.
Packit 08bd4c
The timestamps are truncated automatically depending on the archive format
Packit 08bd4c
(for archiving) or the filesystem capabilities (for restoring).
Packit 08bd4c
.PP
Packit 08bd4c
All timestamp fields are optional.
Packit 08bd4c
The
Packit 08bd4c
\fB\%XXX_unset\fP()
Packit 08bd4c
functions can be used to mark the corresponding field as missing.
Packit 08bd4c
The current state can be queried using
Packit 08bd4c
\fB\%XXX_is_set\fP().
Packit 08bd4c
Unset time fields have a second and nanosecond field of 0.
Packit 08bd4c
.SH SEE ALSO
Packit 08bd4c
.ad l
Packit 08bd4c
\fBarchive_entry\fP(3)
Packit 08bd4c
\fBlibarchive\fP(3),
Packit 08bd4c
.SH HISTORY
Packit 08bd4c
.ad l
Packit 08bd4c
The
Packit 08bd4c
\fB\%libarchive\fP
Packit 08bd4c
library first appeared in
Packit 08bd4c
FreeBSD 5.3.
Packit 08bd4c
.SH AUTHORS
Packit 08bd4c
.ad l
Packit 08bd4c
-nosplit
Packit 08bd4c
The
Packit 08bd4c
\fB\%libarchive\fP
Packit 08bd4c
library was written by
Packit 08bd4c
Tim Kientzle \%<kientzle@acm.org.>