1.\" Copyright (c) 2005 Michael Bushkov <bushman@rsu.ru>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
--- 8 unchanged lines hidden (view full) ---
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: head/usr.sbin/nscd/nscd.8 158115 2006-04-28 12:03:38Z ume $
26.\"
27
28.Dd October 20, 2005
29.Dt CACHED 8
30.Os
31.Sh NAME
32.Nm cached
33.Nd caching server daemon
34.Sh SYNOPSIS
35.Nm
36.Op Fl nst
37.Op Fl i Ar cachename
38.Op Fl I Ar cachename
39.Sh DESCRIPTION
40.Nm
41- is the system caching daemon.
42It can cache almost all types of data and is basically intended to be used
43with
44.Pa nsswitch
45subsystem.
46The cache is actually per-user. It means that each user can work only with the
47cached data, that were cached by him and can't poison the cache of other users.
48.Nm
49supports 2 types of caching:
50.Bl -tag -width Pair
51.It Sy Type
52.Sy Description
53.It Common caching
54Each cached element is the the key+value pair.
55This type of caching supports policies, which are applied, when maximum
56number of cached elements is exceeded.
573 policies are available:
58.Pa FIFO
59(first in - first out),
60.Pa LRU
61(least recently used) and
62.Pa LFU
63(least frequently used).
64This type of caching is used with
65.Fn getXXXbyname
66- like functions.
67.It Multipart caching
68Each cached element is the part of the elements sequence.
69This type of caching is intended to be used with
70.Fn getXXXent
71- like functions.
72.El
73.Pp
74.Nm
75is able not only to cache elements, but to perform the actual nsswitch
76lookups by itself. To enable this feature use
77.Pa perform-actual-lookups
78parameter in the
79.Xr cached.conf 5
80.Pp
81.Nm
82recognizes the following runtime options:
83.Bl -tag -width indent
84.It Fl n
85Do not daemonize.
86.Nm
87doesn't fork and doesn't disconnect itself from the terminal.
88.It Fl s
89Single-threaded mode.
90Forces using only one thread for all processing purposes (it overrides
91the
92.Pa threads
93parameter in the
94.Xr cached.conf 5
95file).
96.It Fl t
97Trace mode.
98All trace messages would be written to the stdout.
99This mode is usually used with
100.Fl n
101and
102.Fl s
103flags for debugging purposes.
104.It Fl i Ar cachename
105Invalidates personal cache. When specified,
106.Nm
107acts as the administration tool. It asks the already
108running
109.Nm
110to invalidate the specified part of the cache of the
111calling user. For example, you may want sometimes
112to invalidate your
113.Pa hosts
114cache. You can specify
115.Pa all
116as the
117.Pa cachename
118to invalidate your personal cache as a whole. You
119can't use this option for the cachename, for which
120the
121.Pa perform-actual-lookups
122option is enabled.
123.It Fl I Ar cachename
124Invalidates the cache for every user. When specified,
125.Nm
126acts as the administration tool. It asks the already
127running
128.Nm
129to invalidate the specified part of the cache for
130every user. You can specify
131.Pa all
132as the
133.Pa cachename
134to invalidate the whole cache. Only root can use this
135option.
136.El
137.Sh FILES
138.Xr cached.conf 5
139.Sh SEE ALSO
140.Xr cached.conf 5
141.Xr nsswitch.conf 5
142.Xr nsdispatch 3
143.Sh "AUTHORS"
144Michael Bushkov
145.Aq bushman@rsu.ru
146.Sh "BUGS"
147To report bugs or suggestions please mail me
148.Aq bushman@rsu.ru
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
--- 8 unchanged lines hidden (view full) ---
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: head/usr.sbin/nscd/nscd.8 158115 2006-04-28 12:03:38Z ume $
26.\"
27
28.Dd October 20, 2005
29.Dt CACHED 8
30.Os
31.Sh NAME
32.Nm cached
33.Nd caching server daemon
34.Sh SYNOPSIS
35.Nm
36.Op Fl nst
37.Op Fl i Ar cachename
38.Op Fl I Ar cachename
39.Sh DESCRIPTION
40.Nm
41- is the system caching daemon.
42It can cache almost all types of data and is basically intended to be used
43with
44.Pa nsswitch
45subsystem.
46The cache is actually per-user. It means that each user can work only with the
47cached data, that were cached by him and can't poison the cache of other users.
48.Nm
49supports 2 types of caching:
50.Bl -tag -width Pair
51.It Sy Type
52.Sy Description
53.It Common caching
54Each cached element is the the key+value pair.
55This type of caching supports policies, which are applied, when maximum
56number of cached elements is exceeded.
573 policies are available:
58.Pa FIFO
59(first in - first out),
60.Pa LRU
61(least recently used) and
62.Pa LFU
63(least frequently used).
64This type of caching is used with
65.Fn getXXXbyname
66- like functions.
67.It Multipart caching
68Each cached element is the part of the elements sequence.
69This type of caching is intended to be used with
70.Fn getXXXent
71- like functions.
72.El
73.Pp
74.Nm
75is able not only to cache elements, but to perform the actual nsswitch
76lookups by itself. To enable this feature use
77.Pa perform-actual-lookups
78parameter in the
79.Xr cached.conf 5
80.Pp
81.Nm
82recognizes the following runtime options:
83.Bl -tag -width indent
84.It Fl n
85Do not daemonize.
86.Nm
87doesn't fork and doesn't disconnect itself from the terminal.
88.It Fl s
89Single-threaded mode.
90Forces using only one thread for all processing purposes (it overrides
91the
92.Pa threads
93parameter in the
94.Xr cached.conf 5
95file).
96.It Fl t
97Trace mode.
98All trace messages would be written to the stdout.
99This mode is usually used with
100.Fl n
101and
102.Fl s
103flags for debugging purposes.
104.It Fl i Ar cachename
105Invalidates personal cache. When specified,
106.Nm
107acts as the administration tool. It asks the already
108running
109.Nm
110to invalidate the specified part of the cache of the
111calling user. For example, you may want sometimes
112to invalidate your
113.Pa hosts
114cache. You can specify
115.Pa all
116as the
117.Pa cachename
118to invalidate your personal cache as a whole. You
119can't use this option for the cachename, for which
120the
121.Pa perform-actual-lookups
122option is enabled.
123.It Fl I Ar cachename
124Invalidates the cache for every user. When specified,
125.Nm
126acts as the administration tool. It asks the already
127running
128.Nm
129to invalidate the specified part of the cache for
130every user. You can specify
131.Pa all
132as the
133.Pa cachename
134to invalidate the whole cache. Only root can use this
135option.
136.El
137.Sh FILES
138.Xr cached.conf 5
139.Sh SEE ALSO
140.Xr cached.conf 5
141.Xr nsswitch.conf 5
142.Xr nsdispatch 3
143.Sh "AUTHORS"
144Michael Bushkov
145.Aq bushman@rsu.ru
146.Sh "BUGS"
147To report bugs or suggestions please mail me
148.Aq bushman@rsu.ru