Imported Upstream version 3.3.1
[platform/upstream/libarchive.git] / doc / html / archive_entry_time.3.html
1 <!-- Creator     : groff version 1.22.3 -->
2 <!-- CreationDate: Sat Feb 25 11:22:02 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_ENTRY_TIME(3) BSD Library Functions Manual
24 ARCHIVE_ENTRY_TIME(3)</p>
25
26 <p style="margin-top: 1em"><b>NAME</b></p>
27
28 <p style="margin-left:6%;"><b>archive_entry_atime</b>,
29 <b>archive_entry_atime_nsec</b>,
30 <b>archive_entry_atime_is_set</b>,
31 <b>archive_entry_set_atime</b>,
32 <b>archive_entry_unset_atime</b>,
33 <b>archive_entry_birthtime</b>,
34 <b>archive_entry_birthtime_nsec</b>,
35 <b>archive_entry_birthtime_is_set</b>,
36 <b>archive_entry_set_birthtime</b>,
37 <b>archive_entry_unset_birthtime</b>,
38 <b>archive_entry_ctime</b>, <b>archive_entry_ctime_nsec</b>,
39 <b>archive_entry_ctime_is_set</b>,
40 <b>archive_entry_set_ctime</b>,
41 <b>archive_entry_unset_ctime</b>,
42 <b>archive_entry_mtime</b>, <b>archive_entry_mtime_nsec</b>,
43 <b>archive_entry_mtime_is_set</b>,
44 <b>archive_entry_set_mtime</b>,
45 <b>archive_entry_unset_mtime</b>, &mdash; functions for
46 manipulating times in archive entry descriptions</p>
47
48 <p style="margin-top: 1em"><b>LIBRARY</b></p>
49
50 <p style="margin-left:6%;">Streaming Archive Library
51 (libarchive, -larchive)</p>
52
53 <p style="margin-top: 1em"><b>SYNOPSIS</b></p>
54
55 <p style="margin-left:6%;"><b>#include
56 &lt;archive_entry.h&gt;</b></p>
57
58
59 <p style="margin-left:6%; margin-top: 1em"><i>time_t</i></p>
60
61
62 <p style="margin-left:12%;"><b>archive_entry_atime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
63
64 <p style="margin-left:6%; margin-top: 1em"><i>long</i></p>
65
66
67 <p style="margin-left:12%;"><b>archive_entry_atime_nsec</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
68
69 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
70
71
72 <p style="margin-left:12%;"><b>archive_entry_atime_is_set</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
73
74 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
75
76
77 <p style="margin-left:12%;"><b>archive_entry_set_atime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
78 <i>time_t&nbsp;sec</i>, <i>long&nbsp;nanosec</i>);</p>
79
80 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
81
82
83 <p style="margin-left:12%;"><b>archive_entry_unset_atime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
84
85
86 <p style="margin-left:6%; margin-top: 1em"><i>time_t</i></p>
87
88
89 <p style="margin-left:12%;"><b>archive_entry_birthtime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
90
91 <p style="margin-left:6%; margin-top: 1em"><i>long</i></p>
92
93
94 <p style="margin-left:12%;"><b>archive_entry_birthtime_nsec</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
95
96 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
97
98
99 <p style="margin-left:12%;"><b>archive_entry_birthtime_is_set</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
100
101 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
102
103
104 <p style="margin-left:12%;"><b>archive_entry_set_birthtime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
105 <i>time_t&nbsp;sec</i>, <i>long&nbsp;nanosec</i>);</p>
106
107 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
108
109
110 <p style="margin-left:12%;"><b>archive_entry_unset_birthtime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
111
112
113 <p style="margin-left:6%; margin-top: 1em"><i>time_t</i></p>
114
115
116 <p style="margin-left:12%;"><b>archive_entry_ctime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
117
118 <p style="margin-left:6%; margin-top: 1em"><i>long</i></p>
119
120
121 <p style="margin-left:12%;"><b>archive_entry_ctime_nsec</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
122
123 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
124
125
126 <p style="margin-left:12%;"><b>archive_entry_ctime_is_set</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
127
128 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
129
130
131 <p style="margin-left:12%;"><b>archive_entry_set_ctime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
132 <i>time_t&nbsp;sec</i>, <i>long&nbsp;nanosec</i>);</p>
133
134 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
135
136
137 <p style="margin-left:12%;"><b>archive_entry_unset_ctime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
138
139
140 <p style="margin-left:6%; margin-top: 1em"><i>time_t</i></p>
141
142
143 <p style="margin-left:12%;"><b>archive_entry_mtime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
144
145 <p style="margin-left:6%; margin-top: 1em"><i>long</i></p>
146
147
148 <p style="margin-left:12%;"><b>archive_entry_mtime_nsec</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
149
150 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
151
152
153 <p style="margin-left:12%;"><b>archive_entry_mtime_is_set</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
154
155 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
156
157
158 <p style="margin-left:12%;"><b>archive_entry_set_mtime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
159 <i>time_t&nbsp;sec</i>, <i>long&nbsp;nanosec</i>);</p>
160
161 <p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
162
163
164 <p style="margin-left:12%;"><b>archive_entry_unset_mtime</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
165
166 <p style="margin-top: 1em"><b>DESCRIPTION</b></p>
167
168 <p style="margin-left:6%;">These functions create and
169 manipulate the time fields in an <i>archive_entry</i>.
170 Supported time fields are atime (access time), birthtime
171 (creation time), ctime (last time an inode property was
172 changed) and mtime (modification time).</p>
173
174 <p style="margin-left:6%; margin-top: 1em">libarchive(3)
175 provides a high-resolution interface. The timestamps are
176 truncated automatically depending on the archive format (for
177 archiving) or the filesystem capabilities (for
178 restoring).</p>
179
180 <p style="margin-left:6%; margin-top: 1em">All timestamp
181 fields are optional. The <b>XXX_unset</b>() functions can be
182 used to mark the corresponding field as missing. The current
183 state can be queried using <b>XXX_is_set</b>(). Unset time
184 fields have a second and nanosecond field of 0.</p>
185
186 <p style="margin-top: 1em"><b>SEE ALSO</b></p>
187
188 <p style="margin-left:6%;">archive_entry(3)
189 libarchive(3),</p>
190
191 <p style="margin-top: 1em"><b>HISTORY</b></p>
192
193 <p style="margin-left:6%;">The <b>libarchive</b> library
194 first appeared in FreeBSD&nbsp;5.3.</p>
195
196 <p style="margin-top: 1em"><b>AUTHORS</b></p>
197
198 <p style="margin-left:6%;">The <b>libarchive</b> library
199 was written by Tim Kientzle &lt;kientzle@acm.org&gt;.</p>
200
201 <p style="margin-left:6%; margin-top: 1em">BSD
202 February&nbsp;2, 2012 BSD</p>
203 <hr>
204 </body>
205 </html>