summaryrefslogtreecommitdiff
path: root/usr/src/man/man4/nscd.conf.4
blob: 9cba157f0736ac232b915feb870dde872440a8b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
'\" te
.\"  Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved
.\"  Copyright 2019 Joyent, Inc.
.\" 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.  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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH NSCD.CONF 4 "Apr 10, 2019"
.SH NAME
nscd.conf \- name service cache daemon configuration
.SH SYNOPSIS
.LP
.nf
\fB/etc/nscd.conf\fR
.fi

.SH DESCRIPTION
.LP
The \fBnscd.conf\fR file contains the configuration information for
\fBnscd\fR(1M). Each line specifies either an \fIattribute\fR and a
\fIvalue\fR, or an \fIattribute\fR, \fIcachename\fR, and a \fIvalue\fR. Fields
are separated either by SPACE or TAB characters. A `\fB#\fR' (number sign)
indicates the beginning of a comment; characters up to the end of the line are
not interpreted by \fBnscd\fR.
.sp
.LP
\fIcachename\fR is represented by \fBhosts\fR, \fBipnodes\fR, \fBpasswd\fR,
\fBgroup\fR, \fBexec_attr\fR, \fBprof_attr\fR, \fBuser_attr\fR, \fBethers\fR,
\fBrpc\fR, \fBprotocols\fR, \fBnetworks\fR, \fBbootparams\fR,
\fBauth_attr\fR, \fBservices\fR, \fBnetmasks\fR, \fBprinters\fR,
\fBproject\fR, or \fBnetgroup\fR.
.sp
.LP
The \fIattribute\fR field supports the following:
.sp
.ne 2
.na
\fB\fBcheck-files\fR \fIcachename value\fR\fR
.ad
.sp .6
.RS 4n
Enables or disables checking the file belonging to the specified
\fIcachename\fR for changes. If enabled (which is the default), changes in the
corresponding file cause the cache to be invalidated within 10 seconds. Can be
disabled if files are never modified for a slight performance boost,
particularly over \fBNFS\fR. \fIvalue\fR may be either \fByes\fR or \fBno\fR.
.RE

.sp
.ne 2
.na
\fB\fBdebug-level\fR \fIvalue\fR\fR
.ad
.sp .6
.RS 4n
Sets the debug level desired. \fIvalue\fR may range from \fB0\fR (the default)
to \fB10\fR. Use of this option causes \fBnscd\fR(1M) to run in the foreground
and not become a daemon. Note that the output of the debugging command is not
likely to remain the same from release-to-release; scripts should \fInot\fR
rely on its format.
.RE

.sp
.ne 2
.na
\fB\fBenable-cache\fR \fIcachename value\fR\fR
.ad
.sp .6
.RS 4n
Enables or disables the specified cache. \fIvalue\fR may be either \fByes\fR or
\fBno\fR.
.RE

.sp
.ne 2
.na
\fB\fBenable-per-user-lookup\fR \fIvalue\fR\fR
.ad
.sp .6
.RS 4n
Enables or disables the ability of \fBnscd\fR to create a per-user \fBnscd\fR.
A per-user \fBnscd\fR performs per-user lookups and manages the per-user cache.
The per-user lookups might not be possible if the corresponding name service
switch backends do not support it or are not configured to do so. The value of
this attribute can be either \fByes\fR or \fBno\fR.
.RE

.sp
.ne 2
.na
\fB\fBkeep-hot-count\fR \fIcachename value\fR\fR
.ad
.sp .6
.RS 4n
This attribute allows the administrator to set the number of entries
\fBnscd\fR(1M) is to keep current in the specified cache. \fIvalue\fR is an
integer number which should approximate the number of entries frequently used
during the day.
.RE

.sp
.ne 2
.na
\fB\fBlogfile\fR \fIdebug-file-name\fR\fR
.ad
.sp .6
.RS 4n
Specifies name of the file to which debug info should be written. Use
\fB/dev/tty\fR for standard output.
.RE

.sp
.ne 2
.na
\fB\fBmaximum-per-user-nscd\fR \fIvalue\fR\fR
.ad
.sp .6
.RS 4n
Sets the maximum number of per-user \fBnscd\fRs that can be created and managed
by the main \fBnscd\fR daemon. The value is an integer.
.RE

.sp
.ne 2
.na
\fB\fBnegative-time-to-live\fR \fIcachename value\fR\fR
.ad
.sp .6
.RS 4n
Sets the time-to-live for negative entries (unsuccessful queries) in the
specified cache. \fIvalue\fR is in integer seconds. Can result in significant
performance improvements if there are several files owned by uids (user IDs)
not in system databases; should be kept small to reduce cache coherency
problems.
.RE

.sp
.ne 2
.na
\fB\fBper-user-nscd-time-to-live\fR \fIvalue\fR\fR
.ad
.sp .6
.RS 4n
Sets the time-to-live value for a per-user \fBnscd\fR based on the last time
the per-user \fBnscd\fR was active. The value is an integer that specifies a
number of seconds.
.RE

.sp
.ne 2
.na
\fB\fBpositive-time-to-live\fR \fIcachename value\fR\fR
.ad
.sp .6
.RS 4n
Sets the time-to-live for positive entries (successful queries) in the
specified cache. \fIvalue\fR is in integer seconds. Larger values increase
cache hit rates and reduce mean response times, but increase problems with
cache coherence. Note that sites that push (update) NIS maps nightly can set
the value to be the equivalent of 12 hours or more with very good performance
implications.
.RE

.sp
.ne 2
.na
\fB\fBsuggested-size\fR \fIcachename value\fR\fR
.ad
.sp .6
.RS 4n
Sets the suggested number of hash buckets in the specified cache. This
parameter should be changed only if the number of entries in the cache exceeds
the suggested size by more than a factor of four or five. Since this is the
internal hash table size, \fIvalue\fR should remain a prime number for optimum
efficiency.
.sp
This attribute is obsolete and will be silently ignored. \fBnscd\fR now
automatically adjusts the hash table size.
.RE

.SH ATTRIBUTES
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Availibility	SUNWcsu
_
Interface Stability	Committed
.TE

.SH SEE ALSO
.LP
\fBnscd\fR(1M), \fBauth_attr\fR(4), \fBbootparams\fR(4),
\fBethers\fR(4), \fBexec_attr\fR(4), \fBgroup\fR(4), \fBhosts\fR(4),
\fBnetmasks\fR(4), \fBnetworks\fR(4), \fBpasswd\fR(4), \fBprinters\fR(4),
\fBprof_attr\fR(4), \fBproject\fR(4), \fBprotocols\fR(4), \fBrpc\fR(4),
\fBservices\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5)