Changed all @example to @smallexample; misc changes for formatting.
[kopensolaris-gnu/glibc.git] / manual / sysinfo.texi
1 @node System Information, System Configuration, Users and Groups, Top
2 @chapter System Information
3
4 This chapter describes functions that return information about the
5 particular machine that is in use---the type of hardware, the type of
6 software, and the individual machine's name.
7
8 @menu
9 * Host Identification::         Determining the name of the machine.
10 * Hardware/Software Type ID::   Determining the hardware type of the
11                                  machine and what operating system it is
12                                  running. 
13 @end menu
14
15
16 @node Host Identification
17 @section Host Identification
18
19 This section explains how to identify the particular machine that your
20 program is running on.  The identification of a machine consists of its
21 Internet host name and Internet address; see @ref{Internet Namespace}.  
22
23 @pindex hostname
24 @pindex hostid
25 @pindex unistd.h
26 Prototypes for these functions appear in @file{unistd.h}.  The shell
27 commands @code{hostname} and @code{hostid} work by calling them.
28
29 @comment unistd.h
30 @comment BSD
31 @deftypefun int gethostname (char *@var{name}, size_t @var{size})
32 This function returns the name of the host machine in the array
33 @var{name}.  The @var{size} argument specifies the size of this array,
34 in bytes.
35
36 The return value is @code{0} on success and @code{-1} on failure.  In
37 the GNU C library, @code{gethostname} fails if @var{size} is not large
38 enough; then you can try again with a larger array.  The following
39 @code{errno} error condition is defined for this function:
40
41 @table @code
42 @item ENAMETOOLONG
43 The @var{size} argument is less than the size of the host name plus one.
44 @end table
45
46 @pindex sys/param.h
47 On some systems, there is a symbol for the maximum possible host name
48 length: @code{MAXHOSTNAMELEN}.  It is defined in @file{sys/param.h}.
49 But you can't count on this to exist, so it is cleaner to handle
50 failure and try again.
51
52 @code{gethostname} stores the beginning of the host name in @var{name}
53 even if the host name won't entirely fit.  For some purposes, a
54 truncated host name is good enough.  If it is, you can ignore the
55 error code.
56 @end deftypefun
57
58 @comment unistd.h
59 @comment BSD
60 @deftypefun int sethostname (const char *@var{name}, size_t @var{length})
61 The @code{sethostname} function sets the name of the host machine to
62 @var{name}, a string with length @var{length}.  Only privileged
63 processes are allowed to do this.  Usually it happens just once, at
64 system boot time.
65
66 The return value is @code{0} on success and @code{-1} on failure.
67 The following @code{errno} error condition is defined for this function:
68
69 @table @code
70 @item EPERM
71 This process cannot set the host name because it is not privileged.
72 @end table
73 @end deftypefun
74
75 @comment unistd.h
76 @comment BSD
77 @deftypefun {long int} gethostid (void)
78 This function returns the ``host ID'' of the machine the program is
79 running on.  By convention, this is usually the primary Internet address
80 of that machine, converted to a @w{@code{long int}}.  But on some
81 systems it is a meaningless but unique number which is hard-coded for
82 each machine.
83 @end deftypefun
84
85 @comment unistd.h
86 @comment BSD
87 @deftypefun int sethostid (long int @var{id})
88 The @code{sethostid} function sets the ``host ID'' of the host machine
89 to @var{id}.  Only privileged processes are allowed to do this.  Usually
90 it happens just once, at system boot time.
91
92 The return value is @code{0} on success and @code{-1} on failure.
93 The following @code{errno} error condition is defined for this function:
94
95 @table @code
96 @item EPERM
97 This process cannot set the host name because it is not privileged.
98
99 @item ENOSYS
100 The operating system does not support setting the host ID.  On some
101 systems, the host ID is a meaningless but unique number hard-coded for
102 each machine.
103 @end table
104 @end deftypefun
105
106 @node Hardware/Software Type ID
107 @section Hardware/Software Type Identification
108
109 You can use the @code{uname} function to find out some information about
110 the type of computer your program is running on.  This function and the
111 associated data type are declared in the header file
112 @file{sys/utsname.h}.
113 @pindex sys/utsname.h
114
115 @comment sys/utsname.h
116 @comment POSIX.1
117 @deftp {Data Type} {struct utsname}
118 The @code{utsname} structure is used to hold information returned
119 by the @code{uname} function.  It has the following members:
120
121 @table @code
122 @item char sysname[]
123 This is the name of the operating system in use.
124
125 @item char nodename[]
126 This is the network name of this particular computer.  In the GNU
127 library, the value is the same as that returned by @code{gethostname};
128 see @ref{Host Identification}.
129
130 @item char release[]
131 This is the current release level of the operating system implementation.
132
133 @item char version[]
134 This is the current version level within the release of the operating
135 system.
136
137 @item char machine[]
138 This is a description of the type of hardware that is in use.
139
140 Some systems provide a mechanism to interrogate the kernel directly for
141 this information.  On systems without such a mechanism, the GNU C
142 library fills in this field based on the configuration name that was
143 specified when building and installing the library.
144
145 GNU uses a three-part name to describe a system configuration; the three
146 parts are @var{cpu}, @var{manufacturer} and @var{system-type}, and they
147 are separated with dashes.  Any possible combination of three names is
148 potentially meaningful, but most such combinations are meaningless in
149 practice and even the meaningful ones are not necessarily supported by
150 any particular GNU program.
151
152 Since the value in @code{machine} is supposed to describe just the
153 hardware, it consists of the first two parts of the configuration name:
154 @samp{@var{cpu}-@var{manufacturer}}.  For example, it might be one of these:
155
156 @quotation
157 @code{"sparc-sun"}, 
158 @code{"i386-@var{anything}"},
159 @code{"m68k-hp"}, 
160 @code{"m68k-sony"},
161 @code{"m68k-sun"},
162 @code{"mips-dec"}
163 @end quotation
164 @end table
165 @end deftp
166
167 @comment sys/utsname.h
168 @comment POSIX.1
169 @deftypefun int uname (struct utsname *@var{info})
170 The @code{uname} function fills in the structure pointed to by
171 @var{info} with information about the operating system and host machine.
172 A non-negative value indicates that the data was successfully stored.
173
174 @code{-1} as the value indicates an error.  The only error possible is
175 @code{EFAULT}, which we normally don't mention as it is always a
176 possibility.
177 @end deftypefun