example.3 (03e563d7dc415d00b5511a44bdaf7bfeabe2e376) example.3 (d72ca9ddd13a8e6359af1ff0f3c017e7a34a7878)
1.\" Copyright (c) [year] [your name]
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.

--- 9 unchanged lines hidden (view full) ---

18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
1.\" Copyright (c) [year] [your name]
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.

--- 9 unchanged lines hidden (view full) ---

18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\" Note: All FreeBSD man pages should have a FreeBSD revision
27.\" control id to make it easier for translation teams to track
28.\" changes.
29.\"
30.\" Note: The date here should be updated whenever a non-trivial
31.\" change is made to the manual page.
32.Dd December 8, 1999
33.Dt EXAMPLE 3
34.Os
35.Sh NAME
36.Nm example
26.\"
27.\" Note: The date here should be updated whenever a non-trivial
28.\" change is made to the manual page.
29.Dd December 8, 1999
30.Dt EXAMPLE 3
31.Os
32.Sh NAME
33.Nm example
37.Nd example library function manual page
34.Nd "example library function manual page"
38.Sh LIBRARY
39.\" Note: list of available libraries is available in mdoc(7)
40.Lb libc
41.Sh SYNOPSIS
35.Sh LIBRARY
36.\" Note: list of available libraries is available in mdoc(7)
37.Lb libc
38.Sh SYNOPSIS
42.Fd #include <example.h>
39.In example.h
43.Ft int
44.Fn example "char *ptr" "int mode"
45.Sh DESCRIPTION
46This is an example library function manual page for the
47.Fn example
48function.
49It is intended that this example can be used as a template
50when writing a new manual page.
51.Pp
52The
53.Fn example
54function takes two arguments:
55.Fa ptr
56and
57.Fa mode .
58The argument
59.Fa mode
60may have one of the following values:
40.Ft int
41.Fn example "char *ptr" "int mode"
42.Sh DESCRIPTION
43This is an example library function manual page for the
44.Fn example
45function.
46It is intended that this example can be used as a template
47when writing a new manual page.
48.Pp
49The
50.Fn example
51function takes two arguments:
52.Fa ptr
53and
54.Fa mode .
55The argument
56.Fa mode
57may have one of the following values:
61.Bl -tag -width EXAMPLE_ONE
58.Bl -tag -width ".Dv EXAMPLE_ONE"
62.It Dv EXAMPLE_ONE
63First example of a defined variable.
64.Dv EXAMPLE_ONE
65is described below.
66.It Dv EXAMPLE_TWO
67Second example.
68.El
69.Pp
59.It Dv EXAMPLE_ONE
60First example of a defined variable.
61.Dv EXAMPLE_ONE
62is described below.
63.It Dv EXAMPLE_TWO
64Second example.
65.El
66.Pp
70The above value are defined in
67The above values are defined in
71.Aq Pa example.h
72as follows:
73.Bd -literal
74#define EXAMPLE_ONE 1
75#define EXAMPLE_TWO 2
76.Ed
77.Sh IMPLEMENTATION NOTES
78The
79.Fn example
80function is not actually implemented.
81.Sh RETURN VALUES
82.Rv -std example
83.Sh ENVIRONMENT
84The
85.Fn example
86library function ignores the
87.Ev EXAMPLE
88environment variable.
89.Sh FILES
68.Aq Pa example.h
69as follows:
70.Bd -literal
71#define EXAMPLE_ONE 1
72#define EXAMPLE_TWO 2
73.Ed
74.Sh IMPLEMENTATION NOTES
75The
76.Fn example
77function is not actually implemented.
78.Sh RETURN VALUES
79.Rv -std example
80.Sh ENVIRONMENT
81The
82.Fn example
83library function ignores the
84.Ev EXAMPLE
85environment variable.
86.Sh FILES
90.Bl -tag -width /dev/null -compact
87.Bl -tag -width ".Pa /dev/null" -compact
91.It Pa /dev/null
92Example of a file in the
93.Sx FILES
94section.
95.El
96.Sh DIAGNOSTICS
97None.
98.Sh COMPATIBILITY

--- 119 unchanged lines hidden (view full) ---

218No buffer space available.
219.It Bq Er EISCONN
220Socket is already connected.
221.It Bq Er ENOTCONN
222Socket is not connected.
223.It Bq Er ESHUTDOWN
224Cannot send after socket shutdown.
225.It Bq Er ETOOMANYREFS
88.It Pa /dev/null
89Example of a file in the
90.Sx FILES
91section.
92.El
93.Sh DIAGNOSTICS
94None.
95.Sh COMPATIBILITY

--- 119 unchanged lines hidden (view full) ---

215No buffer space available.
216.It Bq Er EISCONN
217Socket is already connected.
218.It Bq Er ENOTCONN
219Socket is not connected.
220.It Bq Er ESHUTDOWN
221Cannot send after socket shutdown.
222.It Bq Er ETOOMANYREFS
226Too many references: cannot splice.
223Too many references: cannot splice.
227.It Bq Er ETIMEDOUT
228Operation timed out.
229.It Bq Er ECONNREFUSED
230Connection refused.
231.It Bq Er ELOOP
232Too many levels of symbolic links.
233.It Bq Er ENAMETOOLONG
234File name too long.

--- 34 unchanged lines hidden (view full) ---

269.It Bq Er ENEEDAUTH
270Need authenticator.
271.El
272.Sh SEE ALSO
273.Xr example 1 ,
274.Xr example 4 ,
275.Xr mdoc 7
276.Rs
224.It Bq Er ETIMEDOUT
225Operation timed out.
226.It Bq Er ECONNREFUSED
227Connection refused.
228.It Bq Er ELOOP
229Too many levels of symbolic links.
230.It Bq Er ENAMETOOLONG
231File name too long.

--- 34 unchanged lines hidden (view full) ---

266.It Bq Er ENEEDAUTH
267Need authenticator.
268.El
269.Sh SEE ALSO
270.Xr example 1 ,
271.Xr example 4 ,
272.Xr mdoc 7
273.Rs
277.%A A. B. Author
278.%T Example RFC Title
274.%A "A. B. Author"
275.%T "Example RFC Title"
279.%O RFC0000
280.Re
281.Rs
276.%O RFC0000
277.Re
278.Rs
282.%A A. B. Author
283.%B Example Book Title
279.%A "A. B. Author"
280.%B "Example Book Title"
284.%O ISBN-0-000-00000-0
285.Re
286.Rs
281.%O ISBN-0-000-00000-0
282.Re
283.Rs
287.%A A. B. Author
288.%D January 1997
289.%J Example Journal Name
290.%T Example Article Title
284.%A "A. B. Author"
285.%D "January 1997"
286.%J "Example Journal Name"
287.%T "Example Article Title"
291.Re
292.Sh STANDARDS
293If the command conforms to some standard, such as
294.St -p1003.2
295or
296.St -isoC ,
297it should be noted here.
298.Sh HISTORY

--- 24 unchanged lines hidden --- 		288.Re
289.Sh STANDARDS
290If the command conforms to some standard, such as
291.St -p1003.2
292or
293.St -isoC ,
294it should be noted here.
295.Sh HISTORY

--- 24 unchanged lines hidden ---