Update.
[kopensolaris-gnu/glibc.git] / manual / conf.texi
1 @node System Configuration, Cryptographic Functions, System Management, Top
2 @c %MENU% Parameters describing operating system limits
3 @chapter System Configuration Parameters
4
5 The functions and macros listed in this chapter give information about
6 configuration parameters of the operating system---for example, capacity
7 limits, presence of optional POSIX features, and the default path for
8 executable files (@pxref{String Parameters}).
9
10 @menu
11 * General Limits::           Constants and functions that describe
12                                 various process-related limits that have
13                                 one uniform value for any given machine.
14 * System Options::           Optional POSIX features.
15 * Version Supported::        Version numbers of POSIX.1 and POSIX.2.
16 * Sysconf::                  Getting specific configuration values
17                                 of general limits and system options.
18 * Minimums::                 Minimum values for general limits.
19
20 * Limits for Files::         Size limitations that pertain to individual files.
21                                 These can vary between file systems
22                                 or even from file to file.
23 * Options for Files::        Optional features that some files may support.
24 * File Minimums::            Minimum values for file limits.
25 * Pathconf::                 Getting the limit values for a particular file.
26
27 * Utility Limits::           Capacity limits of some POSIX.2 utility programs.
28 * Utility Minimums::         Minimum allowable values of those limits.
29
30 * String Parameters::        Getting the default search path.
31 @end menu
32
33 @node General Limits
34 @section General Capacity Limits
35 @cindex POSIX capacity limits
36 @cindex limits, POSIX
37 @cindex capacity limits, POSIX
38
39 The POSIX.1 and POSIX.2 standards specify a number of parameters that
40 describe capacity limitations of the system.  These limits can be fixed
41 constants for a given operating system, or they can vary from machine to
42 machine.  For example, some limit values may be configurable by the
43 system administrator, either at run time or by rebuilding the kernel,
44 and this should not require recompiling application programs.
45
46 @pindex limits.h
47 Each of the following limit parameters has a macro that is defined in
48 @file{limits.h} only if the system has a fixed, uniform limit for the
49 parameter in question.  If the system allows different file systems or
50 files to have different limits, then the macro is undefined; use
51 @code{sysconf} to find out the limit that applies at a particular time
52 on a particular machine.  @xref{Sysconf}.
53
54 Each of these parameters also has another macro, with a name starting
55 with @samp{_POSIX}, which gives the lowest value that the limit is
56 allowed to have on @emph{any} POSIX system.  @xref{Minimums}.
57
58 @cindex limits, program argument size
59 @comment limits.h
60 @comment POSIX.1
61 @deftypevr Macro int ARG_MAX
62 If defined, the unvarying maximum combined length of the @var{argv} and
63 @var{environ} arguments that can be passed to the @code{exec} functions.
64 @end deftypevr
65
66 @cindex limits, number of processes
67 @comment limits.h
68 @comment POSIX.1
69 @deftypevr Macro int CHILD_MAX
70 If defined, the unvarying maximum number of processes that can exist
71 with the same real user ID at any one time.  In BSD and GNU, this is
72 controlled by the @code{RLIMIT_NPROC} resource limit; @pxref{Limits on
73 Resources}.
74 @end deftypevr
75
76 @cindex limits, number of open files
77 @comment limits.h
78 @comment POSIX.1
79 @deftypevr Macro int OPEN_MAX
80 If defined, the unvarying maximum number of files that a single process
81 can have open simultaneously.  In BSD and GNU, this is controlled
82 by the @code{RLIMIT_NOFILE} resource limit; @pxref{Limits on Resources}.
83 @end deftypevr
84
85 @comment limits.h
86 @comment POSIX.1
87 @deftypevr Macro int STREAM_MAX
88 If defined, the unvarying maximum number of streams that a single
89 process can have open simultaneously.  @xref{Opening Streams}.
90 @end deftypevr
91
92 @cindex limits, time zone name length
93 @comment limits.h
94 @comment POSIX.1
95 @deftypevr Macro int TZNAME_MAX
96 If defined, the unvarying maximum length of a time zone name.
97 @xref{Time Zone Functions}.
98 @end deftypevr
99
100 These limit macros are always defined in @file{limits.h}.
101
102 @cindex limits, number of supplementary group IDs
103 @comment limits.h
104 @comment POSIX.1
105 @deftypevr Macro int NGROUPS_MAX
106 The maximum number of supplementary group IDs that one process can have.
107
108 The value of this macro is actually a lower bound for the maximum.  That
109 is, you can count on being able to have that many supplementary group
110 IDs, but a particular machine might let you have even more.  You can use
111 @code{sysconf} to see whether a particular machine will let you have
112 more (@pxref{Sysconf}).
113 @end deftypevr
114
115 @comment limits.h
116 @comment POSIX.1
117 @deftypevr Macro int SSIZE_MAX
118 The largest value that can fit in an object of type @code{ssize_t}.
119 Effectively, this is the limit on the number of bytes that can be read
120 or written in a single operation.
121
122 This macro is defined in all POSIX systems because this limit is never
123 configurable.
124 @end deftypevr
125
126 @comment limits.h
127 @comment POSIX.2
128 @deftypevr Macro int RE_DUP_MAX
129 The largest number of repetitions you are guaranteed is allowed in the
130 construct @samp{\@{@var{min},@var{max}\@}} in a regular expression.
131
132 The value of this macro is actually a lower bound for the maximum.  That
133 is, you can count on being able to have that many repetitions, but a
134 particular machine might let you have even more.  You can use
135 @code{sysconf} to see whether a particular machine will let you have
136 more (@pxref{Sysconf}).  And even the value that @code{sysconf} tells
137 you is just a lower bound---larger values might work.
138
139 This macro is defined in all POSIX.2 systems, because POSIX.2 says it
140 should always be defined even if there is no specific imposed limit.
141 @end deftypevr
142
143 @node System Options
144 @section Overall System Options
145 @cindex POSIX optional features
146 @cindex optional POSIX features
147
148 POSIX defines certain system-specific options that not all POSIX systems
149 support.  Since these options are provided in the kernel, not in the
150 library, simply using the GNU C library does not guarantee any of these
151 features is supported; it depends on the system you are using.
152
153 @pindex unistd.h
154 You can test for the availability of a given option using the macros in
155 this section, together with the function @code{sysconf}.  The macros are
156 defined only if you include @file{unistd.h}.
157
158 For the following macros, if the macro is defined in @file{unistd.h},
159 then the option is supported.  Otherwise, the option may or may not be
160 supported; use @code{sysconf} to find out.  @xref{Sysconf}.
161
162 @comment unistd.h
163 @comment POSIX.1
164 @deftypevr Macro int _POSIX_JOB_CONTROL
165 If this symbol is defined, it indicates that the system supports job
166 control.  Otherwise, the implementation behaves as if all processes
167 within a session belong to a single process group.  @xref{Job Control}.
168 @end deftypevr
169
170 @comment unistd.h
171 @comment POSIX.1
172 @deftypevr Macro int _POSIX_SAVED_IDS
173 If this symbol is defined, it indicates that the system remembers the
174 effective user and group IDs of a process before it executes an
175 executable file with the set-user-ID or set-group-ID bits set, and that
176 explicitly changing the effective user or group IDs back to these values
177 is permitted.  If this option is not defined, then if a nonprivileged
178 process changes its effective user or group ID to the real user or group
179 ID of the process, it can't change it back again.  @xref{Enable/Disable
180 Setuid}.
181 @end deftypevr
182
183 For the following macros, if the macro is defined in @file{unistd.h},
184 then its value indicates whether the option is supported.  A value of
185 @code{-1} means no, and any other value means yes.  If the macro is not
186 defined, then the option may or may not be supported; use @code{sysconf}
187 to find out.  @xref{Sysconf}.
188
189 @comment unistd.h
190 @comment POSIX.2
191 @deftypevr Macro int _POSIX2_C_DEV
192 If this symbol is defined, it indicates that the system has the POSIX.2
193 C compiler command, @code{c89}.  The GNU C library always defines this
194 as @code{1}, on the assumption that you would not have installed it if
195 you didn't have a C compiler.
196 @end deftypevr
197
198 @comment unistd.h
199 @comment POSIX.2
200 @deftypevr Macro int _POSIX2_FORT_DEV
201 If this symbol is defined, it indicates that the system has the POSIX.2
202 Fortran compiler command, @code{fort77}.  The GNU C library never
203 defines this, because we don't know what the system has.
204 @end deftypevr
205
206 @comment unistd.h
207 @comment POSIX.2
208 @deftypevr Macro int _POSIX2_FORT_RUN
209 If this symbol is defined, it indicates that the system has the POSIX.2
210 @code{asa} command to interpret Fortran carriage control.  The GNU C
211 library never defines this, because we don't know what the system has.
212 @end deftypevr
213
214 @comment unistd.h
215 @comment POSIX.2
216 @deftypevr Macro int _POSIX2_LOCALEDEF
217 If this symbol is defined, it indicates that the system has the POSIX.2
218 @code{localedef} command.  The GNU C library never defines this, because
219 we don't know what the system has.
220 @end deftypevr
221
222 @comment unistd.h
223 @comment POSIX.2
224 @deftypevr Macro int _POSIX2_SW_DEV
225 If this symbol is defined, it indicates that the system has the POSIX.2
226 commands @code{ar}, @code{make}, and @code{strip}.  The GNU C library
227 always defines this as @code{1}, on the assumption that you had to have
228 @code{ar} and @code{make} to install the library, and it's unlikely that
229 @code{strip} would be absent when those are present.
230 @end deftypevr
231
232 @node Version Supported
233 @section Which Version of POSIX is Supported
234
235 @comment unistd.h
236 @comment POSIX.1
237 @deftypevr Macro {long int} _POSIX_VERSION
238 This constant represents the version of the POSIX.1 standard to which
239 the implementation conforms.  For an implementation conforming to the
240 1995 POSIX.1 standard, the value is the integer @code{199506L}.
241
242 @code{_POSIX_VERSION} is always defined (in @file{unistd.h}) in any
243 POSIX system.
244
245 @strong{Usage Note:} Don't try to test whether the system supports POSIX
246 by including @file{unistd.h} and then checking whether
247 @code{_POSIX_VERSION} is defined.  On a non-POSIX system, this will
248 probably fail because there is no @file{unistd.h}.  We do not know of
249 @emph{any} way you can reliably test at compilation time whether your
250 target system supports POSIX or whether @file{unistd.h} exists.
251
252 The GNU C compiler predefines the symbol @code{__POSIX__} if the target
253 system is a POSIX system.  Provided you do not use any other compilers
254 on POSIX systems, testing @code{defined (__POSIX__)} will reliably
255 detect such systems.
256 @end deftypevr
257
258 @comment unistd.h
259 @comment POSIX.2
260 @deftypevr Macro {long int} _POSIX2_C_VERSION
261 This constant represents the version of the POSIX.2 standard which the
262 library and system kernel support.  We don't know what value this will
263 be for the first version of the POSIX.2 standard, because the value is
264 based on the year and month in which the standard is officially adopted.
265
266 The value of this symbol says nothing about the utilities installed on
267 the system.
268
269 @strong{Usage Note:} You can use this macro to tell whether a POSIX.1
270 system library supports POSIX.2 as well.  Any POSIX.1 system contains
271 @file{unistd.h}, so include that file and then test @code{defined
272 (_POSIX2_C_VERSION)}.
273 @end deftypevr
274
275 @node Sysconf
276 @section Using @code{sysconf}
277
278 When your system has configurable system limits, you can use the
279 @code{sysconf} function to find out the value that applies to any
280 particular machine.  The function and the associated @var{parameter}
281 constants are declared in the header file @file{unistd.h}.
282
283 @menu
284 * Sysconf Definition::        Detailed specifications of @code{sysconf}.
285 * Constants for Sysconf::     The list of parameters @code{sysconf} can read.
286 * Examples of Sysconf::       How to use @code{sysconf} and the parameter
287                                  macros properly together.
288 @end menu
289
290 @node Sysconf Definition
291 @subsection Definition of @code{sysconf}
292
293 @comment unistd.h
294 @comment POSIX.1
295 @deftypefun {long int} sysconf (int @var{parameter})
296 This function is used to inquire about runtime system parameters.  The
297 @var{parameter} argument should be one of the @samp{_SC_} symbols listed
298 below.
299
300 The normal return value from @code{sysconf} is the value you requested.
301 A value of @code{-1} is returned both if the implementation does not
302 impose a limit, and in case of an error.
303
304 The following @code{errno} error conditions are defined for this function:
305
306 @table @code
307 @item EINVAL
308 The value of the @var{parameter} is invalid.
309 @end table
310 @end deftypefun
311
312 @node Constants for Sysconf
313 @subsection Constants for @code{sysconf} Parameters
314
315 Here are the symbolic constants for use as the @var{parameter} argument
316 to @code{sysconf}.  The values are all integer constants (more
317 specifically, enumeration type values).
318
319 @table @code
320 @comment unistd.h
321 @comment POSIX.1
322 @item _SC_ARG_MAX
323 Inquire about the parameter corresponding to @code{ARG_MAX}.
324
325 @comment unistd.h
326 @comment POSIX.1
327 @item _SC_CHILD_MAX
328 Inquire about the parameter corresponding to @code{CHILD_MAX}.
329
330 @comment unistd.h
331 @comment POSIX.1
332 @item _SC_OPEN_MAX
333 Inquire about the parameter corresponding to @code{OPEN_MAX}.
334
335 @comment unistd.h
336 @comment POSIX.1
337 @item _SC_STREAM_MAX
338 Inquire about the parameter corresponding to @code{STREAM_MAX}.
339
340 @comment unistd.h
341 @comment POSIX.1
342 @item _SC_TZNAME_MAX
343 Inquire about the parameter corresponding to @code{TZNAME_MAX}.
344
345 @comment unistd.h
346 @comment POSIX.1
347 @item _SC_NGROUPS_MAX
348 Inquire about the parameter corresponding to @code{NGROUPS_MAX}.
349
350 @comment unistd.h
351 @comment POSIX.1
352 @item _SC_JOB_CONTROL
353 Inquire about the parameter corresponding to @code{_POSIX_JOB_CONTROL}.
354
355 @comment unistd.h
356 @comment POSIX.1
357 @item _SC_SAVED_IDS
358 Inquire about the parameter corresponding to @code{_POSIX_SAVED_IDS}.
359
360 @comment unistd.h
361 @comment POSIX.1
362 @item _SC_VERSION
363 Inquire about the parameter corresponding to @code{_POSIX_VERSION}.
364
365 @comment unistd.h
366 @comment POSIX.1
367 @item _SC_CLK_TCK
368 Inquire about the parameter corresponding to @code{CLOCKS_PER_SEC};
369 @pxref{CPU Time}.
370
371 @comment unistd.h
372 @comment GNU
373 @item _SC_CHARCLASS_NAME_MAX
374 Inquire about the parameter corresponding to maximal length allowed for
375 a character class name in an extended locale specification.  These
376 extensions are not yet standardized and so this option is not standardized
377 as well.
378
379 @comment unistdh.h
380 @comment POSIX.1
381 @item _SC_REALTIME_SIGNALS
382 Inquire about the parameter corresponding to @code{_POSIX_REALTIME_SIGNALS}.
383
384 @comment unistd.h
385 @comment POSIX.1
386 @item _SC_PRIORITY_SCHEDULING
387 Inquire about the parameter corresponding to @code{_POSIX_PRIORITY_SCHEDULING}.
388
389 @comment unistd.h
390 @comment POSIX.1
391 @item _SC_TIMERS
392 Inquire about the parameter corresponding to @code{_POSIX_TIMERS}.
393
394 @comment unistd.h
395 @comment POSIX.1
396 @item _SC_ASYNCHRONOUS_IO
397 Inquire about the parameter corresponding to @code{_POSIX_ASYNCHRONOUS_IO}.
398
399 @comment unistd.h
400 @comment POSIX.1
401 @item _SC_PRIORITIZED_IO
402 Inquire about the parameter corresponding to @code{_POSIX_PRIORITIZED_IO}.
403
404 @comment unistd.h
405 @comment POSIX.1
406 @item _SC_SYNCHRONIZED_IO
407 Inquire about the parameter corresponding to @code{_POSIX_SYNCHRONIZED_IO}.
408
409 @comment unistd.h
410 @comment POSIX.1
411 @item _SC_FSYNC
412 Inquire about the parameter corresponding to @code{_POSIX_FSYNC}.
413
414 @comment unistd.h
415 @comment POSIX.1
416 @item _SC_MAPPED_FILES
417 Inquire about the parameter corresponding to @code{_POSIX_MAPPED_FILES}.
418
419 @comment unistd.h
420 @comment POSIX.1
421 @item _SC_MEMLOCK
422 Inquire about the parameter corresponding to @code{_POSIX_MEMLOCK}.
423
424 @comment unistd.h
425 @comment POSIX.1
426 @item _SC_MEMLOCK_RANGE
427 Inquire about the parameter corresponding to @code{_POSIX_MEMLOCK_RANGE}.
428
429 @comment unistd.h
430 @comment POSIX.1
431 @item _SC_MEMORY_PROTECTION
432 Inquire about the parameter corresponding to @code{_POSIX_MEMORY_PROTECTION}.
433
434 @comment unistd.h
435 @comment POSIX.1
436 @item _SC_MESSAGE_PASSING
437 Inquire about the parameter corresponding to @code{_POSIX_MESSAGE_PASSING}.
438
439 @comment unistd.h
440 @comment POSIX.1
441 @item _SC_SEMAPHORES
442 Inquire about the parameter corresponding to @code{_POSIX_SEMAPHORES}.
443
444 @comment unistd.h
445 @comment POSIX.1
446 @item _SC_SHARED_MEMORY_OBJECTS
447 Inquire about the parameter corresponding to@*
448 @code{_POSIX_SHARED_MEMORY_OBJECTS}.
449
450 @comment unistd.h
451 @comment POSIX.1
452 @item _SC_AIO_LISTIO_MAX
453 Inquire about the parameter corresponding to @code{_POSIX_AIO_LISTIO_MAX}.
454
455 @comment unistd.h
456 @comment POSIX.1
457 @item _SC_AIO_MAX
458 Inquire about the parameter corresponding to @code{_POSIX_AIO_MAX}.
459
460 @comment unistd.h
461 @comment POSIX.1
462 @item _SC_AIO_PRIO_DELTA_MAX
463 Inquire the value by which a process can decrease its asynchronous I/O
464 priority level from its own scheduling priority.  This corresponds to the
465 run-time invariant value @code{AIO_PRIO_DELTA_MAX}.
466
467 @comment unistd.h
468 @comment POSIX.1
469 @item _SC_DELAYTIMER_MAX
470 Inquire about the parameter corresponding to @code{_POSIX_DELAYTIMER_MAX}.
471
472 @comment unistd.h
473 @comment POSIX.1
474 @item _SC_MQ_OPEN_MAX
475 Inquire about the parameter corresponding to @code{_POSIX_MQ_OPEN_MAX}.
476
477 @comment unistd.h
478 @comment POSIX.1
479 @item _SC_MQ_PRIO_MAX
480 Inquire about the parameter corresponding to @code{_POSIX_MQ_PRIO_MAX}.
481
482 @comment unistd.h
483 @comment POSIX.1
484 @item _SC_RTSIG_MAX
485 Inquire about the parameter corresponding to @code{_POSIX_RTSIG_MAX}.
486
487 @comment unistd.h
488 @comment POSIX.1
489 @item _SC_SEM_NSEMS_MAX
490 Inquire about the parameter corresponding to @code{_POSIX_SEM_NSEMS_MAX}.
491
492 @comment unistd.h
493 @comment POSIX.1
494 @item _SC_SEM_VALUE_MAX
495 Inquire about the parameter corresponding to @code{_POSIX_SEM_VALUE_MAX}.
496
497 @comment unistd.h
498 @comment POSIX.1
499 @item _SC_SIGQUEUE_MAX
500 Inquire about the parameter corresponding to @code{_POSIX_SIGQUEUE_MAX}.
501
502 @comment unistd.h
503 @comment POSIX.1
504 @item _SC_TIMER_MAX
505 Inquire about the parameter corresponding to @code{_POSIX_TIMER_MAX}.
506
507 @comment unistd.h
508 @comment POSIX.1g
509 @item _SC_PII
510 Inquire about the parameter corresponding to @code{_POSIX_PII}.
511
512 @comment unistd.h
513 @comment POSIX.1g
514 @item _SC_PII_XTI
515 Inquire about the parameter corresponding to @code{_POSIX_PII_XTI}.
516
517 @comment unistd.h
518 @comment POSIX.1g
519 @item _SC_PII_SOCKET
520 Inquire about the parameter corresponding to @code{_POSIX_PII_SOCKET}.
521
522 @comment unistd.h
523 @comment POSIX.1g
524 @item _SC_PII_INTERNET
525 Inquire about the parameter corresponding to @code{_POSIX_PII_INTERNET}.
526
527 @comment unistd.h
528 @comment POSIX.1g
529 @item _SC_PII_OSI
530 Inquire about the parameter corresponding to @code{_POSIX_PII_OSI}.
531
532 @comment unistd.h
533 @comment POSIX.1g
534 @item _SC_SELECT
535 Inquire about the parameter corresponding to @code{_POSIX_SELECT}.
536
537 @comment unistd.h
538 @comment POSIX.1g
539 @item _SC_UIO_MAXIOV
540 Inquire about the parameter corresponding to @code{_POSIX_UIO_MAXIOV}.
541
542 @comment unistd.h
543 @comment POSIX.1g
544 @item _SC_PII_INTERNET_STREAM
545 Inquire about the parameter corresponding to @code{_POSIX_PII_INTERNET_STREAM}.
546
547 @comment unistd.h
548 @comment POSIX.1g
549 @item _SC_PII_INTERNET_DGRAM
550 Inquire about the parameter corresponding to @code{_POSIX_PII_INTERNET_DGRAM}.
551
552 @comment unistd.h
553 @comment POSIX.1g
554 @item _SC_PII_OSI_COTS
555 Inquire about the parameter corresponding to @code{_POSIX_PII_OSI_COTS}.
556
557 @comment unistd.h
558 @comment POSIX.1g
559 @item _SC_PII_OSI_CLTS
560 Inquire about the parameter corresponding to @code{_POSIX_PII_OSI_CLTS}.
561
562 @comment unistd.h
563 @comment POSIX.1g
564 @item _SC_PII_OSI_M
565 Inquire about the parameter corresponding to @code{_POSIX_PII_OSI_M}.
566
567 @comment unistd.h
568 @comment POSIX.1g
569 @item _SC_T_IOV_MAX
570 Inquire the value of the value associated with the @code{T_IOV_MAX}
571 variable.
572
573 @comment unistd.h
574 @comment POSIX.1
575 @item _SC_THREADS
576 Inquire about the parameter corresponding to @code{_POSIX_THREADS}.
577
578 @comment unistd.h
579 @comment POSIX.1
580 @item _SC_THREAD_SAFE_FUNCTIONS
581 Inquire about the parameter corresponding to@*
582 @code{_POSIX_THREAD_SAFE_FUNCTIONS}.
583
584 @comment unistd.h
585 @comment POSIX.1
586 @item _SC_GETGR_R_SIZE_MAX
587 Inquire about the parameter corresponding to @code{_POSIX_GETGR_R_SIZE_MAX}.
588
589 @comment unistd.h
590 @comment POSIX.1
591 @item _SC_GETPW_R_SIZE_MAX
592 Inquire about the parameter corresponding to @code{_POSIX_GETPW_R_SIZE_MAX}.
593
594 @comment unistd.h
595 @comment POSIX.1
596 @item _SC_LOGIN_NAME_MAX
597 Inquire about the parameter corresponding to @code{_POSIX_LOGIN_NAME_MAX}.
598
599 @comment unistd.h
600 @comment POSIX.1
601 @item _SC_TTY_NAME_MAX
602 Inquire about the parameter corresponding to @code{_POSIX_TTY_NAME_MAX}.
603
604 @comment unistd.h
605 @comment POSIX.1
606 @item _SC_THREAD_DESTRUCTOR_ITERATIONS
607 Inquire about the parameter corresponding to
608 @code{_POSIX_THREAD_DESTRUCTOR_ITERATIONS}.
609
610 @comment unistd.h
611 @comment POSIX.1
612 @item _SC_THREAD_KEYS_MAX
613 Inquire about the parameter corresponding to @code{_POSIX_THREAD_KEYS_MAX}.
614
615 @comment unistd.h
616 @comment POSIX.1
617 @item _SC_THREAD_STACK_MIN
618 Inquire about the parameter corresponding to @code{_POSIX_THREAD_STACK_MIN}.
619
620 @comment unistd.h
621 @comment POSIX.1
622 @item _SC_THREAD_THREADS_MAX
623 Inquire about the parameter corresponding to @code{_POSIX_THREAD_THREADS_MAX}.
624
625 @comment unistd.h
626 @comment POSIX.1
627 @item _SC_THREAD_ATTR_STACKADDR
628 Inquire about the parameter corresponding to@*a
629 @code{_POSIX_THREAD_ATTR_STACKADDR}.
630
631 @comment unistd.h
632 @comment POSIX.1
633 @item _SC_THREAD_ATTR_STACKSIZE
634 Inquire about the parameter corresponding to@*
635 @code{_POSIX_THREAD_ATTR_STACKSIZE}.
636
637 @comment unistd.h
638 @comment POSIX.1
639 @item _SC_THREAD_PRIORITY_SCHEDULING
640 Inquire about the parameter corresponding to
641 @code{_POSIX_THREAD_PRIORITY_SCHEDULING}.
642
643 @comment unistd.h
644 @comment POSIX.1
645 @item _SC_THREAD_PRIO_INHERIT
646 Inquire about the parameter corresponding to @code{_POSIX_THREAD_PRIO_INHERIT}.
647
648 @comment unistd.h
649 @comment POSIX.1
650 @item _SC_THREAD_PRIO_PROTECT
651 Inquire about the parameter corresponding to @code{_POSIX_THREAD_PRIO_PROTECT}.
652
653 @comment unistd.h
654 @comment POSIX.1
655 @item _SC_THREAD_PROCESS_SHARED
656 Inquire about the parameter corresponding to
657 @code{_POSIX_THREAD_PROCESS_SHARED}.
658
659 @comment unistd.h
660 @comment POSIX.2
661 @item _SC_2_C_DEV
662 Inquire about whether the system has the POSIX.2 C compiler command,
663 @code{c89}.
664
665 @comment unistd.h
666 @comment POSIX.2
667 @item _SC_2_FORT_DEV
668 Inquire about whether the system has the POSIX.2 Fortran compiler
669 command, @code{fort77}.
670
671 @comment unistd.h
672 @comment POSIX.2
673 @item _SC_2_FORT_RUN
674 Inquire about whether the system has the POSIX.2 @code{asa} command to
675 interpret Fortran carriage control.
676
677 @comment unistd.h
678 @comment POSIX.2
679 @item _SC_2_LOCALEDEF
680 Inquire about whether the system has the POSIX.2 @code{localedef}
681 command.
682
683 @comment unistd.h
684 @comment POSIX.2
685 @item _SC_2_SW_DEV
686 Inquire about whether the system has the POSIX.2 commands @code{ar},
687 @code{make}, and @code{strip}.
688
689 @comment unistd.h
690 @comment POSIX.2
691 @item _SC_BC_BASE_MAX
692 Inquire about the maximum value of @code{obase} in the @code{bc}
693 utility.
694
695 @comment unistd.h
696 @comment POSIX.2
697 @item _SC_BC_DIM_MAX
698 Inquire about the maximum size of an array in the @code{bc}
699 utility.
700
701 @comment unistd.h
702 @comment POSIX.2
703 @item _SC_BC_SCALE_MAX
704 Inquire about the maximum value of @code{scale} in the @code{bc}
705 utility.
706
707 @comment unistd.h
708 @comment POSIX.2
709 @item _SC_BC_STRING_MAX
710 Inquire about the maximum size of a string constant in the
711 @code{bc} utility.
712
713 @comment unistd.h
714 @comment POSIX.2
715 @item _SC_COLL_WEIGHTS_MAX
716 Inquire about the maximum number of weights that can necessarily
717 be used in defining the collating sequence for a locale.
718
719 @comment unistd.h
720 @comment POSIX.2
721 @item _SC_EXPR_NEST_MAX
722 Inquire about the maximum number of expressions nested within
723 parentheses when using the @code{expr} utility.
724
725 @comment unistd.h
726 @comment POSIX.2
727 @item _SC_LINE_MAX
728 Inquire about the maximum size of a text line that the POSIX.2 text
729 utilities can handle.
730
731 @comment unistd.h
732 @comment POSIX.2
733 @item _SC_EQUIV_CLASS_MAX
734 Inquire about the maximum number of weights that can be assigned to an
735 entry of the @code{LC_COLLATE} category @samp{order} keyword in a locale
736 definition.  The GNU C library does not presently support locale
737 definitions.
738
739 @comment unistd.h
740 @comment POSIX.2
741 @item _SC_VERSION
742 Inquire about the version number of POSIX.1 that the library and kernel
743 support.
744
745 @comment unistd.h
746 @comment POSIX.2
747 @item _SC_2_VERSION
748 Inquire about the version number of POSIX.2 that the system utilities
749 support.
750
751 @comment unistd.h
752 @comment GNU
753 @item _SC_PAGESIZE
754 Inquire about the virtual memory page size of the machine.
755 @code{getpagesize} returns the same value.
756 @c @xref{XXX getpagesize}. !!! ???
757
758 @comment unistd.h
759 @comment GNU
760 @item _SC_NPROCESSORS_CONF
761 Inquire about the number of configured processors.
762
763 @comment unistd.h
764 @comment GNU
765 @item _SC_NPROCESSORS_ONLN
766 Inquire about the number of processors online.
767
768 @comment unistd.h
769 @comment GNU
770 @item _SC_PHYS_PAGES
771 Inquire about the number of physical pages in the system.
772
773 @comment unistd.h
774 @comment GNU
775 @item _SC_AVPHYS_PAGES
776 Inquire about the number of available physical pages in the system.
777
778 @comment unistd.h
779 @comment GNU
780 @item _SC_ATEXIT_MAX
781 Inquire about the number of functions which can be registered as termination
782 functions for @code{atexit}; @pxref{Cleanups on Exit}.
783
784 @comment unistd.h
785 @comment X/Open
786 @item _SC_XOPEN_VERSION
787 Inquire about the parameter corresponding to @code{_XOPEN_VERSION}.
788
789 @comment unistd.h
790 @comment X/Open
791 @item _SC_XOPEN_XCU_VERSION
792 Inquire about the parameter corresponding to @code{_XOPEN_XCU_VERSION}.
793
794 @comment unistd.h
795 @comment X/Open
796 @item _SC_XOPEN_UNIX
797 Inquire about the parameter corresponding to @code{_XOPEN_UNIX}.
798
799 @comment unistd.h
800 @comment X/Open
801 @item _SC_XOPEN_CRYPT
802 Inquire about the parameter corresponding to @code{_XOPEN_CRYPT}.
803
804 @comment unistd.h
805 @comment X/Open
806 @item _SC_XOPEN_ENH_I18N
807 Inquire about the parameter corresponding to @code{_XOPEN_ENH_I18N}.
808
809 @comment unistd.h
810 @comment X/Open
811 @item _SC_XOPEN_SHM
812 Inquire about the parameter corresponding to @code{_XOPEN_SHM}.
813
814 @comment unistd.h
815 @comment X/Open
816 @item _SC_XOPEN_XPG2
817 Inquire about the parameter corresponding to @code{_XOPEN_XPG2}.
818
819 @comment unistd.h
820 @comment X/Open
821 @item _SC_XOPEN_XPG3
822 Inquire about the parameter corresponding to @code{_XOPEN_XPG3}.
823
824 @comment unistd.h
825 @comment X/Open
826 @item _SC_XOPEN_XPG4
827 Inquire about the parameter corresponding to @code{_XOPEN_XPG4}.
828
829 @comment unistd.h
830 @comment X/Open
831 @item _SC_CHAR_BIT
832 Inquire about the number of bits in a variable of type @code{char}.
833
834 @comment unistd.h
835 @comment X/Open
836 @item _SC_CHAR_MAX
837 Inquire about the maximum value which can be stored in a variable of type
838 @code{char}.
839
840 @comment unistd.h
841 @comment X/Open
842 @item _SC_CHAR_MIN
843 Inquire about the minimum value which can be stored in a variable of type
844 @code{char}.
845
846 @comment unistd.h
847 @comment X/Open
848 @item _SC_INT_MAX
849 Inquire about the maximum value which can be stored in a variable of type
850 @code{int}.
851
852 @comment unistd.h
853 @comment X/Open
854 @item _SC_INT_MIN
855 Inquire about the minimum value which can be stored in a variable of type
856 @code{int}.
857
858 @comment unistd.h
859 @comment X/Open
860 @item _SC_LONG_BIT
861 Inquire about the number of bits in a variable of type @code{long int}.
862
863 @comment unistd.h
864 @comment X/Open
865 @item _SC_WORD_BIT
866 Inquire about the number of bits in a variable of a register word.
867
868 @comment unistd.h
869 @comment X/Open
870 @item _SC_MB_LEN_MAX
871 Inquire the maximum length of a multi-byte representation of a wide
872 character value.
873
874 @comment unistd.h
875 @comment X/Open
876 @item _SC_NZERO
877 Inquire about the value used to internally represent the zero priority level for
878 the process execution.
879
880 @comment unistd.h
881 @comment X/Open
882 @item SC_SSIZE_MAX
883 Inquire about the maximum value which can be stored in a variable of type
884 @code{ssize_t}.
885
886 @comment unistd.h
887 @comment X/Open
888 @item _SC_SCHAR_MAX
889 Inquire about the maximum value which can be stored in a variable of type
890 @code{signed char}.
891
892 @comment unistd.h
893 @comment X/Open
894 @item _SC_SCHAR_MIN
895 Inquire about the minimum value which can be stored in a variable of type
896 @code{signed char}.
897
898 @comment unistd.h
899 @comment X/Open
900 @item _SC_SHRT_MAX
901 Inquire about the maximum value which can be stored in a variable of type
902 @code{short int}.
903
904 @comment unistd.h
905 @comment X/Open
906 @item _SC_SHRT_MIN
907 Inquire about the minimum value which can be stored in a variable of type
908 @code{short int}.
909
910 @comment unistd.h
911 @comment X/Open
912 @item _SC_UCHAR_MAX
913 Inquire about the maximum value which can be stored in a variable of type
914 @code{unsigned char}.
915
916 @comment unistd.h
917 @comment X/Open
918 @item _SC_UINT_MAX
919 Inquire about the maximum value which can be stored in a variable of type
920 @code{unsigned int}.
921
922 @comment unistd.h
923 @comment X/Open
924 @item _SC_ULONG_MAX
925 Inquire about the maximum value which can be stored in a variable of type
926 @code{unsigned long int}.
927
928 @comment unistd.h
929 @comment X/Open
930 @item _SC_USHRT_MAX
931 Inquire about the maximum value which can be stored in a variable of type
932 @code{unsigned short int}.
933
934 @comment unistd.h
935 @comment X/Open
936 @item _SC_NL_ARGMAX
937 Inquire about the parameter corresponding to @code{NL_ARGMAX}.
938
939 @comment unistd.h
940 @comment X/Open
941 @item _SC_NL_LANGMAX
942 Inquire about the parameter corresponding to @code{NL_LANGMAX}.
943
944 @comment unistd.h
945 @comment X/Open
946 @item _SC_NL_MSGMAX
947 Inquire about the parameter corresponding to @code{NL_MSGMAX}.
948
949 @comment unistd.h
950 @comment X/Open
951 @item _SC_NL_NMAX
952 Inquire about  the parameter corresponding to @code{NL_NMAX}.
953
954 @comment unistd.h
955 @comment X/Open
956 @item _SC_NL_SETMAX
957 Inquire about the parameter corresponding to @code{NL_SETMAX}.
958
959 @comment unistd.h
960 @comment X/Open
961 @item _SC_NL_TEXTMAX
962 Inquire about the parameter corresponding to @code{NL_TEXTMAX}.
963 @end table
964
965 @node Examples of Sysconf
966 @subsection Examples of @code{sysconf}
967
968 We recommend that you first test for a macro definition for the
969 parameter you are interested in, and call @code{sysconf} only if the
970 macro is not defined.  For example, here is how to test whether job
971 control is supported:
972
973 @smallexample
974 @group
975 int
976 have_job_control (void)
977 @{
978 #ifdef _POSIX_JOB_CONTROL
979   return 1;
980 #else
981   int value = sysconf (_SC_JOB_CONTROL);
982   if (value < 0)
983     /* @r{If the system is that badly wedged,}
984        @r{there's no use trying to go on.}  */
985     fatal (strerror (errno));
986   return value;
987 #endif
988 @}
989 @end group
990 @end smallexample
991
992 Here is how to get the value of a numeric limit:
993
994 @smallexample
995 int
996 get_child_max ()
997 @{
998 #ifdef CHILD_MAX
999   return CHILD_MAX;
1000 #else
1001   int value = sysconf (_SC_CHILD_MAX);
1002   if (value < 0)
1003     fatal (strerror (errno));
1004   return value;
1005 #endif
1006 @}
1007 @end smallexample
1008
1009 @node Minimums
1010 @section Minimum Values for General Capacity Limits
1011
1012 Here are the names for the POSIX minimum upper bounds for the system
1013 limit parameters.  The significance of these values is that you can
1014 safely push to these limits without checking whether the particular
1015 system you are using can go that far.
1016
1017 @table @code
1018 @comment limits.h
1019 @comment POSIX.1
1020 @item _POSIX_AIO_LISTIO_MAX
1021 The most restrictive limit permitted by POSIX for the maximum number of
1022 I/O operations that can be specified in a list I/O call.  The value of
1023 this constant is @code{2}; thus you can add up to two new entries
1024 of the list of outstanding operations.
1025
1026 @comment limits.h
1027 @comment POSIX.1
1028 @item _POSIX_AIO_MAX
1029 The most restrictive limit permitted by POSIX for the maximum number of
1030 outstanding asynchronous I/O operations.  The value of this constant is
1031 @code{1}.  So you cannot expect that you can issue more than one
1032 operation and immediately continue with the normal work, receiving the
1033 notifications asynchronously.
1034
1035 @comment limits.h
1036 @comment POSIX.1
1037 @item _POSIX_ARG_MAX
1038 The value of this macro is the most restrictive limit permitted by POSIX
1039 for the maximum combined length of the @var{argv} and @var{environ}
1040 arguments that can be passed to the @code{exec} functions.
1041 Its value is @code{4096}.
1042
1043 @comment limits.h
1044 @comment POSIX.1
1045 @item _POSIX_CHILD_MAX
1046 The value of this macro is the most restrictive limit permitted by POSIX
1047 for the maximum number of simultaneous processes per real user ID.  Its
1048 value is @code{6}.
1049
1050 @comment limits.h
1051 @comment POSIX.1
1052 @item _POSIX_NGROUPS_MAX
1053 The value of this macro is the most restrictive limit permitted by POSIX
1054 for the maximum number of supplementary group IDs per process.  Its
1055 value is @code{0}.
1056
1057 @comment limits.h
1058 @comment POSIX.1
1059 @item _POSIX_OPEN_MAX
1060 The value of this macro is the most restrictive limit permitted by POSIX
1061 for the maximum number of files that a single process can have open
1062 simultaneously.  Its value is @code{16}.
1063
1064 @comment limits.h
1065 @comment POSIX.1
1066 @item _POSIX_SSIZE_MAX
1067 The value of this macro is the most restrictive limit permitted by POSIX
1068 for the maximum value that can be stored in an object of type
1069 @code{ssize_t}.  Its value is @code{32767}.
1070
1071 @comment limits.h
1072 @comment POSIX.1
1073 @item _POSIX_STREAM_MAX
1074 The value of this macro is the most restrictive limit permitted by POSIX
1075 for the maximum number of streams that a single process can have open
1076 simultaneously.  Its value is @code{8}.
1077
1078 @comment limits.h
1079 @comment POSIX.1
1080 @item _POSIX_TZNAME_MAX
1081 The value of this macro is the most restrictive limit permitted by POSIX
1082 for the maximum length of a time zone name.  Its value is @code{3}.
1083
1084 @comment limits.h
1085 @comment POSIX.2
1086 @item _POSIX2_RE_DUP_MAX
1087 The value of this macro is the most restrictive limit permitted by POSIX
1088 for the numbers used in the @samp{\@{@var{min},@var{max}\@}} construct
1089 in a regular expression.  Its value is @code{255}.
1090 @end table
1091
1092 @node Limits for Files
1093 @section Limits on File System Capacity
1094
1095 The POSIX.1 standard specifies a number of parameters that describe the
1096 limitations of the file system.  It's possible for the system to have a
1097 fixed, uniform limit for a parameter, but this isn't the usual case.  On
1098 most systems, it's possible for different file systems (and, for some
1099 parameters, even different files) to have different maximum limits.  For
1100 example, this is very likely if you use NFS to mount some of the file
1101 systems from other machines.
1102
1103 @pindex limits.h
1104 Each of the following macros is defined in @file{limits.h} only if the
1105 system has a fixed, uniform limit for the parameter in question.  If the
1106 system allows different file systems or files to have different limits,
1107 then the macro is undefined; use @code{pathconf} or @code{fpathconf} to
1108 find out the limit that applies to a particular file.  @xref{Pathconf}.
1109
1110 Each parameter also has another macro, with a name starting with
1111 @samp{_POSIX}, which gives the lowest value that the limit is allowed to
1112 have on @emph{any} POSIX system.  @xref{File Minimums}.
1113
1114 @cindex limits, link count of files
1115 @comment limits.h
1116 @comment POSIX.1
1117 @deftypevr Macro int LINK_MAX
1118 The uniform system limit (if any) for the number of names for a given
1119 file.  @xref{Hard Links}.
1120 @end deftypevr
1121
1122 @cindex limits, terminal input queue
1123 @comment limits.h
1124 @comment POSIX.1
1125 @deftypevr Macro int MAX_CANON
1126 The uniform system limit (if any) for the amount of text in a line of
1127 input when input editing is enabled.  @xref{Canonical or Not}.
1128 @end deftypevr
1129
1130 @comment limits.h
1131 @comment POSIX.1
1132 @deftypevr Macro int MAX_INPUT
1133 The uniform system limit (if any) for the total number of characters
1134 typed ahead as input.  @xref{I/O Queues}.
1135 @end deftypevr
1136
1137 @cindex limits, file name length
1138 @comment limits.h
1139 @comment POSIX.1
1140 @deftypevr Macro int NAME_MAX
1141 The uniform system limit (if any) for the length of a file name component.
1142 @end deftypevr
1143
1144 @comment limits.h
1145 @comment POSIX.1
1146 @deftypevr Macro int PATH_MAX
1147 The uniform system limit (if any) for the length of an entire file name (that
1148 is, the argument given to system calls such as @code{open}).
1149 @end deftypevr
1150
1151 @cindex limits, pipe buffer size
1152 @comment limits.h
1153 @comment POSIX.1
1154 @deftypevr Macro int PIPE_BUF
1155 The uniform system limit (if any) for the number of bytes that can be
1156 written atomically to a pipe.  If multiple processes are writing to the
1157 same pipe simultaneously, output from different processes might be
1158 interleaved in chunks of this size.  @xref{Pipes and FIFOs}.
1159 @end deftypevr
1160
1161 These are alternative macro names for some of the same information.
1162
1163 @comment dirent.h
1164 @comment BSD
1165 @deftypevr Macro int MAXNAMLEN
1166 This is the BSD name for @code{NAME_MAX}.  It is defined in
1167 @file{dirent.h}.
1168 @end deftypevr
1169
1170 @comment stdio.h
1171 @comment ISO
1172 @deftypevr Macro int FILENAME_MAX
1173 The value of this macro is an integer constant expression that
1174 represents the maximum length of a file name string.  It is defined in
1175 @file{stdio.h}.
1176
1177 Unlike @code{PATH_MAX}, this macro is defined even if there is no actual
1178 limit imposed.  In such a case, its value is typically a very large
1179 number.  @strong{This is always the case on the GNU system.}
1180
1181 @strong{Usage Note:} Don't use @code{FILENAME_MAX} as the size of an
1182 array in which to store a file name!  You can't possibly make an array
1183 that big!  Use dynamic allocation (@pxref{Memory Allocation}) instead.
1184 @end deftypevr
1185
1186 @node Options for Files
1187 @section Optional Features in File Support
1188
1189 POSIX defines certain system-specific options in the system calls for
1190 operating on files.  Some systems support these options and others do
1191 not.  Since these options are provided in the kernel, not in the
1192 library, simply using the GNU C library does not guarantee that any of these
1193 features is supported; it depends on the system you are using.  They can
1194 also vary between file systems on a single machine.
1195
1196 @pindex unistd.h
1197 This section describes the macros you can test to determine whether a
1198 particular option is supported on your machine.  If a given macro is
1199 defined in @file{unistd.h}, then its value says whether the
1200 corresponding feature is supported.  (A value of @code{-1} indicates no;
1201 any other value indicates yes.)  If the macro is undefined, it means
1202 particular files may or may not support the feature.
1203
1204 Since all the machines that support the GNU C library also support NFS,
1205 one can never make a general statement about whether all file systems
1206 support the @code{_POSIX_CHOWN_RESTRICTED} and @code{_POSIX_NO_TRUNC}
1207 features.  So these names are never defined as macros in the GNU C
1208 library.
1209
1210 @comment unistd.h
1211 @comment POSIX.1
1212 @deftypevr Macro int _POSIX_CHOWN_RESTRICTED
1213 If this option is in effect, the @code{chown} function is restricted so
1214 that the only changes permitted to nonprivileged processes is to change
1215 the group owner of a file to either be the effective group ID of the
1216 process, or one of its supplementary group IDs.  @xref{File Owner}.
1217 @end deftypevr
1218
1219 @comment unistd.h
1220 @comment POSIX.1
1221 @deftypevr Macro int _POSIX_NO_TRUNC
1222 If this option is in effect, file name components longer than
1223 @code{NAME_MAX} generate an @code{ENAMETOOLONG} error.  Otherwise, file
1224 name components that are too long are silently truncated.
1225 @end deftypevr
1226
1227 @comment unistd.h
1228 @comment POSIX.1
1229 @deftypevr Macro {unsigned char} _POSIX_VDISABLE
1230 This option is only meaningful for files that are terminal devices.
1231 If it is enabled, then handling for special control characters can
1232 be disabled individually.  @xref{Special Characters}.
1233 @end deftypevr
1234
1235 @pindex unistd.h
1236 If one of these macros is undefined, that means that the option might be
1237 in effect for some files and not for others.  To inquire about a
1238 particular file, call @code{pathconf} or @code{fpathconf}.
1239 @xref{Pathconf}.
1240
1241 @node File Minimums
1242 @section Minimum Values for File System Limits
1243
1244 Here are the names for the POSIX minimum upper bounds for some of the
1245 above parameters.  The significance of these values is that you can
1246 safely push to these limits without checking whether the particular
1247 system you are using can go that far.  In most cases GNU systems do not
1248 have these strict limitations.  The actual limit should be requested if
1249 necessary.
1250
1251 @table @code
1252 @comment limits.h
1253 @comment POSIX.1
1254 @item _POSIX_LINK_MAX
1255 The most restrictive limit permitted by POSIX for the maximum value of a
1256 file's link count.  The value of this constant is @code{8}; thus, you
1257 can always make up to eight names for a file without running into a
1258 system limit.
1259
1260 @comment limits.h
1261 @comment POSIX.1
1262 @item _POSIX_MAX_CANON
1263 The most restrictive limit permitted by POSIX for the maximum number of
1264 bytes in a canonical input line from a terminal device.  The value of
1265 this constant is @code{255}.
1266
1267 @comment limits.h
1268 @comment POSIX.1
1269 @item _POSIX_MAX_INPUT
1270 The most restrictive limit permitted by POSIX for the maximum number of
1271 bytes in a terminal device input queue (or typeahead buffer).
1272 @xref{Input Modes}.  The value of this constant is @code{255}.
1273
1274 @comment limits.h
1275 @comment POSIX.1
1276 @item _POSIX_NAME_MAX
1277 The most restrictive limit permitted by POSIX for the maximum number of
1278 bytes in a file name component.  The value of this constant is
1279 @code{14}.
1280
1281 @comment limits.h
1282 @comment POSIX.1
1283 @item _POSIX_PATH_MAX
1284 The most restrictive limit permitted by POSIX for the maximum number of
1285 bytes in a file name.  The value of this constant is @code{255}.
1286
1287 @comment limits.h
1288 @comment POSIX.1
1289 @item _POSIX_PIPE_BUF
1290 The most restrictive limit permitted by POSIX for the maximum number of
1291 bytes that can be written atomically to a pipe.  The value of this
1292 constant is @code{512}.
1293 @end table
1294
1295 @node Pathconf
1296 @section Using @code{pathconf}
1297
1298 When your machine allows different files to have different values for a
1299 file system parameter, you can use the functions in this section to find
1300 out the value that applies to any particular file.
1301
1302 These functions and the associated constants for the @var{parameter}
1303 argument are declared in the header file @file{unistd.h}.
1304
1305 @comment unistd.h
1306 @comment POSIX.1
1307 @deftypefun {long int} pathconf (const char *@var{filename}, int @var{parameter})
1308 This function is used to inquire about the limits that apply to
1309 the file named @var{filename}.
1310
1311 The @var{parameter} argument should be one of the @samp{_PC_} constants
1312 listed below.
1313
1314 The normal return value from @code{pathconf} is the value you requested.
1315 A value of @code{-1} is returned both if the implementation does not
1316 impose a limit, and in case of an error.  In the former case,
1317 @code{errno} is not set, while in the latter case, @code{errno} is set
1318 to indicate the cause of the problem.  So the only way to use this
1319 function robustly is to store @code{0} into @code{errno} just before
1320 calling it.
1321
1322 Besides the usual file name errors (@pxref{File Name Errors}),
1323 the following error condition is defined for this function:
1324
1325 @table @code
1326 @item EINVAL
1327 The value of @var{parameter} is invalid, or the implementation doesn't
1328 support the @var{parameter} for the specific file.
1329 @end table
1330 @end deftypefun
1331
1332 @comment unistd.h
1333 @comment POSIX.1
1334 @deftypefun {long int} fpathconf (int @var{filedes}, int @var{parameter})
1335 This is just like @code{pathconf} except that an open file descriptor
1336 is used to specify the file for which information is requested, instead
1337 of a file name.
1338
1339 The following @code{errno} error conditions are defined for this function:
1340
1341 @table @code
1342 @item EBADF
1343 The @var{filedes} argument is not a valid file descriptor.
1344
1345 @item EINVAL
1346 The value of @var{parameter} is invalid, or the implementation doesn't
1347 support the @var{parameter} for the specific file.
1348 @end table
1349 @end deftypefun
1350
1351 Here are the symbolic constants that you can use as the @var{parameter}
1352 argument to @code{pathconf} and @code{fpathconf}.  The values are all
1353 integer constants.
1354
1355 @table @code
1356 @comment unistd.h
1357 @comment POSIX.1
1358 @item _PC_LINK_MAX
1359 Inquire about the value of @code{LINK_MAX}.
1360
1361 @comment unistd.h
1362 @comment POSIX.1
1363 @item _PC_MAX_CANON
1364 Inquire about the value of @code{MAX_CANON}.
1365
1366 @comment unistd.h
1367 @comment POSIX.1
1368 @item _PC_MAX_INPUT
1369 Inquire about the value of @code{MAX_INPUT}.
1370
1371 @comment unistd.h
1372 @comment POSIX.1
1373 @item _PC_NAME_MAX
1374 Inquire about the value of @code{NAME_MAX}.
1375
1376 @comment unistd.h
1377 @comment POSIX.1
1378 @item _PC_PATH_MAX
1379 Inquire about the value of @code{PATH_MAX}.
1380
1381 @comment unistd.h
1382 @comment POSIX.1
1383 @item _PC_PIPE_BUF
1384 Inquire about the value of @code{PIPE_BUF}.
1385
1386 @comment unistd.h
1387 @comment POSIX.1
1388 @item _PC_CHOWN_RESTRICTED
1389 Inquire about the value of @code{_POSIX_CHOWN_RESTRICTED}.
1390
1391 @comment unistd.h
1392 @comment POSIX.1
1393 @item _PC_NO_TRUNC
1394 Inquire about the value of @code{_POSIX_NO_TRUNC}.
1395
1396 @comment unistd.h
1397 @comment POSIX.1
1398 @item _PC_VDISABLE
1399 Inquire about the value of @code{_POSIX_VDISABLE}.
1400
1401 @comment unistd.h
1402 @comment POSIX.1
1403 @item _PC_SYNC_IO
1404 Inquire about the value of @code{_POSIX_SYNC_IO}.
1405
1406 @comment unistd.h
1407 @comment POSIX.1
1408 @item _PC_ASYNC_IO
1409 Inquire about the value of @code{_POSIX_ASYNC_IO}.
1410
1411 @comment unistd.h
1412 @comment POSIX.1
1413 @item _PC_PRIO_IO
1414 Inquire about the value of @code{_POSIX_PRIO_IO}.
1415
1416 @comment unistd.h
1417 @comment POSIX.1g
1418 @item _PC_SOCK_MAXBUF
1419 Inquire about the value of @code{_POSIX_PIPE_BUF}.
1420 @end table
1421
1422 @node Utility Limits
1423 @section Utility Program Capacity Limits
1424
1425 The POSIX.2 standard specifies certain system limits that you can access
1426 through @code{sysconf} that apply to utility behavior rather than the
1427 behavior of the library or the operating system.
1428
1429 The GNU C library defines macros for these limits, and @code{sysconf}
1430 returns values for them if you ask; but these values convey no
1431 meaningful information.  They are simply the smallest values that
1432 POSIX.2 permits.
1433
1434 @comment limits.h
1435 @comment POSIX.2
1436 @deftypevr Macro int BC_BASE_MAX
1437 The largest value of @code{obase} that the @code{bc} utility is
1438 guaranteed to support.
1439 @end deftypevr
1440
1441 @comment limits.h
1442 @comment POSIX.2
1443 @deftypevr Macro int BC_DIM_MAX
1444 The largest number of elements in one array that the @code{bc} utility
1445 is guaranteed to support.
1446 @end deftypevr
1447
1448 @comment limits.h
1449 @comment POSIX.2
1450 @deftypevr Macro int BC_SCALE_MAX
1451 The largest value of @code{scale} that the @code{bc} utility is
1452 guaranteed to support.
1453 @end deftypevr
1454
1455 @comment limits.h
1456 @comment POSIX.2
1457 @deftypevr Macro int BC_STRING_MAX
1458 The largest number of characters in one string constant that the
1459 @code{bc} utility is guaranteed to support.
1460 @end deftypevr
1461
1462 @comment limits.h
1463 @comment POSIX.2
1464 @deftypevr Macro int COLL_WEIGHTS_MAX
1465 The largest number of weights that can necessarily be used in defining
1466 the collating sequence for a locale.
1467 @end deftypevr
1468
1469 @comment limits.h
1470 @comment POSIX.2
1471 @deftypevr Macro int EXPR_NEST_MAX
1472 The maximum number of expressions that can be nested within parenthesis
1473 by the @code{expr} utility.
1474 @end deftypevr
1475
1476 @comment limits.h
1477 @comment POSIX.2
1478 @deftypevr Macro int LINE_MAX
1479 The largest text line that the text-oriented POSIX.2 utilities can
1480 support.  (If you are using the GNU versions of these utilities, then
1481 there is no actual limit except that imposed by the available virtual
1482 memory, but there is no way that the library can tell you this.)
1483 @end deftypevr
1484
1485 @comment limits.h
1486 @comment POSIX.2
1487 @deftypevr Macro int EQUIV_CLASS_MAX
1488 The maximum number of weights that can be assigned to an entry of the
1489 @code{LC_COLLATE} category @samp{order} keyword in a locale definition.
1490 The GNU C library does not presently support locale definitions.
1491 @end deftypevr
1492
1493 @node Utility Minimums
1494 @section Minimum Values for Utility Limits
1495
1496 @table @code
1497 @comment limits.h
1498 @comment POSIX.2
1499 @item _POSIX2_BC_BASE_MAX
1500 The most restrictive limit permitted by POSIX.2 for the maximum value of
1501 @code{obase} in the @code{bc} utility.  Its value is @code{99}.
1502
1503 @comment limits.h
1504 @comment POSIX.2
1505 @item _POSIX2_BC_DIM_MAX
1506 The most restrictive limit permitted by POSIX.2 for the maximum size of
1507 an array in the @code{bc} utility.  Its value is @code{2048}.
1508
1509 @comment limits.h
1510 @comment POSIX.2
1511 @item _POSIX2_BC_SCALE_MAX
1512 The most restrictive limit permitted by POSIX.2 for the maximum value of
1513 @code{scale} in the @code{bc} utility.  Its value is @code{99}.
1514
1515 @comment limits.h
1516 @comment POSIX.2
1517 @item _POSIX2_BC_STRING_MAX
1518 The most restrictive limit permitted by POSIX.2 for the maximum size of
1519 a string constant in the @code{bc} utility.  Its value is @code{1000}.
1520
1521 @comment limits.h
1522 @comment POSIX.2
1523 @item _POSIX2_COLL_WEIGHTS_MAX
1524 The most restrictive limit permitted by POSIX.2 for the maximum number
1525 of weights that can necessarily be used in defining the collating
1526 sequence for a locale.  Its value is @code{2}.
1527
1528 @comment limits.h
1529 @comment POSIX.2
1530 @item _POSIX2_EXPR_NEST_MAX
1531 The most restrictive limit permitted by POSIX.2 for the maximum number
1532 of expressions nested within parenthesis when using the @code{expr} utility.
1533 Its value is @code{32}.
1534
1535 @comment limits.h
1536 @comment POSIX.2
1537 @item _POSIX2_LINE_MAX
1538 The most restrictive limit permitted by POSIX.2 for the maximum size of
1539 a text line that the text utilities can handle.  Its value is
1540 @code{2048}.
1541
1542 @comment limits.h
1543 @comment POSIX.2
1544 @item _POSIX2_EQUIV_CLASS_MAX
1545 The most restrictive limit permitted by POSIX.2 for the maximum number
1546 of weights that can be assigned to an entry of the @code{LC_COLLATE}
1547 category @samp{order} keyword in a locale definition.  Its value is
1548 @code{2}.  The GNU C library does not presently support locale
1549 definitions.
1550 @end table
1551
1552 @node String Parameters
1553 @section String-Valued Parameters
1554
1555 POSIX.2 defines a way to get string-valued parameters from the operating
1556 system with the function @code{confstr}:
1557
1558 @comment unistd.h
1559 @comment POSIX.2
1560 @deftypefun size_t confstr (int @var{parameter}, char *@var{buf}, size_t @var{len})
1561 This function reads the value of a string-valued system parameter,
1562 storing the string into @var{len} bytes of memory space starting at
1563 @var{buf}.  The @var{parameter} argument should be one of the
1564 @samp{_CS_} symbols listed below.
1565
1566 The normal return value from @code{confstr} is the length of the string
1567 value that you asked for.  If you supply a null pointer for @var{buf},
1568 then @code{confstr} does not try to store the string; it just returns
1569 its length.  A value of @code{0} indicates an error.
1570
1571 If the string you asked for is too long for the buffer (that is, longer
1572 than @code{@var{len} - 1}), then @code{confstr} stores just that much
1573 (leaving room for the terminating null character).  You can tell that
1574 this has happened because @code{confstr} returns a value greater than or
1575 equal to @var{len}.
1576
1577 The following @code{errno} error conditions are defined for this function:
1578
1579 @table @code
1580 @item EINVAL
1581 The value of the @var{parameter} is invalid.
1582 @end table
1583 @end deftypefun
1584
1585 Currently there is just one parameter you can read with @code{confstr}:
1586
1587 @table @code
1588 @comment unistd.h
1589 @comment POSIX.2
1590 @item _CS_PATH
1591 This parameter's value is the recommended default path for searching for
1592 executable files.  This is the path that a user has by default just
1593 after logging in.
1594
1595 @comment unistd.h
1596 @comment Unix98
1597 @item _CS_LFS_CFLAGS
1598 The returned string specifies which additional flags must be given to
1599 the C compiler if a source is compiled using the
1600 @code{_LARGEFILE_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1601
1602 @comment unistd.h
1603 @comment Unix98
1604 @item _CS_LFS_LDFLAGS
1605 The returned string specifies which additional flags must be given to
1606 the linker if a source is compiled using the
1607 @code{_LARGEFILE_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1608
1609 @comment unistd.h
1610 @comment Unix98
1611 @item _CS_LFS_LIBS
1612 The returned string specifies which additional libraries must be linked
1613 to the application if a source is compiled using the
1614 @code{_LARGEFILE_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1615
1616 @comment unistd.h
1617 @comment Unix98
1618 @item _CS_LFS_LINTFLAGS
1619 The returned string specifies which additional flags must be given to
1620 the lint tool if a source is compiled using the
1621 @code{_LARGEFILE_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1622
1623 @comment unistd.h
1624 @comment Unix98
1625 @item _CS_LFS64_CFLAGS
1626 The returned string specifies which additional flags must be given to
1627 the C compiler if a source is compiled using the
1628 @code{_LARGEFILE64_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1629
1630 @comment unistd.h
1631 @comment Unix98
1632 @item _CS_LFS64_LDFLAGS
1633 The returned string specifies which additional flags must be given to
1634 the linker if a source is compiled using the
1635 @code{_LARGEFILE64_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1636
1637 @comment unistd.h
1638 @comment Unix98
1639 @item _CS_LFS64_LIBS
1640 The returned string specifies which additional libraries must be linked
1641 to the application if a source is compiled using the
1642 @code{_LARGEFILE64_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1643
1644 @comment unistd.h
1645 @comment Unix98
1646 @item _CS_LFS64_LINTFLAGS
1647 The returned string specifies which additional flags must be given to
1648 the lint tool if a source is compiled using the
1649 @code{_LARGEFILE64_SOURCE} feature select macro; @pxref{Feature Test Macros}.
1650 @end table
1651
1652 The way to use @code{confstr} without any arbitrary limit on string size
1653 is to call it twice: first call it to get the length, allocate the
1654 buffer accordingly, and then call @code{confstr} again to fill the
1655 buffer, like this:
1656
1657 @smallexample
1658 @group
1659 char *
1660 get_default_path (void)
1661 @{
1662   size_t len = confstr (_CS_PATH, NULL, 0);
1663   char *buffer = (char *) xmalloc (len);
1664
1665   if (confstr (_CS_PATH, buf, len + 1) == 0)
1666     @{
1667       free (buffer);
1668       return NULL;
1669     @}
1670
1671   return buffer;
1672 @}
1673 @end group
1674 @end smallexample