summaryrefslogtreecommitdiffstats
path: root/usr.sbin/nscd
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2006-09-30 19:07:03 +0000
committerru <ru@FreeBSD.org>2006-09-30 19:07:03 +0000
commit99849399c0a14e1ff2773e87de05c18ee59ab128 (patch)
tree309e64ec3f7014ee546cba7fe8d72e3da8aef1d5 /usr.sbin/nscd
parent793f672a87878712ede431f9204d95b213440f66 (diff)
downloadFreeBSD-src-99849399c0a14e1ff2773e87de05c18ee59ab128.zip
FreeBSD-src-99849399c0a14e1ff2773e87de05c18ee59ab128.tar.gz
Revise markup.
Diffstat (limited to 'usr.sbin/nscd')
-rw-r--r--usr.sbin/nscd/nscd.857
-rw-r--r--usr.sbin/nscd/nscd.conf.5117
2 files changed, 109 insertions, 65 deletions
diff --git a/usr.sbin/nscd/nscd.8 b/usr.sbin/nscd/nscd.8
index 6bc6699..519338e 100644
--- a/usr.sbin/nscd/nscd.8
+++ b/usr.sbin/nscd/nscd.8
@@ -32,15 +32,17 @@
.Nd "caching server daemon"
.Sh SYNOPSIS
.Nm
-.Op Fl nst
+.Op Fl dnst
.Op Fl i Ar cachename
.Op Fl I Ar cachename
.Sh DESCRIPTION
+The
.Nm
+utility
is the system caching daemon.
It can cache almost all types of data and is basically intended to be used
with the
-.Pa nsswitch
+.Nm nsswitch
subsystem.
The cache is actually per-user.
This means that each user can work only with the
@@ -49,19 +51,19 @@ cache of other users.
The
.Nm
utility supports two types of caching:
-.Bl -tag -width Pair
+.Bl -tag -width ".Sy Type"
.It Sy Type
.Sy Description
.It Common caching
-Each cached element is the the key+value pair.
+Each cached element is the key+value pair.
This type of caching supports policies which are applied when maximum
number of cached elements is exceeded.
Three policies are available:
-.Pa FIFO
+.Cm FIFO
(first in - first out),
-.Pa LRU
+.Cm LRU
(least recently used) and
-.Pa LFU
+.Cm LFU
(least frequently used).
This type of caching is used with the
.Fn getXXXbyname
@@ -77,24 +79,26 @@ The
.Nm
utility is able not only to cache elements, but to perform the actual nsswitch
lookups by itself.
-To enable this feature use the
-.Pa perform-actual-lookups
-parameter in the
-.Xr cached.conf 5
+To enable this feature, use the
+.Va perform-actual-lookups
+parameter in
+.Xr cached.conf 5 .
.Pp
The
.Nm
utility recognizes the following runtime options:
.Bl -tag -width indent
+.\" .It Fl d
+.\" XXX Document me!
.It Fl n
-Do not daemonize.
+Do not daemonize;
.Nm
will not fork or disconnect itself from the terminal.
.It Fl s
Single-threaded mode.
Forces using only one thread for all processing purposes (it overrides
the
-.Pa threads
+.Va threads
parameter in the
.Xr cached.conf 5
file).
@@ -116,16 +120,17 @@ It asks the already running
to invalidate the specified part of the cache of the
calling user.
For example, sometimes you may want to invalidate your
-.Pa hosts
+.Dq Li hosts
cache.
You can specify
-.Pa all
+.Dq Li all
as the
-.Pa cachename
+.Ar cachename
to invalidate your personal cache as a whole.
-You cannot use this option for the cachename, for which
-the
-.Pa perform-actual-lookups
+You cannot use this option for the
+.Ar cachename
+for which the
+.Va perform-actual-lookups
option is enabled.
.It Fl I Ar cachename
Invalidates the cache for every user.
@@ -138,14 +143,14 @@ running
to invalidate the specified part of the cache for
every user.
You can specify
-.Pa all
+.Dq Li all
as the
-.Pa cachename
+.Ar cachename
to invalidate the whole cache.
Only the root can use this option.
.El
.Sh FILES
-.Bl -tag -width /etc/cached.conf -compact
+.Bl -tag -width ".Pa /etc/cached.conf" -compact
.It Pa /etc/cached.conf
The default configuration file.
.El
@@ -153,8 +158,8 @@ The default configuration file.
.Xr nsdispatch 3 ,
.Xr cached.conf 5 ,
.Xr nsswitch.conf 5
-.Sh "AUTHORS"
+.Sh AUTHORS
.An Michael Bushkov Aq bushman@rsu.ru
-.Sh "BUGS"
-To report bugs or suggestions please mail me:
-.Aq bushman@rsu.ru
+.Sh BUGS
+Please send bug reports and suggestions to
+.Aq bushman@rsu.ru .
diff --git a/usr.sbin/nscd/nscd.conf.5 b/usr.sbin/nscd/nscd.conf.5
index 46c3c84..6e5bec1 100644
--- a/usr.sbin/nscd/nscd.conf.5
+++ b/usr.sbin/nscd/nscd.conf.5
@@ -29,81 +29,120 @@
.Os
.Sh NAME
.Nm cached.conf
-.Nd "caching daemon configuration file manual page"
-.Sh "DESCRIPTION"
+.Nd "caching daemon configuration file"
+.Sh DESCRIPTION
+The
.Nm
+file
is used by the
.Xr cached 8
daemon and is read on its startup.
-Its syntax is mostly similar to the nscd.conf syntax in Linux and Solaris.
-It has some differences, though - see them below.
+Its syntax is mostly similar to the
+.Pa nscd.conf
+syntax in
+.Tn Linux
+and
+.Tn Solaris .
+It has some differences, though \[em] see them below.
.Pp
-Each line specifies either an attribute and a value, or an attribute,
-a cachename and a value.
-Usual cachenames are passwd, groups, hosts, services, protocols and rpc.
-You can also use any other cachename (for example, if some third-party
+Each line specifies either an attribute and a
+.Ar value ,
+or an attribute, a
+.Ar cachename
+and a
+.Ar value .
+Usual cachenames are
+.Dq Li passwd ,
+.Dq Li groups ,
+.Dq Li hosts ,
+.Dq Li services ,
+.Dq Li protocols
+and
+.Dq Li rpc .
+You can also use any other
+.Ar cachename
+(for example, if some third-party
application uses nsswitch).
-.Pp
-.Bl -tag -width Pair
-.It Sy threads [value]
+.Bl -tag -width indent
+.It Va threads Op Ar value
Number of threads, which would listen for connections and process requests.
The minimum is 1.
The default value is 8.
-.It Sy enable-cache [cachename] [yes|no]
-Enables or disables the cache for specified cachename.
-.It Sy positive-time-to-live [cachename] [value]
+.It Va enable-cache Oo Ar cachename Oc Op Cm yes | no
+Enables or disables the cache for specified
+.Ar cachename .
+.It Va positive-time-to-live Oo Ar cachename Oc Op Ar value
Sets the TTL (time-to-live) for the specified cache in seconds.
Larger values can increase system's performance, but they also can affect
the cache coherence.
The default value is 3600.
-.It Sy positive-policy [cachename] [fifo|lru|lfu]
+.It Va positive-policy Oo Ar cachename Oc Op Cm fifo | lru | lfu
The policy that is applied to erase some of the cache elements, when the
-size limit of the given cachename is exceeded.
-Possible policies are: fifo (first-in-first-out), lru (least-recently-used),
-lfu (least-frequently-used).
-The default policy is lru.
-.It Sy negative-time-to-live [cachename] [value]
+size limit of the given
+.Ar cachename
+is exceeded.
+Possible policies are:
+.Cm fifo
+(first-in-first-out),
+.Cm lru
+(least-recently-used), and
+.Cm lfu
+(least-frequently-used).
+The default policy is
+.Cm lru .
+.It Va negative-time-to-live Oo Ar cachename Oc Op Ar value
The TTL of the negative cached elements in seconds.
The larger values can significantly increase system performance in some
environments (when dealing with files with UIDs, which are not in system
databases, for example).
This number should be kept low to avoid the cache coherence problems.
The default value is 60.
-.It Sy negative-policy [cachename] [fifo|lru|lfu]
+.It Va negative-policy Oo Ar cachename Oc Op Cm fifo | lru | lfu
The same as the positive-policy, but this one is applied to the negative
-elements of the given cachename.
+elements of the given
+.Ar cachename .
The default policy is fifo.
-.It Sy suggested-size [cachename] [value]
+.It Va suggested-size Oo Ar cachename Oc Op Ar value
This is the internal hash table size.
The value should be a prime number for optimum performance.
You should only change this value when the number of cached elements is
significantly (in 5-10 times) greater then the default hash table size (255).
-.It Sy keep-hot-count [cachename] [value]
-The size limit of the cache with the given cachename.
+.It Va keep-hot-count Oo Ar cachename Oc Op Ar value
+The size limit of the cache with the given
+.Ar cachename .
When it is exceeded, the policy will be applied.
The default value is 2048.
-.It Sy perform-actual-lookups [cachename] [yes|no]
+.It Va perform-actual-lookups Oo Ar cachename Oc Op Cm yes | no
If enabled, the
.Xr cached 8
does not simply receive and cache the NSS-requests results, but performs
all the lookups by itself and only returns the responses.
-If this feature is enabled, then for the given cachename
+If this feature is enabled, then for the given
+.Ar cachename
.Xr cached 8
will act similarly to the NSCD.
.Pp
-.Pa NOTE:
-this feature is currently experimental - it supports only passwd, groups and
-services cachenames.
+.Sy NOTE :
+this feature is currently experimental \[em] it supports only
+.Dq Li passwd ,
+.Dq Li groups
+and
+.Dq Li services
+cachenames.
.El
-.Sh "NOTES"
-You can use
-.Sq #
+.Sh NOTES
+You can use the
+.Ql #
symbol at the beginning of the line for comments.
-.Sh "SEE ALSO"
+.Sh FILES
+.Bl -tag -width ".Pa /etc/cached.conf" -compact
+.It Pa /etc/cached.conf
+.El
+.Sh SEE ALSO
.Xr cached 8
-.Sh "AUTHORS"
-Michael Bushkov
-.Aq bushman@rsu.ru
-.Sh "BUGS"
-To report bugs or suggestions please mail me
+.Sh AUTHORS
+.An Michael Bushkov
.Aq bushman@rsu.ru
+.Sh BUGS
+Please send bug reports and suggestions to
+.Aq bushman@rsu.ru .
OpenPOWER on IntegriCloud