10 .\"
11 .\"
12 .\" Copyright 2016 Joyent, Inc.
13 .\"
14 .Dd August 2, 2018
15 .Dt ENDIAN.H 3HEAD
16 .Os
17 .Sh NAME
18 .Nm endian.h
19 .Nd definitions for endian routines
20 .Sh SYNOPSIS
21 .In endian.h
22 .Sh DESCRIPTION
23 The
24 .In endian.h
25 header defines functions and macros focused on converting data between
26 the host machines native byte order and big or little-endian values.
27 While the manual page details the macros defined by
28 .In endian.h ,
29 the functions are documented separately in
30 .Xr endian 3C.
31 More information on endianness and a general background on the topic can
32 be found in
33 .Xr byteorder 5 .
34 .Pp
35 The
36 .In endian.h
37 header defines the following macros:
38 .Bl -tag -width Ds
39 .It Sy LITTLE_ENDIAN
40 A constant used to indicate a little-endian integer.
41 It is always defined, regardless of the actual endianess of the underlying
42 platform.
43 This macro should be used to compare against the
44 .Sy BYTE_ORDER
45 macro.
46 .It Sy BIG_ENDIAN
47 A constant used to indicate a big-endian integer.
48 It is always defined, regardless of the actual endianess of the underlying
49 platform.
50 This macro should be used to compare against the
|
10 .\"
11 .\"
12 .\" Copyright 2016 Joyent, Inc.
13 .\"
14 .Dd August 2, 2018
15 .Dt ENDIAN.H 3HEAD
16 .Os
17 .Sh NAME
18 .Nm endian.h
19 .Nd definitions for endian routines
20 .Sh SYNOPSIS
21 .In endian.h
22 .Sh DESCRIPTION
23 The
24 .In endian.h
25 header defines functions and macros focused on converting data between
26 the host machines native byte order and big or little-endian values.
27 While the manual page details the macros defined by
28 .In endian.h ,
29 the functions are documented separately in
30 .Xr endian 3C .
31 More information on endianness and a general background on the topic can
32 be found in
33 .Xr byteorder 5 .
34 .Pp
35 The
36 .In endian.h
37 header defines the following macros:
38 .Bl -tag -width Ds
39 .It Sy LITTLE_ENDIAN
40 A constant used to indicate a little-endian integer.
41 It is always defined, regardless of the actual endianess of the underlying
42 platform.
43 This macro should be used to compare against the
44 .Sy BYTE_ORDER
45 macro.
46 .It Sy BIG_ENDIAN
47 A constant used to indicate a big-endian integer.
48 It is always defined, regardless of the actual endianess of the underlying
49 platform.
50 This macro should be used to compare against the
|