Clarify variation of file-system parameters.
[kopensolaris-gnu/glibc.git] / manual / conf.texi
1 @node System Configuration, Language Features, System Information, Top
2 @chapter System Configuration Parameters
3
4 The functions and macros listed in this chapter give information about
5 configuration parameters of the operating system---for example, capacity
6 limits, presence of optional POSIX features, and the default path for
7 executable files (@pxref{String Parameters}).
8
9 @menu
10 * General Limits::           Constants and functions that describe
11                                 various process-related limits that have
12                                 one uniform value for any given machine.
13 * System Options::           Optional POSIX features.
14 * Version Supported::        Version numbers of POSIX.1 and POSIX.2.
15 * Sysconf::                  Getting specific configuration values
16                                 of general limits and system options.
17 * Minimums::                 Minimum values for general limits.
18
19 * Limits for Files::         Size limitations that pertain to individual files.
20                                 These can vary between file systems
21                                 or even from file to file.
22 * Options for Files::        Optional features that some files may support.
23 * File Minimums::            Minimum values for file limits.
24 * Pathconf::                 Getting the limit values for a particular file.
25
26 * Utility Limits::           Capacity limits of some POSIX.2 utility programs.
27 * Utility Minimums::         Minimum allowable values of those limits.
28
29 * String Parameters::        Getting the default search path.
30 @end menu
31
32 @node General Limits
33 @section General Capacity Limits
34 @cindex POSIX capacity limits
35 @cindex limits, POSIX
36 @cindex capacity limits, POSIX
37
38 The POSIX.1 and POSIX.2 standards specify a number of parameters that
39 describe capacity limitations of the system.  These limits can be fixed
40 constants for a given operating system, or they can vary from machine to
41 machine.  For example, some limit values may be configurable by the
42 system administrator, either at run time or by rebuilding the kernel,
43 and this should not require recompiling application programs.
44
45 @pindex limits.h
46 Each of the following limit parameters has a macro that is defined in
47 @file{limits.h} only if the system has a fixed, uniform limit for the
48 parameter in question.  If the system allows different file systems or
49 files to have different limits, then the macro is undefined; use
50 @code{sysconf} to find out the limit that applies at a particular time
51 on a particular machine.  @xref{Sysconf}.
52
53 Each of these parameters also has another macro, with a name starting
54 with @samp{_POSIX}, which gives the lowest value that the limit is
55 allowed to have on @emph{any} POSIX system.  @xref{Minimums}.
56
57 @cindex limits, program argument size
58 @comment limits.h
59 @comment POSIX.1
60 @deftypevr Macro int ARG_MAX
61 If defined, the unvarying maximum combined length of the @var{argv} and
62 @var{environ} arguments that can be passed to the @code{exec} functions.
63 @end deftypevr
64
65 @cindex limits, number of processes
66 @comment limits.h
67 @comment POSIX.1
68 @deftypevr Macro int CHILD_MAX
69 If defined, the unvarying maximum number of processes that can exist
70 with the same real user ID at any one time.
71 @end deftypevr
72
73 @cindex limits, number of open files
74 @comment limits.h
75 @comment POSIX.1
76 @deftypevr Macro int OPEN_MAX
77 If defined, the unvarying maximum number of files that a single process
78 can have open simultaneously.
79 @end deftypevr
80
81 @comment limits.h
82 @comment POSIX.1
83 @deftypevr Macro int STREAM_MAX
84 If defined, the unvarying maximum number of streams that a single
85 process can have open simultaneously.  @xref{Opening Streams}.
86 @end deftypevr
87
88 @cindex limits, time zone name length
89 @comment limits.h
90 @comment POSIX.1
91 @deftypevr Macro int TZNAME_MAX
92 If defined, the unvarying maximum length of a time zone name.
93 @xref{Time Zone Functions}.
94 @end deftypevr
95
96 These limit macros are always defined in @file{limits.h}.
97
98 @cindex limits, number of supplementary group IDs
99 @comment limits.h
100 @comment POSIX.1
101 @deftypevr Macro int NGROUPS_MAX
102 The maximum number of supplementary group IDs that one process can have.
103
104 The value of this macro is actually a lower bound for the maximum.  That
105 is, you can count on being able to have that many supplementary group
106 IDs, but a particular machine might let you have even more.  You can use
107 @code{sysconf} to see whether a particular machine will let you have
108 more (@pxref{Sysconf}).
109 @end deftypevr
110
111 @comment limits.h
112 @comment POSIX.1
113 @deftypevr Macro int SSIZE_MAX
114 The largest value that can fit in an object of type @code{ssize_t}.
115 Effectively, this is the limit on the number of bytes that can be read
116 or written in a single operation.
117
118 This macro is defined in all POSIX systems because this limit is never
119 configurable.
120 @end deftypevr
121
122 @comment limits.h
123 @comment POSIX.2
124 @deftypevr Macro int RE_DUP_MAX
125 The largest number of repetitions you are guaranteed is allowed in the
126 construct @samp{\@{@var{min},@var{max}\@}} in a regular expression.
127
128 The value of this macro is actually a lower bound for the maximum.  That
129 is, you can count on being able to have that many supplementary group
130 IDs, but a particular machine might let you have even more.  You can use
131 @code{sysconf} to see whether a particular machine will let you have
132 more (@pxref{Sysconf}).  And even the value that @code{sysconf} tells
133 you is just a lower bound---larger values might work.
134
135 This macro is defined in all POSIX.2 systems, because POSIX.2 says it
136 should always be defined even if there is no specific imposed limit.
137 @end deftypevr
138
139 @node System Options
140 @section Overall System Options
141 @cindex POSIX optional features
142 @cindex optional POSIX features
143
144 POSIX defines certain system-specific options that not all POSIX systems
145 support.  Since these options are provided in the kernel, not in the
146 library, simply using the GNU C library does not guarantee any of these
147 features is supported; it depends on the system you are using.
148
149 @pindex unistd.h
150 You can test for the availability of a given option using the macros in
151 this section, together with the function @code{sysconf}.  The macros are
152 defined only if you include @file{unistd.h}.
153
154 For the following macros, if the macro is defined in @file{unistd.h},
155 then the option is supported.  Otherwise, the option may or may not be
156 supported; use @code{sysconf} to find out.  @xref{Sysconf}.
157
158 @comment unistd.h
159 @comment POSIX.1
160 @deftypevr Macro int _POSIX_JOB_CONTROL
161 If this symbol is defined, it indicates that the system supports job
162 control.  Otherwise, the implementation behaves as if all processes
163 within a session belong to a single process group.  @xref{Job Control}.
164 @end deftypevr
165
166 @comment unistd.h
167 @comment POSIX.1
168 @deftypevr Macro int _POSIX_SAVED_IDS
169 If this symbol is defined, it indicates that the system remembers the
170 effective user and group IDs of a process before it executes an
171 executable file with the set-user-ID or set-group-ID bits set, and that
172 explicitly changing the effective user or group IDs back to these values
173 is permitted.  If this option is not defined, then if a nonprivileged
174 process changes its effective user or group ID to the real user or group
175 ID of the process, it can't change it back again.  @xref{Enable/Disable
176 Setuid}.
177 @end deftypevr
178
179 For the following macros, if the macro is defined in @file{unistd.h},
180 then its value indicates whether the option is supported.  A value of
181 @code{-1} means no, and any other value means yes.  If the macro is not
182 defined, then the option may or may not be supported; use @code{sysconf}
183 to find out.  @xref{Sysconf}.
184
185 @comment unistd.h
186 @comment POSIX.2
187 @deftypevr Macro int _POSIX2_C_DEV
188 If this symbol is defined, it indicates that the system has the POSIX.2
189 C compiler command, @code{c89}.  The GNU C library always defines this
190 as @code{1}, on the assumption that you would not have installed it if
191 you didn't have a C compiler.
192 @end deftypevr
193
194 @comment unistd.h
195 @comment POSIX.2
196 @deftypevr Macro int _POSIX2_FORT_DEV
197 If this symbol is defined, it indicates that the system has the POSIX.2
198 Fortran compiler command, @code{fort77}.  The GNU C library never
199 defines this, because we don't know what the system has.
200 @end deftypevr
201
202 @comment unistd.h
203 @comment POSIX.2
204 @deftypevr Macro int _POSIX2_FORT_RUN
205 If this symbol is defined, it indicates that the system has the POSIX.2
206 @code{asa} command to interpret Fortran carriage control.  The GNU C
207 library never defines this, because we don't know what the system has.
208 @end deftypevr
209
210 @comment unistd.h
211 @comment POSIX.2
212 @deftypevr Macro int _POSIX2_LOCALEDEF
213 If this symbol is defined, it indicates that the system has the POSIX.2
214 @code{localedef} command.  The GNU C library never defines this, because
215 we don't know what the system has.
216 @end deftypevr
217
218 @comment unistd.h
219 @comment POSIX.2
220 @deftypevr Macro int _POSIX2_SW_DEV
221 If this symbol is defined, it indicates that the system has the POSIX.2
222 commands @code{ar}, @code{make}, and @code{strip}.  The GNU C library
223 always defines this as @code{1}, on the assumption that you had to have
224 @code{ar} and @code{make} to install the library, and it's unlikely that
225 @code{strip} would be absent when those are present.
226 @end deftypevr
227
228 @node Version Supported
229 @section Which Version of POSIX is Supported
230
231 @comment unistd.h
232 @comment POSIX.1
233 @deftypevr Macro {long int} _POSIX_VERSION
234 This constant represents the version of the POSIX.1 standard to which
235 the implementation conforms.  For an implementation conforming to the
236 1990 POSIX.1 standard, the value is the integer @code{199009L}.
237
238 @code{_POSIX_VERSION} is always defined (in @file{unistd.h}) in any
239 POSIX system.
240
241 @strong{Usage Note:} Don't try to test whether the system supports POSIX
242 by including @file{unistd.h} and then checking whether
243 @code{_POSIX_VERSION} is defined.  On a non-POSIX system, this will
244 probably fail because there is no @file{unistd.h}.  We do not know of
245 @emph{any} way you can reliably test at compilation time whether your
246 target system supports POSIX or whether @file{unistd.h} exists.
247
248 The GNU C compiler predefines the symbol @code{__POSIX__} if the target
249 system is a POSIX system.  Provided you do not use any other compilers
250 on POSIX systems, testing @code{defined (__POSIX__)} will reliably
251 detect such systems.
252 @end deftypevr
253
254 @comment unistd.h
255 @comment POSIX.2
256 @deftypevr Macro {long int} _POSIX2_C_VERSION
257 This constant represents the version of the POSIX.2 standard which the
258 library and system kernel support.  We don't know what value this will
259 be for the first version of the POSIX.2 standard, because the value is
260 based on the year and month in which the standard is officially adopted.
261
262 The value of this symbol says nothing about the utilities installed on
263 the system.
264
265 @strong{Usage Note:} You can use this macro to tell whether a POSIX.1
266 system library supports POSIX.2 as well.  Any POSIX.1 system contains
267 @file{unistd.h}, so include that file and then test @code{defined
268 (_POSIX2_C_VERSION)}.
269 @end deftypevr
270
271 @node Sysconf
272 @section Using @code{sysconf}
273
274 When your system has configurable system limits, you can use the
275 @code{sysconf} function to find out the value that applies to any
276 particular machine.  The function and the associated @var{parameter}
277 constants are declared in the header file @file{unistd.h}.
278
279 @menu
280 * Sysconf Definition::        Detailed specifications of @code{sysconf}.
281 * Constants for Sysconf::     The list of parameters @code{sysconf} can read.
282 * Examples of Sysconf::       How to use @code{sysconf} and the parameter
283                                  macros properly together.
284 @end menu
285
286 @node Sysconf Definition
287 @subsection Definition of @code{sysconf}
288
289 @comment unistd.h
290 @comment POSIX.1
291 @deftypefun long int sysconf (int @var{parameter})
292 This function is used to inquire about runtime system parameters.  The
293 @var{parameter} argument should be one of the @samp{_SC_} symbols listed
294 below.
295
296 The normal return value from @code{sysconf} is the value you requested.
297 A value of @code{-1} is returned both if the implementation does not
298 impose a limit, and in case of an error.  
299
300 The following @code{errno} error conditions are defined for this function:
301
302 @table @code
303 @item EINVAL
304 The value of the @var{parameter} is invalid.
305 @end table
306 @end deftypefun
307
308 @node Constants for Sysconf
309 @subsection Constants for @code{sysconf} Parameters
310
311 Here are the symbolic constants for use as the @var{parameter} argument
312 to @code{sysconf}.  The values are all integer constants (more
313 specifically, enumeration type values).
314
315 @table @code
316 @comment unistd.h
317 @comment POSIX.1
318 @item _SC_ARG_MAX
319 Inquire about the parameter corresponding to @code{ARG_MAX}.
320
321 @comment unistd.h
322 @comment POSIX.1
323 @item _SC_CHILD_MAX
324 Inquire about the parameter corresponding to @code{CHILD_MAX}.
325
326 @comment unistd.h
327 @comment POSIX.1
328 @item _SC_OPEN_MAX
329 Inquire about the parameter corresponding to @code{OPEN_MAX}.
330
331 @comment unistd.h
332 @comment POSIX.1
333 @item _SC_STREAM_MAX
334 Inquire about the parameter corresponding to @code{STREAM_MAX}.
335
336 @comment unistd.h
337 @comment POSIX.1
338 @item _SC_TZNAME_MAX
339 Inquire about the parameter corresponding to @code{TZNAME_MAX}.
340
341 @comment unistd.h
342 @comment POSIX.1
343 @item _SC_NGROUPS_MAX
344 Inquire about the parameter corresponding to @code{NGROUPS_MAX}.
345
346 @comment unistd.h
347 @comment POSIX.1
348 @item _SC_JOB_CONTROL
349 Inquire about the parameter corresponding to @code{_POSIX_JOB_CONTROL}.
350
351 @comment unistd.h
352 @comment POSIX.1
353 @item _SC_SAVED_IDS
354 Inquire about the parameter corresponding to @code{_POSIX_SAVED_IDS}.
355
356 @comment unistd.h
357 @comment POSIX.1
358 @item _SC_VERSION
359 Inquire about the parameter corresponding to @code{_POSIX_VERSION}.
360
361 @comment unistd.h
362 @comment POSIX.1
363 @item _SC_CLK_TCK
364 Inquire about the parameter corresponding to @code{CLOCKS_PER_SEC};
365 @pxref{Basic CPU Time}.
366
367 @comment unistd.h
368 @comment POSIX.2
369 @item _SC_2_C_DEV
370 Inquire about whether the system has the POSIX.2 C compiler command,
371 @code{c89}.
372
373 @comment unistd.h
374 @comment POSIX.2
375 @item _SC_2_FORT_DEV
376 Inquire about whether the system has the POSIX.2 Fortran compiler
377 command, @code{fort77}.
378
379 @comment unistd.h
380 @comment POSIX.2
381 @item _SC_2_FORT_RUN
382 Inquire about whether the system has the POSIX.2 @code{asa} command to
383 interpret Fortran carriage control.
384
385 @comment unistd.h
386 @comment POSIX.2
387 @item _SC_2_LOCALEDEF
388 Inquire about whether the system has the POSIX.2 @code{localedef}
389 command.
390
391 @comment unistd.h
392 @comment POSIX.2
393 @item _SC_2_SW_DEV
394 Inquire about whether the system has the POSIX.2 commands @code{ar},
395 @code{make}, and @code{strip}.
396
397 @comment unistd.h
398 @comment POSIX.2
399 @item _SC_BC_BASE_MAX
400 Inquire about the maximum value of @code{obase} in the @code{bc}
401 utility.
402
403 @comment unistd.h
404 @comment POSIX.2
405 @item _SC_BC_DIM_MAX
406 Inquire about the maximum size of an array in the @code{bc}
407 utility.
408
409 @comment unistd.h
410 @comment POSIX.2
411 @item _SC_BC_SCALE_MAX
412 Inquire about the maximum value of @code{scale} in the @code{bc}
413 utility.
414
415 @comment unistd.h
416 @comment POSIX.2
417 @item _SC_BC_STRING_MAX
418 Inquire about the maximum size of a string constant in the
419 @code{bc} utility.
420
421 @comment unistd.h
422 @comment POSIX.2
423 @item _SC_COLL_WEIGHTS_MAX
424 Inquire about the maximum number of weights that can necessarily
425 be used in defining the collating sequence for a locale.
426
427 @comment unistd.h
428 @comment POSIX.2
429 @item _SC_EXPR_NEST_MAX
430 Inquire about the maximum number of expressions nested within
431 parenthesis when using the @code{expr} utility.
432
433 @comment unistd.h
434 @comment POSIX.2
435 @item _SC_LINE_MAX
436 Inquire about the maximum size of a text line that the POSIX.2 text
437 utilities can handle.
438
439 @comment unistd.h
440 @comment POSIX.2
441 @item _SC_VERSION
442 Inquire about the version number of POSIX.1 that the library and kernel
443 support.
444
445 @comment unistd.h
446 @comment POSIX.2
447 @item _SC_2_VERSION
448 Inquire about the version number of POSIX.2 that the system utilities
449 support.
450 @end table
451
452 @node Examples of Sysconf 
453 @subsection Examples of @code{sysconf}
454
455 We recommend that you first test for a macro definition for the
456 parameter you are interested in, and call @code{sysconf} only if the
457 macro is not defined.  For example, here is how to test whether job
458 control is supported:
459
460 @example
461 @group
462 int
463 have_job_control (void)
464 @{
465 #ifdef _POSIX_JOB_CONTROL
466   return 1;
467 #else
468   int value = sysconf (_SC_JOB_CONTROL);
469   if (value < 0)
470     /* @r{If the system is that badly wedged,}
471        @r{there's no use trying to go on.}  */
472     fatal (strerror (errno));
473   return value;
474 #endif
475 @}
476 @end group
477 @end example
478
479 Here is how to get the value of a numeric limit:
480
481 @example
482 int
483 get_child_max ()
484 @{
485 #ifdef CHILD_MAX
486   return CHILD_MAX;
487 #else
488   int value = sysconf (_SC_CHILD_MAX);
489   if (value < 0)
490     fatal (strerror (errno));
491   return value;
492 #endif
493 @}
494 @end example
495
496 @node Minimums
497 @section Minimum Values for General Capacity Limits
498
499 Here are the names for the POSIX minimum upper bounds for the system
500 limit parameters.  The significance of these values is that you can
501 safely push to these limits without checking whether the particular
502 system you are using can go that far.
503
504 @table @code
505 @comment limits.h
506 @comment POSIX.1
507 @item _POSIX_ARG_MAX
508 The value of this macro is the most restrictive limit permitted by POSIX
509 for the maximum combined length of the @var{argv} and @var{environ}
510 arguments that can be passed to the @code{exec} functions.  The value is
511 always @code{4096}.
512
513 @comment limits.h
514 @comment POSIX.1
515 @item _POSIX_CHILD_MAX
516 The value of this macro is the most restrictive limit permitted by POSIX
517 for the maximum number of simultaneous processes per real user ID.  Its
518 value is @code{6}.
519
520 @comment limits.h
521 @comment POSIX.1
522 @item _POSIX_NGROUPS_MAX
523 The value of this macro is the most restrictive limit permitted by POSIX
524 for the maximum number of supplementary group IDs per process.  Its
525 value is @code{0}.
526
527 @comment limits.h
528 @comment POSIX.1
529 @item _POSIX_OPEN_MAX
530 The value of this macro is the most restrictive limit permitted by POSIX
531 for the maximum number of files that a single process can have open
532 simultaneously.  Its value is @code{16}.
533
534 @comment limits.h
535 @comment POSIX.1
536 @item _POSIX_SSIZE_MAX
537 The value of this macro is the most restrictive limit permitted by POSIX
538 for the maximum value that can be stored in an object of type
539 @code{ssize_t}.  Its value is @code{32767}.
540
541 @comment limits.h
542 @comment POSIX.1
543 @item _POSIX_STREAM_MAX
544 The value of this macro is the most restrictive limit permitted by POSIX
545 for the maximum number of streams that a single process can have open
546 simultaneously.  Its value is @code{8}.
547
548 @comment limits.h
549 @comment POSIX.1
550 @item _POSIX_TZNAME_MAX
551 The value of this macro is the most restrictive limit permitted by POSIX
552 for the maximum length of a time zone name.  Its value is @code{3}.
553
554 @comment limits.h
555 @comment POSIX.2
556 @item _POSIX2_RE_DUP_MAX
557 The value of this macro is the most restrictive limit permitted by POSIX
558 for the numbers used in the @samp{\@{@var{min},@var{max}\@}} construct
559 in a regular expression.  Its value is @code{255}.
560 @end table
561
562 @node Limits for Files
563 @section Limits on File System Capacity
564
565 The POSIX.1 standard specifies a number of parameters that describe the
566 limitations of the file system.  It's possible for the system to have a
567 fixed, uniform limit for a parameter, but this isn't the usual case.  On
568 most systems, it's possible for different file systems (and, for some
569 parameters, even different files) to have different maximum limits.  For
570 example, this is very likely if you use NFS to mount some of the file
571 systems from other machines.
572
573 @pindex limits.h
574 Each of the following macros is defined in @file{limits.h} only if the
575 system has a fixed, uniform limit for the parameter in question.  If the
576 system allows different file systems or files to have different limits,
577 then the macro is undefined; use @code{pathconf} or @code{fpathconf} to
578 find out the limit that applies to a particular file.  @xref{Pathconf}.
579
580 Each parameter also has another macro, with a name starting with
581 @samp{_POSIX}, which gives the lowest value that the limit is allowed to
582 have on @emph{any} POSIX system.  @xref{File Minimums}.
583
584 @cindex limits, link count of files
585 @comment limits.h
586 @comment POSIX.1
587 @deftypevr Macro int LINK_MAX
588 The uniform system limit (if any) for the number of names for a given
589 file.  @xref{Hard Links}.
590 @end deftypevr
591
592 @cindex limits, terminal input queue
593 @comment limits.h
594 @comment POSIX.1
595 @deftypevr Macro int MAX_CANON
596 The uniform system limit (if any) for the amount of text in a line of
597 input when input editing is enabled.  @xref{Canonical or Not}.
598 @end deftypevr
599
600 @comment limits.h
601 @comment POSIX.1
602 @deftypevr Macro int MAX_INPUT
603 The uniform system limit (if any) for the total number of characters
604 typed ahead as input.  @xref{I/O Queues}.
605 @end deftypevr
606
607 @cindex limits, file name length
608 @comment limits.h
609 @comment POSIX.1
610 @deftypevr Macro int NAME_MAX
611 The uniform system limit (if any) for the length of a file name component.
612 @end deftypevr
613
614 @comment limits.h
615 @comment POSIX.1
616 @deftypevr Macro int PATH_MAX
617 The uniform system limit (if any) for the length of an entire file name (that
618 is, the argument given to system calls such as @code{open}).
619 @end deftypevr
620
621 @cindex limits, pipe buffer size
622 @comment limits.h
623 @comment POSIX.1
624 @deftypevr Macro int PIPE_BUF
625 The uniform system limit (if any) for the number of bytes that can be
626 written atomically to a pipe.  If multiple processes are writing to the
627 same pipe simultaneously, output from different processes might be
628 interleaved in chunks of this size.  @xref{Pipes and FIFOs}.
629 @end deftypevr
630
631 These are alternative macro names for some of the same information.
632
633 @comment dirent.h
634 @comment BSD
635 @deftypevr Macro int MAXNAMLEN
636 This is the BSD name for @code{NAME_MAX}.  It is defined in
637 @file{dirent.h}.
638 @end deftypevr
639
640 @comment stdio.h
641 @comment ANSI
642 @deftypevr Macro int FILENAME_MAX 
643 The value of this macro is an integer constant expression that
644 represents the maximum length of a file name string.  It is defined in
645 @file{stdio.h}.
646
647 Unlike @code{PATH_MAX}, this macro is defined even if there is no actual
648 limit imposed.  In such a case, its value is typically a very large
649 number.  @strong{This is always the case on the GNU system.}
650
651 @strong{Usage Note:} Don't use @code{FILENAME_MAX} as the size of an
652 array in which to store a file name!  You can't possibly make an array
653 that big!  Use dynamic allocation (@pxref{Memory Allocation}) instead.
654 @end deftypevr
655
656 @node Options for Files
657 @section Optional Features in File Support
658
659 POSIX defines certain system-specific options in the system calls for
660 operating on files.  Some systems support these options and others do
661 not.  Since these options are provided in the kernel, not in the
662 library, simply using the GNU C library does not guarantee any of these
663 features is supported; it depends on the system you are using.  They can
664 also vary between file systems on a single machine.
665
666 @pindex unistd.h
667 This section describes the macros you can test to determine whether a
668 particular option is supported on your machine.  If a given macro is
669 defined in @file{unistd.h}, then its value says whether the
670 corresponding feature is supported.  (A value of @code{-1} indicates no;
671 any other value indicates yes.)  If the macro is undefined, it means
672 particular files may or may not support the feature.
673
674 Since all the machines that support the GNU C library also support NFS,
675 one can never make a general statement about whether all file systems
676 support the @code{_POSIX_CHOWN_RESTRICTED} and @code{_POSIX_NO_TRUNC}
677 features.  So these names are never defined as macros in the GNU C
678 library.
679
680 @comment unistd.h
681 @comment POSIX.1
682 @deftypevr Macro int _POSIX_CHOWN_RESTRICTED
683 If this option is in effect, the @code{chown} function is restricted so
684 that the only changes permitted to nonprivileged processes is to change 
685 the group owner of a file to either be the effective group ID of the
686 process, or one of its supplementary group IDs.  @xref{File Owner}.
687 @end deftypevr
688
689 @comment unistd.h
690 @comment POSIX.1
691 @deftypevr Macro int _POSIX_NO_TRUNC
692 If this option is in effect, file name components longer than
693 @code{NAME_MAX} generate an @code{ENAMETOOLONG} error.  Otherwise, file
694 name components that are too long are silently truncated.
695 @end deftypevr
696
697 @comment unistd.h
698 @comment POSIX.1
699 @deftypevr Macro {unsigned char} _POSIX_VDISABLE
700 This option is only meaningful for files that are terminal devices.
701 If it is enabled, then handling for special control characters can
702 be disabled individually.  @xref{Special Characters}.
703 @end deftypevr
704
705 @pindex unistd.h
706 If one of these macros is undefined, that means that the option might be
707 in effect for some files and not for others.  To inquire about a
708 particular file, call @code{pathconf} or @code{fpathconf}.
709 @xref{Pathconf}.
710
711 @node File Minimums
712 @section Minimum Values for File System Limits
713
714 Here are the names for the POSIX minimum upper bounds for some of the
715 above parameters.  The significance of these values is that you can
716 safely push to these limits without checking whether the particular
717 system you are using can go that far.
718
719 @table @code
720 @comment limits.h
721 @comment POSIX.1
722 @item _POSIX_LINK_MAX
723 The most restrictive limit permitted by POSIX for the maximum value of a
724 file's link count.  The value of this constant is @code{8}; thus, you
725 can always make up to eight names for a file without running into a
726 system limit.
727
728 @comment limits.h
729 @comment POSIX.1
730 @item _POSIX_MAX_CANON
731 The most restrictive limit permitted by POSIX for the maximum number of
732 bytes in a canonical input line from a terminal device.  The value of
733 this constant is @code{255}.
734
735 @comment limits.h
736 @comment POSIX.1
737 @item _POSIX_MAX_INPUT
738 The most restrictive limit permitted by POSIX for the maximum number of
739 bytes in a terminal device input queue (or typeahead buffer).
740 @xref{Input Modes}.  The value of this constant is @code{255}.
741
742 @comment limits.h
743 @comment POSIX.1
744 @item _POSIX_NAME_MAX
745 The most restrictive limit permitted by POSIX for the maximum number of
746 bytes in a file name component.  The value of this constant is
747 @code{14}.
748
749 @comment limits.h
750 @comment POSIX.1
751 @item _POSIX_PATH_MAX
752 The most restrictive limit permitted by POSIX for the maximum number of
753 bytes in a file name.  The value of this constant is @code{255}.
754
755 @comment limits.h
756 @comment POSIX.1
757 @item _POSIX_PIPE_BUF
758 The most restrictive limit permitted by POSIX for the maximum number of
759 bytes that can be written atomically to a pipe.  The value of this
760 constant is @code{512}.
761 @end table
762
763 @node Pathconf
764 @section Using @code{pathconf}
765
766 When your machine allows different files to have different values for a
767 file system parameter, you can use the functions in this section to find
768 out the value that applies to any particular file.
769
770 These functions and the associated constants for the @var{parameter}
771 argument are declared in the header file @file{unistd.h}.
772
773 @comment unistd.h
774 @comment POSIX.1
775 @deftypefun long int pathconf (const char *@var{filename}, int @var{parameter})
776 This function is used to inquire about the limits that apply to
777 the file named @var{filename}.
778
779 The @var{parameter} argument should be one of the @samp{_PC_} constants
780 listed below.
781
782 The normal return value from @code{pathconf} is the value you requested.
783 A value of @code{-1} is returned both if the implementation does not
784 impose a limit, and in case of an error.  In the former case,
785 @code{errno} is not set, while in the latter case, @code{errno} is set
786 to indicate the cause of the problem.  So the only way to use this
787 function robustly is to store @code{0} into @code{errno} just before
788 calling it.
789
790 Besides the usual file name syntax errors (@pxref{File Name Errors}),
791 the following error conditions are defined for this function:
792
793 @table @code
794 @item EINVAL
795 The value of @var{parameter} is invalid, or the implementation doesn't
796 support the @var{parameter} for the specific file.
797 @end table
798 @end deftypefun
799
800 @comment unistd.h
801 @comment POSIX.1
802 @deftypefun long fpathconf (int @var{filedes}, int @var{parameter})
803 This is just like @code{pathconf} except that an open file descriptor
804 is used to specify the file for which information is requested, instead
805 of a file name.
806
807 The following @code{errno} error conditions are defined for this function:
808
809 @table @code
810 @item EBADF
811 The @var{filedes} argument is not a valid file descriptor.
812
813 @item EINVAL
814 The value of @var{parameter} is invalid, or the implementation doesn't
815 support the @var{parameter} for the specific file.
816 @end table
817 @end deftypefun
818
819 Here are the symbolic constants that you can use as the @var{parameter}
820 argument to @code{pathconf} and @code{fpathconf}.  The values are all
821 integer constants.
822
823 @table @code
824 @comment unistd.h
825 @comment POSIX.1
826 @item _PC_LINK_MAX
827 Inquire about the parameter corresponding to @code{LINK_MAX}.
828
829 @comment unistd.h
830 @comment POSIX.1
831 @item _PC_MAX_CANON
832 Inquire about the parameter corresponding to @code{MAX_CANON}.
833
834 @comment unistd.h
835 @comment POSIX.1
836 @item _PC_MAX_INPUT
837 Inquire about the parameter corresponding to @code{MAX_INPUT}.
838
839 @comment unistd.h
840 @comment POSIX.1
841 @item _PC_NAME_MAX
842 Inquire about the parameter corresponding to @code{NAME_MAX}.
843
844 @comment unistd.h
845 @comment POSIX.1
846 @item _PC_PATH_MAX
847 Inquire about the parameter corresponding to @code{PATH_MAX}.
848
849 @comment unistd.h
850 @comment POSIX.1
851 @item _PC_PIPE_BUF
852 Inquire about the parameter corresponding to @code{PIPE_BUF}.
853
854 @comment unistd.h
855 @comment POSIX.1
856 @item _PC_CHOWN_RESTRICTED
857 Inquire about the parameter corresponding to @code{_POSIX_CHOWN_RESTRICTED}.
858
859 @comment unistd.h
860 @comment POSIX.1
861 @item _PC_NO_TRUNC
862 Inquire about the parameter corresponding to @code{_POSIX_NO_TRUNC}.
863
864 @comment unistd.h
865 @comment POSIX.1
866 @item _PC_VDISABLE
867 Inquire about the parameter corresponding to @code{_POSIX_VDISABLE}.
868 @end table
869
870 @node Utility Limits
871 @section Utility Program Capacity Limits
872
873 The POSIX.2 standard specifies certain system limits that you can access
874 through @code{sysconf} that apply to utility behavior rather than the
875 behavior of the library or the operating system.
876
877 The GNU C library defines macros for these limits, and @code{sysconf}
878 returns values for them if you ask; but these values convey no
879 meaningful information.  They are simply the smallest values that
880 POSIX.2 permits.
881
882 @comment limits.h
883 @comment POSIX.2
884 @deftypevr Macro int BC_BASE_MAX
885 The largest value of @code{obase} that the @code{bc} utility is
886 guaranteed to support.
887 @end deftypevr
888
889 @comment limits.h
890 @comment POSIX.2
891 @deftypevr Macro int BC_SCALE_MAX
892 The largest value of @code{scale} that the @code{bc} utility is
893 guaranteed to support.
894 @end deftypevr
895
896 @comment limits.h
897 @comment POSIX.2
898 @deftypevr Macro int BC_DIM_MAX
899 The largest number of elements in one array that the @code{bc} utility
900 is guaranteed to support.
901 @end deftypevr
902
903 @comment limits.h
904 @comment POSIX.2
905 @deftypevr Macro int BC_STRING_MAX
906 The largest number of characters in one string constant that the
907 @code{bc} utility is guaranteed to support.
908 @end deftypevr
909
910 @comment limits.h
911 @comment POSIX.2
912 @deftypevr Macro int BC_DIM_MAX
913 The largest number of elements in one array that the @code{bc} utility
914 is guaranteed to support.
915 @end deftypevr
916
917 @comment limits.h
918 @comment POSIX.2
919 @deftypevr Macro int COLL_WEIGHTS_MAX
920 The largest number of weights that can necessarily be used in defining
921 the collating sequence for a locale.
922 @end deftypevr
923
924 @comment limits.h
925 @comment POSIX.2
926 @deftypevr Macro int EXPR_NEST_MAX
927 The maximum number of expressions that can be nested within parenthesis
928 by the @code{expr} utility.
929 @end deftypevr
930
931 @comment limits.h
932 @comment POSIX.2
933 @deftypevr Macro int LINE_MAX
934 The largest text line that the text-oriented POSIX.2 utilities can
935 support.  (If you are using the GNU versions of these utilities, then
936 there is no actual limit except that imposed by the available virtual
937 memory, but there is no way that the library can tell you this.)
938 @end deftypevr
939
940 @node Utility Minimums
941 @section Minimum Values for Utility Limits
942
943 @table @code
944 @comment limits.h
945 @comment POSIX.2
946 @item _POSIX2_BC_BASE_MAX
947 The most restrictive limit permitted by POSIX.2 for the maximum value of
948 @code{obase} in the @code{bc} utility.  Its value is @code{99}.
949
950 @comment limits.h
951 @comment POSIX.2
952 @item _POSIX2_BC_DIM_MAX
953 The most restrictive limit permitted by POSIX.2 for the maximum size of
954 an array in the @code{bc} utility.  Its value is @code{2048}.
955
956 @comment limits.h
957 @comment POSIX.2
958 @item _POSIX2_BC_SCALE_MAX
959 The most restrictive limit permitted by POSIX.2 for the maximum value of
960 @code{scale} in the @code{bc} utility.  Its value is @code{99}.
961
962 @comment limits.h
963 @comment POSIX.2
964 @item _POSIX2_BC_STRING_MAX
965 The most restrictive limit permitted by POSIX.2 for the maximum size of
966 a string constant in the @code{bc} utility.  Its value is @code{1000}.
967
968 @comment limits.h
969 @comment POSIX.2
970 @item _POSIX2_COLL_WEIGHTS_MAX
971 The most restrictive limit permitted by POSIX.2 for the maximum number
972 of weights that can necessarily be used in defining the collating
973 sequence for a locale.  Its value is @code{2}.
974
975 @comment limits.h
976 @comment POSIX.2
977 @item _POSIX2_EXPR_NEST_MAX
978 The most restrictive limit permitted by POSIX.2 for the maximum number
979 of expressions nested within parenthesis when using the @code{expr} utility.
980 Its value is @code{32}.
981
982 @comment limits.h
983 @comment POSIX.2
984 @item _POSIX2_LINE_MAX
985 The most restrictive limit permitted by POSIX.2 for the maximum size of
986 a text line that the text utilities can handle.  Its value is
987 @code{2048}.
988 @end table
989
990 @node String Parameters
991 @section String-Valued Parameters
992
993 POSIX.2 defines a way to get string-valued parameters from the operating
994 system with the function @code{confstr}:
995
996 @comment unistd.h
997 @comment POSIX.2
998 @deftypefun size_t confstr (int @var{parameter}, char *@var{buf}, size_t @var{len})
999 This function reads the value of a string-valued system parameter,
1000 storing the string into @var{len} bytes of memory space starting at
1001 @var{buf}.  The @var{parameter} argument should be one of the
1002 @samp{_CS_} symbols listed below.
1003
1004 The normal return value from @code{confstr} is the length of the string
1005 value that you asked for.  If you supply a null pointer for @var{buf},
1006 then @code{confstr} does not try to store the string; it just returns
1007 its length.  A value of @code{0} indicates an error.
1008
1009 If the string you asked for is too long for the buffer (that is, longer
1010 than @code{@var{len} - 1}), then @code{confstr} stores just that much
1011 (leaving room for the terminating null character).  You can tell that
1012 this has happened because @code{confstr} returns a value greater than or
1013 equal to @var{len}.
1014
1015 The following @code{errno} error conditions are defined for this function:
1016
1017 @table @code
1018 @item EINVAL
1019 The value of the @var{parameter} is invalid.
1020 @end table
1021 @end deftypefun
1022
1023 Currently there is just one parameter you can read with @code{confstr}:
1024
1025 @table @code
1026 @comment unistd.h
1027 @comment POSIX.2
1028 @item _CS_PATH
1029 This parameter's value is the recommended default path for searching for
1030 executable files.  This is the path that a user has by default just
1031 after logging in.
1032 @end table
1033
1034 The way to use @code{confstr} without any arbitrary limit on string size
1035 is to call it twice: first call it to get the length, allocate the
1036 buffer accordingly, and then call @code{confstr} again to fill the
1037 buffer, like this:
1038
1039 @example
1040 @group
1041 char *
1042 get_default_path (void)
1043 @{
1044   size_t len = confstr (_CS_PATH, NULL, 0);
1045   char *buffer = (char *) xmalloc (len);
1046
1047   if (confstr (_CS_PATH, buf, len + 1) == 0)
1048     @{
1049       free (buffer);
1050       return 0;
1051     @}
1052
1053   return buffer;
1054 @}
1055 @end group
1056 @end example