Print this page
13111 Want futimes() and lutimes() functions
Change-ID: I3be82d4242255a4100f8c35db373eb9140402fc4
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/prototypes/prototype.man3x
+++ new/usr/src/prototypes/prototype.man3x
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 4 .\" You may only use this file in accordance with the terms of version
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
12 12 .\" Copyright 2020 <contributor>
13 13 .\"
14 14 .Dd Month Day, Year
15 15 .Dt MANUALPAGE 3SECTION
16 16 .\" MANUALPAGE should be replaced with the primary function that you are
17 17 .\" documenting. If there is more than one function, then you should either
18 18 .\" use the primary function of the group or a more general name. Every
19 19 .\" documented function will appear in the NAME section below.
20 20 .\"
21 21 .\" The SECTION generally refers to the name of the library that this
22 22 .\" appears in. For example for something in libc this would be 3C. In
23 23 .\" general this is the capitalized version of the libraries shared
24 24 .\" object name.
25 25 .Os
26 26 .Sh NAME
27 27 .Nm funcname ,
28 28 .Nm funcname2
29 29 .Nd short description
30 30 .Sh LIBRARY
31 31 .Lb libname
32 32 .Sh SYNOPSIS
33 33 .\" Insert any required pre-processor macros with Dv
34 34 .\" .In headerfile.h
35 35 .\" .Ft return type
36 36 .\" .Fo function name
37 37 .\" .Fa "func arg 0 type and name"
38 38 .\" .Fa "func arg 1 type and name"
39 39 .\" .Fc
40 40 .\" Repeat above for each function
41 41 .Sh DESCRIPTION
42 42 .\" Describe how the functions operate and what they do. Provide
43 43 .\" background for the reader. Don't assume that they know how
44 44 .\" everything works. Be clear about the semantics and the why.
45 45 .Sh RETURN VALUES
46 46 Upon successful completion, the
47 47 .Fn funcname
48 48 function returns XXX and <state side effects>. Otherwise XXX is returned
49 49 and <if errno is set describe it below>.
50 50 .Sh EXAMPLES
51 51 .Sh ERRORS
↓ open down ↓ |
51 lines elided |
↑ open up ↑ |
52 52 The
53 53 .fn funcname
54 54 functions will fail if:
55 55 .Bl -tag -width Er
56 56 .It Er ERRNO1
57 57 A Reason why ERRNO1 could occur.
58 58 .It Er ERRNO2
59 59 A Reason why ERRNO2 could occur.
60 60 .El
61 61 .Sh INTERFACE STABILITY
62 -.\" Indicate the stability per attribute(5). One of:
62 +.\" Indicate the stability per attributes(5). One of:
63 63 .\" .Sy Committed
64 64 .\" .Sy Uncommitted
65 65 .\" .Sy Volatile
66 66 .\" .Sy Private
67 67 .Sh MT-LEVEL
68 68 .\" Indicate the MT-Level per attributes(5). If there are exceptions,
69 69 .\" start with the level and go from there.
70 70 .\" .Sy Safe
71 71 .\" .Sy Unsafe
72 72 .\" .Sy MT-Safe
73 73 .\" .Sy Aysnc-Signal-Safe
74 74 .Sh SEE ALSO
75 75 .\" A list of mentioned manuals or others that are relevant to this
76 76 .\" function. If there is a user command that exercises this, for
77 77 .\" example, sleep(1) if documenting sleep(3C), list this here.
78 78 .\" Generally an overview page for a library in 3LIB should also be
79 79 .\" referenced.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX