share/man/man4/nscd.conf.4

   1 '\" te
   2 .\"  Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH NSCD.CONF 4 "Mar 6, 2017"
   7 .SH NAME
   8 nscd.conf \- name service cache daemon configuration
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/etc/nscd.conf\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .LP
  17 The \fBnscd.conf\fR file contains the configuration information for
  18 \fBnscd\fR(8). Each line specifies either an \fIattribute\fR and a
  19 \fIvalue\fR, or an \fIattribute\fR, \fIcachename\fR, and a \fIvalue\fR. Fields
  20 are separated either by SPACE or TAB characters. A `\fB#\fR' (number sign)
  21 indicates the beginning of a comment; characters up to the end of the line are
  22 not interpreted by \fBnscd\fR.
  23 .sp
  24 .LP
  25 \fIcachename\fR is represented by \fBhosts\fR, \fBipnodes\fR, \fBpasswd\fR,
  26 \fBgroup\fR, \fBexec_attr\fR, \fBprof_attr\fR, \fBuser_attr\fR, \fBethers\fR,
  27 \fBrpc\fR, \fBprotocols\fR, \fBnetworks\fR, \fBbootparams\fR,
  28 \fBauth_attr\fR, \fBservices\fR, \fBnetmasks\fR, \fBprinters\fR, or
  29 \fBproject\fR.
  30 .sp
  31 .LP
  32 The \fIattribute\fR field supports the following:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBcheck-files\fR \fIcachename value\fR\fR
  37 .ad
  38 .sp .6
  39 .RS 4n
  40 Enables or disables checking the file belonging to the specified
  41 \fIcachename\fR for changes. If enabled (which is the default), changes in the
  42 corresponding file cause the cache to be invalidated within 10 seconds. Can be
  43 disabled if files are never modified for a slight performance boost,
  44 particularly over \fBNFS\fR. \fIvalue\fR may be either \fByes\fR or \fBno\fR.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBdebug-level\fR \fIvalue\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 Sets the debug level desired. \fIvalue\fR may range from \fB0\fR (the default)
  55 to \fB10\fR. Use of this option causes \fBnscd\fR(8) to run in the foreground
  56 and not become a daemon. Note that the output of the debugging command is not
  57 likely to remain the same from release-to-release; scripts should \fInot\fR
  58 rely on its format.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBenable-cache\fR \fIcachename value\fR\fR
  65 .ad
  66 .sp .6
  67 .RS 4n
  68 Enables or disables the specified cache. \fIvalue\fR may be either \fByes\fR or
  69 \fBno\fR.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBenable-per-user-lookup\fR \fIvalue\fR\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 Enables or disables the ability of \fBnscd\fR to create a per-user \fBnscd\fR.
  80 A per-user \fBnscd\fR performs per-user lookups and manages the per-user cache.
  81 The per-user lookups might not be possible if the corresponding name service
  82 switch backends do not support it or are not configured to do so. The value of
  83 this attribute can be either \fByes\fR or \fBno\fR.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBkeep-hot-count\fR \fIcachename value\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 This attribute allows the administrator to set the number of entries
  94 \fBnscd\fR(8) is to keep current in the specified cache. \fIvalue\fR is an
  95 integer number which should approximate the number of entries frequently used
  96 during the day.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBlogfile\fR \fIdebug-file-name\fR\fR
 103 .ad
 104 .sp .6
 105 .RS 4n
 106 Specifies name of the file to which debug info should be written. Use
 107 \fB/dev/tty\fR for standard output.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBmaximum-per-user-nscd\fR \fIvalue\fR\fR
 114 .ad
 115 .sp .6
 116 .RS 4n
 117 Sets the maximum number of per-user \fBnscd\fRs that can be created and managed
 118 by the main \fBnscd\fR daemon. The value is an integer.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBnegative-time-to-live\fR \fIcachename value\fR\fR
 125 .ad
 126 .sp .6
 127 .RS 4n
 128 Sets the time-to-live for negative entries (unsuccessful queries) in the
 129 specified cache. \fIvalue\fR is in integer seconds. Can result in significant
 130 performance improvements if there are several files owned by uids (user IDs)
 131 not in system databases; should be kept small to reduce cache coherency
 132 problems.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBper-user-nscd-time-to-live\fR \fIvalue\fR\fR
 139 .ad
 140 .sp .6
 141 .RS 4n
 142 Sets the time-to-live value for a per-user \fBnscd\fR based on the last time
 143 the per-user \fBnscd\fR was active. The value is an integer that specifies a
 144 number of seconds.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBpositive-time-to-live\fR \fIcachename value\fR\fR
 151 .ad
 152 .sp .6
 153 .RS 4n
 154 Sets the time-to-live for positive entries (successful queries) in the
 155 specified cache. \fIvalue\fR is in integer seconds. Larger values increase
 156 cache hit rates and reduce mean response times, but increase problems with
 157 cache coherence. Note that sites that push (update) NIS maps nightly can set
 158 the value to be the equivalent of 12 hours or more with very good performance
 159 implications.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fBsuggested-size\fR \fIcachename value\fR\fR
 166 .ad
 167 .sp .6
 168 .RS 4n
 169 Sets the suggested number of hash buckets in the specified cache. This
 170 parameter should be changed only if the number of entries in the cache exceeds
 171 the suggested size by more than a factor of four or five. Since this is the
 172 internal hash table size, \fIvalue\fR should remain a prime number for optimum
 173 efficiency.
 174 .sp
 175 This attribute is obsolete and will be silently ignored. \fBnscd\fR now
 176 automatically adjusts the hash table size.
 177 .RE
 178
 179 .SH ATTRIBUTES
 180 .LP
 181 See \fBattributes\fR(5) for descriptions of the following attributes:
 182 .sp
 183
 184 .sp
 185 .TS
 186 box;
 187 c | c
 188 l | l .
 189 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 190 _
 191 Availibility    SUNWcsu
 192 _
 193 Interface Stability     Committed
 194 .TE
 195
 196 .SH SEE ALSO
 197 .LP
 198 \fBnscd\fR(8), \fBauth_attr\fR(4), \fBbootparams\fR(4),
 199 \fBethers\fR(4), \fBexec_attr\fR(4), \fBgroup\fR(4), \fBhosts\fR(4),
 200 \fBnetmasks\fR(4), \fBnetworks\fR(4), \fBpasswd\fR(4), \fBprinters\fR(4),
 201 \fBprof_attr\fR(4), \fBproject\fR(4), \fBprotocols\fR(4), \fBrpc\fR(4),
 202 \fBservices\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5)