| blob | 89b0451bd35e665d2a70c58fb72775bb3c979f0e |
1 '\" te
2 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
3 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
4 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/.
6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
7 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
8 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
9 .\" This notice shall appear on any product containing this material.
10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
12 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
13 .TH GETCONF 1 "Sep 27, 2013"
14 .SH NAME
15 getconf \- get configuration values
16 .SH SYNOPSIS
17 .SS "/usr/bin/getconf, /usr/xpg4/bin/getconf, /usr/xpg6/bin/getconf"
18 .LP
19 .nf
20 \fB/usr/bin/getconf\fR [\fB-v\fR \fIspecification\fR] \fIsystem_var\fR
21 .fi
23 .LP
24 .nf
25 \fB/usr/bin/getconf\fR [\fB-v\fR \fIspecification\fR] \fIpath_var\fR \fIpathname\fR
26 .fi
28 .LP
29 .nf
30 \fB/usr/bin/getconf\fR \fB-a\fR
31 .fi
33 .LP
34 .nf
35 \fB/usr/xpg4/bin/getconf\fR [\fB-v\fR \fIspecification\fR] \fIsystem_var\fR
36 .fi
38 .LP
39 .nf
40 \fB/usr/xpg4/bin/getconf\fR [\fB-v\fR \fIspecification\fR] \fIpath_var\fR \fIpathname\fR
41 .fi
43 .LP
44 .nf
45 \fB/usr/xpg4/bin/getconf\fR \fB-a\fR
46 .fi
48 .LP
49 .nf
50 \fB/usr/xpg6/bin/getconf\fR [\fB-v\fR \fIspecification\fR] \fIsystem_var\fR
51 .fi
53 .LP
54 .nf
55 \fB/usr/xpg6/bin/getconf\fR [\fB-v\fR \fIspecification\fR] \fIpath_var\fR \fIpathname\fR
56 .fi
58 .LP
59 .nf
60 \fB/usr/xpg6/bin/getconf\fR \fB-a\fR
61 .fi
63 .SS "ksh93"
64 .LP
65 .nf
66 \fBgetconf\fR [\fB-abdlpqrtw\fR] [\fB-c\fR RE] [\fB-n\fR RE] [\fB-s\fR RE] [\fB-v\fR \fIname\fR][\fIname\fR [\fIpath\fR [\fIvalue\fR]] ...]
67 .fi
69 .SH DESCRIPTION
70 .SS "/usr/bin/getconf, /usr/xpg4/bin/getconf, /usr/xpg6/bin/getconf"
71 .sp
72 .LP
73 In the first synopsis form, the \fBgetconf\fR utility writes to the standard
74 output the value of the variable specified by \fIsystem_var\fR, in accordance
75 with \fIspecification\fR if the \fB-v\fR option is used.
76 .sp
77 .LP
78 In the second synopsis form, \fBgetconf\fR writes to the standard output the
79 value of the variable specified by \fIpath_var\fR for the path specified by
80 \fIpathname\fR, in accordance with \fIspecification\fR if the \fB-v\fR option
81 is used.
82 .sp
83 .LP
84 In the third synopsis form, \fBconfig\fR writes to the standard output the
85 names of the current system configuration variables.
86 .sp
87 .LP
88 The value of each configuration variable is determined as if it were obtained
89 by calling the function from which it is defined to be available. The value
90 reflects conditions in the current operating environment.
91 .SS "ksh93"
92 .sp
93 .LP
94 The \fBgetconf\fR built-in in \fBksh93\fR is associated with the \fB/bin\fR and
95 \fB/usr/bin\fR paths. It is invoked when \fBgetconf\fR is executed without a
96 pathname prefix and the pathname search finds a \fB/bin/getconf\fR or
97 \fB/usr/bin/getconf\fR executable.
98 .sp
99 .LP
100 \fBgetconf\fR displays the system configuration value for \fIname\fR. If
101 \fIname\fR is a filesystem specific variable, the value is determined relative
102 to path, or, the current directory, if path is omitted. If \fIvalue\fR is
103 specified, \fBgetconf\fR attempts to change the process local value to
104 \fIvalue\fR. \fB-\fR can be used in place of path when it is not relevant. Only
105 writable variables can be set. \fBreadonly\fR variables cannot be changed.
106 .sp
107 .LP
108 The current value for \fIname\fR is written to the standard output. If
109 \fIname\fR is valid but undefined, \fBundefined\fR is written to the standard
110 output. If \fIname\fR is invalid or an error occurs in determining its value, a
111 diagnostic is written to standard error and \fBgetconf\fR exits with a
112 \fBnon-zero\fR exit status.
113 .sp
114 .LP
115 More than one variable can be set or queried by providing the \fIname path
116 value\fR 3-tuple for each variable, specifying \fB-\fR for value when querying.
117 .sp
118 .LP
119 If no operands are specified, all known variables are written in
120 \fIname\fR\fB=\fR\fIvalue\fR form to the standard output, one per line. Only
121 one of \fB--call\fR, \fB--name\fR or \fB--standard\fR can be specified.
122 .SH OPTIONS
123 .SS "/usr/bin/getconf, /usr/xpg4/bin/getconf, /usr/xpg6/bin/getconf"
124 .sp
125 .LP
126 The following options are supported by \fB/usr/bin/getconf\fR,
127 \fB/usr/xpg4/bin/getconf\fR, and \fB/usr/xpg6/bin/getconf\fR
128 .sp
129 .ne 2
130 .na
131 \fB\fB-a\fR\fR
132 .ad
133 .RS 19n
134 Writes the names of the current system configuration variables to the standard
135 output.
136 .RE
138 .sp
139 .ne 2
140 .na
141 \fB\fB-v\fR\fIspecification\fR\fR
142 .ad
143 .RS 19n
144 Gives the specification which governs the selection of values for configuration
145 variables.
146 .RE
148 .SS "ksh93"
149 .sp
150 .LP
151 The following options are supported by the \fBgetconf\fR built-in command in
152 \fBksh93\fR:
153 .sp
154 .ne 2
155 .na
156 \fB\fB-a\fR\fR
157 .ad
158 .br
159 .na
160 \fB\fB--all\fR\fR
161 .ad
162 .RS 24n
163 Call the native \fBgetconf -a\fR.
164 .RE
166 .sp
167 .ne 2
168 .na
169 \fB\fB-b\fR\fR
170 .ad
171 .br
172 .na
173 \fB\fB--base\fR\fR
174 .ad
175 .RS 24n
176 List base variable name without \fBcall\fR and standard prefixes.
177 .RE
179 .sp
180 .ne 2
181 .na
182 \fB\fB-c\fR\fR
183 .ad
184 .br
185 .na
186 \fB\fB--call=\fR\fIRE\fR\fR
187 .ad
188 .RS 24n
189 Display variables with \fBcall\fR prefix that matches \fIRE\fR. The \fBcall\fR
190 prefixes are:
191 .RS +4
192 .TP
193 .ie t \(bu
194 .el o
195 \fBCS\fR
196 .sp
197 \fBconfstr\fR(3C),
198 .RE
199 .RS +4
200 .TP
201 .ie t \(bu
202 .el o
203 \fBPC\fR
204 .sp
205 \fBpathconf\fR(2)
206 .RE
207 .RS +4
208 .TP
209 .ie t \(bu
210 .el o
211 \fBSC\fR
212 .sp
213 \fBsysconf\fR(3C)
214 .RE
215 .RS +4
216 .TP
217 .ie t \(bu
218 .el o
219 \fBSI\fR
220 .sp
221 \fBsysinfo\fR(2)
222 .RE
223 .RS +4
224 .TP
225 .ie t \(bu
226 .el o
227 \fBXX\fR
228 .sp
229 Constant value
230 .RE
231 .RE
233 .sp
234 .ne 2
235 .na
236 \fB\fB-d\fR\fR
237 .ad
238 .br
239 .na
240 \fB\fB--defined\fR\fR
241 .ad
242 .RS 24n
243 Only display defined values when no operands are specified.
244 .RE
246 .sp
247 .ne 2
248 .na
249 \fB\fB-l\fR\fR
250 .ad
251 .br
252 .na
253 \fB\fB--lowercase\fR\fR
254 .ad
255 .RS 24n
256 List variable names in lower case.
257 .RE
259 .sp
260 .ne 2
261 .na
262 \fB\fB-n\fR\fR
263 .ad
264 .br
265 .na
266 \fB\fB--name=\fR\fIRE\fR\fR
267 .ad
268 .RS 24n
269 Display variables with names that match \fIRE\fR.
270 .RE
272 .sp
273 .ne 2
274 .na
275 \fB\fB-p\fR\fR
276 .ad
277 .br
278 .na
279 \fB\fB--portable\fR\fR
280 .ad
281 .RS 24n
282 Display the named writable variables and values in a form that can be directly
283 executed by \fBksh93\fR(1) to set the values. If \fIname\fR is omitted, lists
284 all writable variables.
285 .RE
287 .sp
288 .ne 2
289 .na
290 \fB\fB-q\fR\fR
291 .ad
292 .br
293 .na
294 \fB\fB--quote\fR\fR
295 .ad
296 .RS 24n
297 Quote values (\fB"..."\fR).
298 .RE
300 .sp
301 .ne 2
302 .na
303 \fB\fB-r\fR\fR
304 .ad
305 .br
306 .na
307 \fB\fB--readonly\fR\fR
308 .ad
309 .RS 24n
310 Display the named \fBreadonly\fR variables in \fIname\fR\fB=\fR\fIvalue\fR
311 form. If \fIname\fR is omitted, lists all \fBreadonly\fR variables.
312 .RE
314 .sp
315 .ne 2
316 .na
317 \fB\fB-s\fR\fR
318 .ad
319 .br
320 .na
321 \fB\fB--standard=\fR\fIRE\fR\fR
322 .ad
323 .RS 24n
324 Display variables with standard prefix that matches \fIRE\fR. Use the
325 \fB--table\fR option to view all standard prefixes, including local additions.
326 .sp
327 The standard prefixes available on all systems are:
328 .sp
329 .in +2
330 .nf
332 AES
333 AST
334 C
335 GNU
336 POSIX
337 SVID
338 XBS5
339 XOPEN
340 XPG
341 .fi
342 .in -2
343 .sp
345 .RE
347 .sp
348 .ne 2
349 .na
350 \fB\fB-t\fR\fR
351 .ad
352 .br
353 .na
354 \fB\fB--table\fR\fR
355 .ad
356 .RS 24n
357 Display the internal table that contains the name, standard, standard section,
358 and system call symbol prefix for each variable.
359 .RE
361 .sp
362 .ne 2
363 .na
364 \fB\fB-w\fR\fR
365 .ad
366 .br
367 .na
368 \fB\fB--writable\fR\fR
369 .ad
370 .RS 24n
371 Display the named writable variables in \fIname\fR\fB=\fR\fIvalue\fR form. If
372 \fIname\fR is omitted, lists all writable variables.
373 .RE
375 .sp
376 .ne 2
377 .na
378 \fB\fB-v\fR\fR
379 .ad
380 .br
381 .na
382 \fB\fB--specification=name\fR\fR
383 .ad
384 .RS 24n
385 Call the native \fBgetconf -v\fR \fIname\fR.
386 .RE
388 .SH OPERANDS
389 .SS "/usr/bin/getconf, /usr/xpg4/bin/getconf, /usr/xpg6/bin/getconf"
390 .sp
391 .LP
392 The following operands are supported by \fB/usr/bin/getconf\fR,
393 \fB/usr/xpg4/bin/getconf\fR, and \fB/usr/xpg6/bin/getconf\fR:
394 .sp
395 .ne 2
396 .na
397 \fB\fIpath_var\fR\fR
398 .ad
399 .RS 12n
400 A name of a configuration variable whose value is available from the
401 \fBpathconf\fR(2) function. All of the values in the following table are
402 supported:
403 .RE
405 .sp
407 .sp
408 .TS
409 l l l
410 l l l .
411 ACL_ENABLED NAME_MAX XATTR_ENABLED
412 LINK_MAX PATH_MAX XATTR_EXISTS
413 MAX_CANON PIPE_BUF _POSIX_CHOWN_RESTRICTED
414 MAX_INPUT SATTR_ENABLED _POSIX_NO_TRUNC
415 MIN_HOLE_SIZE SATTR_EXISTS _POSIX_VDISABLE
416 .TE
418 .sp
419 .ne 2
420 .na
421 \fB\fIpathname\fR\fR
422 .ad
423 .RS 14n
424 A path name for which the variable specified by \fIpath_var\fR is to be
425 determined.
426 .RE
428 .sp
429 .ne 2
430 .na
431 \fB\fIsystem_var\fR\fR
432 .ad
433 .RS 14n
434 A name of a configuration variable whose value is available from
435 \fBconfstr\fR(3C) or \fBsysconf\fR(3C). All of the values in the following
436 table are supported:
437 .RE
439 .sp
441 .sp
442 .TS
443 l l
444 l l .
445 ARG_MAX BC_BASE_MAX
446 BC_DIM_MAX BC_SCALE_MAX
447 BC_STRING_MAX CHAR_BIT
448 CHARCLASS_NAME_MAX CHAR_MAX
449 CHAR_MIN CHILD_MAX
450 CLK_TCK COLL_WEIGHTS_MAX
451 CS_PATH EXPR_NEST_MAX
452 HOST_NAME_MAX INT_MAX
453 INT_MIN LFS64_CFLAGS
454 LFS64_LDFLAGS LFS64_LIBS
455 LFS64_LINTFLAGS LFS_CFLAGS
456 LFS_LDFLAGS LFS_LIBS
457 LFS_LINTFLAGS LINE_MAX
458 LONG_BIT LONG_MAX
459 LONG_MIN MB_LEN_MAX
460 NGROUPS_MAX NL_ARGMAX
461 NL_LANGMAX NL_MSGMAX
462 NL_NMAX NL_SETMAX
463 NL_TEXTMAX NPROCESSORS_CONF
464 NPROCESSORS_MAX NPROCESSORS_ONLN
465 NZERO OPEN_MAX
466 POSIX2_BC_BASE_MAX POSIX2_BC_DIM_MAX
467 POSIX2_BC_SCALE_MAX POSIX2_BC_STRING_MAX
468 POSIX2_C_BIND POSIX2_C_DEV
469 POSIX2_CHAR_TERM POSIX2_COLL_WEIGHTS_MAX
470 POSIX2_C_VERSION POSIX2_EXPR_NEST_MAX
471 POSIX2_FORT_DEV POSIX2_FORT_RUN
472 POSIX2_LINE_MAX POSIX2_LOCALEDEF
473 POSIX2_RE_DUP_MAX POSIX2_SW_DEV
474 POSIX2_SYMLINKS POSIX2_UPE
475 POSIX2_VERSION POSIX_ALLOC_SIZE_MIN
476 POSIX_REC_INCR_XFER_SIZE POSIX_REC_MAX_XFER_SIZE
477 POSIX_REC_MIN_XFER_SIZE POSIX_REC_XFER_ALIGN
478 POSIX_V6_ILP32_OFF32 POSIX_V6_ILP32_OFF32_CFLAGS
479 POSIX_V6_ILP32_OFF32_LDFLAGS POSIX_V6_ILP32_OFF32_LIBS
480 POSIX_V6_ILP32_OFFBIG POSIX_V6_ILP32_OFFBIG_CFLAGS
481 POSIX_V6_ILP32_OFFBIG_LDFLAGS POSIX_V6_ILP32_OFFBIG_LIBS
482 POSIX_V6_LP64_OFF64 POSIX_V6_LP64_OFF64_CFLAGS
483 POSIX_V6_LP64_OFF64_LDFLAGS POSIX_V6_LP64_OFF64_LIBS
484 POSIX_V6_LPBIG_OFFBIG POSIX_V6_LPBIG_OFFBIG_CFLAGS
485 POSIX_V6_LPBIG_OFFBIG_LDFLAGS POSIX_V6_LPBIG_OFFBIG_LIBS
486 POSIX_V6_WIDTH_RESTRICTED_ENVS SYMLINK_MAX
487 SYMLOOP_MAX _POSIX2_BC_BASE_MAX
488 _POSIX2_BC_DIM_MAX _POSIX2_BC_SCALE_MAX
489 _POSIX2_BC_STRING_MAX _POSIX2_CHARCLASS_NAME_MAX
490 _POSIX2_CHAR_TERM _POSIX2_COLL_WEIGHTS_MAX
491 _POSIX2_C_BIND _POSIX2_C_DEV
492 _POSIX2_C_VERSION _POSIX2_EXPR_NEST_MAX
493 _POSIX2_FORT_DEV _POSIX2_FORT_RUN
494 _POSIX2_LINE_MAX _POSIX2_LOCALEDEF
495 _POSIX2_PBS _POSIX2_PBS_ACCOUNTING
496 _POSIX2_PBS_CHECKPOINT _POSIX2_PBS_LOCATE
497 _POSIX2_PBS_MESSAGE _POSIX2_PBS_TRACK
498 _POSIX2_RE_DUP_MAX _POSIX2_SW_DEV
499 _POSIX2_UPE _POSIX2_VERSION
500 _POSIX_ADVISORY_INFO _POSIX_AIO_LISTIO_MAX
501 _POSIX_AIO_MAX _POSIX_ARG_MAX
502 _POSIX_ASYNC_IO _POSIX_BARRIERS
503 _POSIX_CHILD_MAX _POSIX_CLOCKRES_MIN
504 _POSIX_CLOCK_SELECTION _POSIX_CPUTIME
505 _POSIX_DELAYTIMER_MAX _POSIX_HOST_NAME_MAX
506 _POSIX_IPV6 _POSIX_JOB_CONTROL
507 _POSIX_LINK_MAX _POSIX_LOGIN_NAME_MAX
508 _POSIX_MAX_CANON _POSIX_MAX_INPUT
509 _POSIX_MONOTONIC_CLOCK _POSIX_MQ_OPEN_MAX
510 _POSIX_MQ_PRIO_MAX _POSIX_NAME_MAX
511 _POSIX_NGROUPS_MAX _POSIX_OPEN_MAX
512 _POSIX_PATH_MAX _POSIX_PIPE_BUF
513 _POSIX_PRIO_IO _POSIX_RAW_SOCKETS
514 _POSIX_READER_WRITER_LOCKS _POSIX_REGEXP
515 _POSIX_RE_DUP_MAX _POSIX_RTSIG_MAX
516 _POSIX_SAVED_IDS _POSIX_SEM_NSEMS_MAX
517 _POSIX_SEM_VALUE_MAX _POSIX_SHELL
518 _POSIX_SIGQUEUE_MAX _POSIX_SPAWN
519 _POSIX_SPIN_LOCKS _POSIX_SPORADIC_SERVER
520 _POSIX_SSIZE_MAX _POSIX_SS_REPL_MAX
521 _POSIX_STREAM_MAX _POSIX_SYMLINK_MAX
522 _POSIX_SYMLOOP_MAX _POSIX_SYNC_IO
523 _POSIX_THREAD_ATTR_STACKADDR _POSIX_THREAD_ATTR_STACKSIZE
524 _POSIX_THREAD_CPUTIME _POSIX_THREAD_DESTRUCTOR_ITERATIONS
525 _POSIX_THREAD_KEYS_MAX _POSIX_THREAD_PRIORITY_SCHEDULING
526 _POSIX_THREAD_PRIO_INHERIT _POSIX_THREAD_PRIO_PROTECT
527 _POSIX_THREAD_PROCESS_SHARED _POSIX_THREAD_SAFE_FUNCTIONS
528 _POSIX_THREAD_SPORADIC_SERVER _POSIX_THREAD_THREADS_MAX
529 _POSIX_TIMEOUTS _POSIX_TIMER_MAX
530 _POSIX_TRA_POSIX_TIMER_MAXCE _POSIX_TIMESTAMP_RESOLUTION
531 _POSIX_TRACE_EVENT_FILTER _POSIX_TRACE_EVENT_NAME_MAX
532 _POSIX_TRACE_INHERIT _POSIX_TRACE_LOG
533 _POSIX_TRACE_NAME_MAX _POSIX_TRACE_SYS_MAX
534 _POSIX_TRACE_USER_EVENT_MAX _POSIX_TTY_NAME_MAX
535 _POSIX_TYPED_MEMORY_OBJECTS _POSIX_TZNAME_MAX
536 _POSIX_VERSION _POSIX_V6_ILP32_OFF32
537 _POSIX_V6_ILP32_OFFBIG _POSIX_V6_LP64_OFF64
538 _POSIX_V6_LPBIG_OFFBIG _V6_ILP32_OFF32
539 _V6_ILP32_OFFBIG _V6_LP64_OFF64
540 _V6_LPBIG_OFFBIG RE_DUP_MAX
541 SCHAR_MAX SCHAR_MIN
542 SHRT_MAX SHRT_MIN
543 SSIZE_MAX STREAM_MAX
544 TMP_MAX TZNAME_MAX
545 UCHAR_MAX UINT_MAX
546 ULONG_MAX USHRT_MAX
547 WORD_BIT XBS5_ILP32_OFF32
548 XBS5_ILP32_OFF32_CFLAGS XBS5_ILP32_OFF32_LDFLAGS
549 XBS5_ILP32_OFF32_LIBS XBS5_ILP32_OFF32_LINTFLAGS
550 XBS5_ILP32_OFFBIG XBS5_ILP32_OFFBIG_CFLAGS
551 XBS5_ILP32_OFFBIG_LDFLAGS XBS5_ILP32_OFFBIG_LIBS
552 XBS5_ILP32_OFFBIG_LINTFLAGS XBS5_LP64_OFF64
553 XBS5_LP64_OFF64_CFLAGS XBS5_LP64_OFF64_LDFLAGS
554 XBS5_LP64_OFF64_LIBS XBS5_LP64_OFF64_LINTFLAGS
555 XBS5_LPBIG_OFFBIG XBS5_LPBIG_OFFBIG_CFLAGS
556 XBS5_LPBIG_OFFBIG_LDFLAGS XBS5_LPBIG_OFFBIG_LIBS
557 XBS5_LPBIG_OFFBIG_LINTFLAGS _XOPEN_CRYPT
558 _XOPEN_ENH_I18N _XOPEN_IOV_MAX
559 _XOPEN_LEGACY _XOPEN_NAME_MAX
560 _XOPEN_PATH_MAX _XOPEN_SHM
561 _XOPEN_STREAMS _XOPEN_VERSION
562 _XOPEN_XCU_VERSION _XOPEN_XPG2
563 _XOPEN_XPG3 _XOPEN_XPG4
564 .TE
566 .sp
567 .LP
568 The symbol \fBPATH\fR also is recognized, yielding the same value as the
569 \fBconfstr()\fR name value \fBCS_PATH\fR.
570 .SH USAGE
571 .sp
572 .LP
573 See \fBlargefile\fR(5) for the description of the behavior of
574 \fB/usr/bin/getconf\fR when encountering files greater than or equal to 2 Gbyte
575 ( 2^31 bytes).
576 .SH EXAMPLES
577 .LP
578 \fBExample 1 \fRWriting the Value of a Variable
579 .sp
580 .LP
581 This example illustrates the value of \fB{NGROUPS_MAX}:\fR
583 .sp
584 .in +2
585 .nf
586 example% \fBgetconf NGROUPS_MAX\fR
587 .fi
588 .in -2
589 .sp
591 .LP
592 \fBExample 2 \fRWriting the Value of a Variable for a Specific Directory
593 .sp
594 .LP
595 This example illustrates the value of \fBNAME_MAX\fR for a specific directory:
597 .sp
598 .in +2
599 .nf
600 example% \fBgetconf NAME_MAX /usr\fR
601 .fi
602 .in -2
603 .sp
605 .LP
606 \fBExample 3 \fRDealing with Unspecified Results
607 .sp
608 .LP
609 This example shows how to deal more carefully with results that might be
610 unspecified:
612 .sp
613 .in +2
614 .nf
615 \fBif value=$(getconf PATH_MAX /usr); then
616 if [ "$value" = "undefined" ]; then
617 echo PATH_MAX in /usr is infinite.
618 else
619 echo PATH_MAX in /usr is $value.
620 fi
621 else
622 echo Error in getconf.
623 fi\fR
624 .fi
625 .in -2
627 .sp
628 .LP
629 For example:
631 .sp
632 .in +2
633 .nf
634 \fBsysconf(_SC_POSIX_C_BIND);\fR
635 .fi
636 .in -2
638 .sp
639 .LP
640 and
642 .sp
643 .in +2
644 .nf
645 \fBsystem("getconf POSIX2_C_BIND");\fR
646 .fi
647 .in -2
649 .sp
650 .LP
651 in a C program could give different answers. The \fBsysconf\fR call supplies a
652 value that corresponds to the conditions when the program was either compiled
653 or executed, depending on the implementation. The \fBsystem\fR call to
654 \fBgetconf\fR always supplies a value corresponding to conditions when the
655 program is executed.
657 .SH ENVIRONMENT VARIABLES
658 .sp
659 .LP
660 See \fBenviron\fR(5) for descriptions of the following environment variables
661 that affect the execution of \fBgetconf\fR: \fBLANG\fR, \fBLC_ALL\fR,
662 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
663 .sp
664 .LP
665 The following environment variable is supported by the \fBksh93\fR built-in
666 \fBgetconf\fR command:
667 .sp
668 .ne 2
669 .na
670 \fB\fB_AST_FEATURES\fR\fR
671 .ad
672 .RS 17n
673 Local writable values that are different from the default are stored in the
674 \fB_AST_FEATURES\fR environment variable. The \fB_AST_FEATURES\fR value is a
675 space-separated list of \fIname path value\fR 3-tuples, where \fIname\fR is the
676 system configuration name, \fIpath\fR is the corresponding path, \fB-\fR if no
677 path is applicable, and \fIvalue\fR is the system configuration value.
678 .RE
680 .SH EXIT STATUS
681 .sp
682 .LP
683 The following exit values are returned:
684 .sp
685 .ne 2
686 .na
687 \fB\fB0\fR\fR
688 .ad
689 .RS 6n
690 The specified variable is valid and information about its current state was
691 written successfully.
692 .RE
694 .sp
695 .ne 2
696 .na
697 \fB\fB>0\fR\fR
698 .ad
699 .RS 6n
700 An error occurred.
701 .RE
703 .SH ATTRIBUTES
704 .sp
705 .LP
706 See \fBattributes\fR(5) for descriptions of the following attributes:
707 .SS "/usr/bin/getconf, /usr/xpg4/bin/getconf, /usr/xpg6/bin/getconf"
708 .sp
710 .sp
711 .TS
712 box;
713 c | c
714 l | l .
715 ATTRIBUTE TYPE ATTRIBUTE VALUE
716 _
717 Interface Stability Committed
718 _
719 Standard See \fBstandards\fR(5).
720 .TE
722 .SS "ksh93"
723 .sp
725 .sp
726 .TS
727 box;
728 c | c
729 l | l .
730 ATTRIBUTE TYPE ATTRIBUTE VALUE
731 _
732 Interface Stability See below.
733 .TE
735 .sp
736 .LP
737 The \fBksh93\fR built-in binding to \fB/bin\fR and \fB/usr/bin\fR is Volatile.
738 The built-in command-line interface is Committed.
739 .SH SEE ALSO
740 .sp
741 .LP
742 \fBksh93\fR(1), \fBsh\fR(1), \fBpathconf\fR(2), \fBsysinfo\fR(2),
743 \fBconfstr\fR(3C), \fBsysconf\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5),
744 \fBlargefile\fR(5), \fBstandards\fR(5)