usr.sbin/cached/cached.8

   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.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  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$
  26 .\"
  27 .Dd October 20, 2005
  28 .Dt CACHED 8
  29 .Os
  30 .Sh NAME
  31 .Nm cached
  32 .Nd "caching server daemon"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl nst
  36 .Op Fl i Ar cachename
  37 .Op Fl I Ar cachename
  38 .Sh DESCRIPTION
  39 .Nm
  40 is the system caching daemon.
  41 It can cache almost all types of data and is basically intended to be used
  42 with the
  43 .Pa nsswitch
  44 subsystem.
  45 The cache is actually per-user.
  46 This means that each user can work only with the
  47 cached data that was cached locally and cannot poison the cache of other users.
  48 The
  49 .Nm
  50 utility supports two types of caching:
  51 .Bl -tag -width Pair
  52 .It Sy Type
  53 .Sy Description
  54 .It Common caching
  55 Each cached element is the the key+value pair.
  56 This type of caching supports policies which are applied when maximum
  57 number of cached elements is exceeded.
  58 Three policies are available:
  59 .Pa FIFO
  60 (first in - first out),
  61 .Pa LRU
  62 (least recently used) and
  63 .Pa LFU
  64 (least frequently used).
  65 This type of caching is used with the
  66 .Fn getXXXbyname
  67 family of functions.
  68 .It Multipart caching
  69 Each cached element is the part of the elements sequence.
  70 This type of caching is intended to be used with the
  71 .Fn getXXXent
  72 family of functions.
  73 .El
  74 .Pp
  75 The
  76 .Nm
  77 utility is able not only to cache elements, but to perform the actual nsswitch
  78 lookups by itself.
  79 To enable this feature use the
  80 .Pa perform-actual-lookups
  81 parameter in the
  82 .Xr cached.conf 5
  83 .Pp
  84 The
  85 .Nm
  86 utility recognizes the following runtime options:
  87 .Bl -tag -width indent
  88 .It Fl n
  89 Do not daemonize.
  90 .Nm
  91 will not fork or disconnect itself from the terminal.
  92 .It Fl s
  93 Single-threaded mode.
  94 Forces using only one thread for all processing purposes (it overrides
  95 the
  96 .Pa threads
  97 parameter in the
  98 .Xr cached.conf 5
  99 file).
 100 .It Fl t
 101 Trace mode.
 102 All trace messages will be written to stdout.
 103 This mode is usually used with
 104 .Fl n
 105 and
 106 .Fl s
 107 flags are used for debugging purposes.
 108 .It Fl i Ar cachename
 109 Invalidates personal cache.
 110 When specified,
 111 .Nm
 112 acts as the administration tool.
 113 It asks the already running
 114 .Nm
 115 to invalidate the specified part of the cache of the
 116 calling user.
 117 For example, sometimes you may want to invalidate your
 118 .Pa hosts
 119 cache.
 120 You can specify
 121 .Pa all
 122 as the
 123 .Pa cachename
 124 to invalidate your personal cache as a whole.
 125 You cannot use this option for the cachename, for which
 126 the
 127 .Pa perform-actual-lookups
 128 option is enabled.
 129 .It Fl I Ar cachename
 130 Invalidates the cache for every user.
 131 When specified,
 132 .Nm
 133 acts as the administration tool.
 134 It asks the already
 135 running
 136 .Nm
 137 to invalidate the specified part of the cache for
 138 every user.
 139 You can specify
 140 .Pa all
 141 as the
 142 .Pa cachename
 143 to invalidate the whole cache.
 144 Only the root can use this option.
 145 .El
 146 .Sh FILES
 147 .Xr cached.conf 5
 148 .Sh SEE ALSO
 149 .Xr cached.conf 5
 150 .Xr nsswitch.conf 5
 151 .Xr nsdispatch 3
 152 .Sh "AUTHORS"
 153 .An Michael Bushkov Aq bushman@rsu.ru
 154 .Sh "BUGS"
 155 To report bugs or suggestions please mail me:
 156 .Aq bushman@rsu.ru