usr.sbin/sup/source/supservers.8

   1 .\"     $NetBSD: supservers.8,v 1.9 2002/02/08 01:38:56 ross Exp $
   2 .\"
   3 .\" Copyright (c) 1992 Carnegie Mellon University
   4 .\" All Rights Reserved.
   5 .\"
   6 .\" Permission to use, copy, modify and distribute this software and its
   7 .\" documentation is hereby granted, provided that both the copyright
   8 .\" notice and this permission notice appear in all copies of the
   9 .\" software, derivative works or modified versions, and any portions
  10 .\" thereof, and that both notices appear in supporting documentation.
  11 .\"
  12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  13 .\" CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  15 .\"
  16 .\" Carnegie Mellon requests users of this software to return to
  17 .\"
  18 .\"  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  19 .\"  School of Computer Science
  20 .\"  Carnegie Mellon University
  21 .\"  Pittsburgh PA 15213-3890
  22 .\"
  23 .\" any improvements or extensions that they make and grant Carnegie Mellon
  24 .\" the rights to redistribute these changes.
  25 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  26 .\" HISTORY
  27 .\" Revision 1.3  92/08/11  12:08:50  mrt
  28 .\"     Documented -C switch
  29 .\"     [92/08/11            mrt]
  30 .\"
  31 .TH SUPSERVERS 8 1/16/86
  32 .SH "NAME"
  33 supfilesrv, supscan \- sup server processes
  34 .SH "SYNOPSIS"
  35 supfilesrv
  36 [
  37 .I
  38 -4
  39 ] [
  40 .I
  41 -6
  42 ] [
  43 .I
  44 -d
  45 ] [
  46 .I
  47 -l
  48 ] [
  49 .I
  50 -q
  51 ] [
  52 .I
  53 -N
  54 ] [
  55 .I
  56 -P
  57 ] [
  58 .I -C MaxChildren
  59 ]
  60 .br
  61 supscan [
  62 .I
  63 -v
  64 ] [
  65 .I
  66 -s
  67 ] [
  68 .I
  69 collection
  70 ] [
  71 .I
  72 basedir
  73 ]
  74 .SH "DESCRIPTION"
  75 .I
  76 Supfilesrv
  77 is the server processes used to interact with
  78 .I
  79 sup
  80 client processes via the IP/TCP network protocol.
  81 This server
  82 normally is expected to be running on server machines at all times.
  83 Each machine with files of interest to users on other machines is
  84 expected to be a file server and should run
  85 .I
  86 supfilesrv.
  87
  88 A file server machine will service requests for both "private" and
  89 "system" file collections.
  90 No special action is necessary to support
  91 private collections, as the client user is expected to supply all
  92 necessary information.
  93 For system collections, if the base directory
  94 is not the default (see FILES below), an entry must be put into
  95 the directory list file; this entry is a single text line containing
  96 the name of the collection, one or more spaces, and the name of the
  97 base directory for that collection.
  98
  99 Each collection should have
 100 an entry in the host list file; this entry is a single text line
 101 containing the name of the collection, one or more spaces, and
 102 the name of the host machine acting as file server for that collection.
 103
 104 Details of setting up a file collection for the file server are
 105 described in the manual entry for
 106 .I
 107 sup(1).
 108
 109 .I
 110 Supfilesrv
 111 generally runs as a network server process that listens for connections,
 112 and for each connection (double-)forks a process to handle the interaction
 113 with the client.
 114 However, with the -d flag, no forking will take place:
 115 the server will listen for a network connection, handle it, and exit.
 116 This is useful for debugging the servers in "live" mode rather than as
 117 daemons.
 118
 119 For debugging purposes, the -P "debugging ports" flag can be used.
 120 It will cause the selection of an alternate, non-privileged set of
 121 TCP ports instead of the usual ports, which are reserved for the
 122 active server processes.  The -N "network debugging" flag can be used
 123 to produce voluminous messages describing the network communication
 124 progress and status. The more -N switches that you use the more output
 125 you get. Use 3 (separated by spaces: -N -N -N) to get a complete record
 126 of all network messages. Log messages are printed by
 127 .I syslog
 128 on
 129 .I daemon.log .
 130 To suppress
 131 log messages, the -q "quiet" flag can be used.
 132
 133 .I supfilesrv
 134 uses libwrap style access control (the /etc/hosts.allow and /etc/hosts.deny
 135 files) with service name "supfilesrv". The -l "log" flag turn on loggin of
 136 accepted connections (denied connections are always logged).
 137
 138 Normally the
 139 .I supfilesrv
 140 will only respond to 3 requests simultaneously, forking a child
 141 process for each client. If it gets additional requests it will respond
 142 with the error FSSETUPBUSY. The -C MaxChildren switch can be used
 143 to increase (or decrease) this number.
 144
 145 .I supfilesrv
 146 listens to IPv4 listening socket by default.
 147 With the -6 flag, it will listen to IPv6 listening socket.
 148 For dual stack support you will want to run two instances of
 149 .I supfilesrv.
 150
 151 .SH "SUPSCAN"
 152 It is possible to pre-compile a list of the files in a collection
 153 to make
 154 .I
 155 supfilesrv
 156 service that collection much faster.  This can be done by running
 157 .I
 158 supscan
 159 on the desired collection on the repository machine.  This produces a
 160 list of all the files in the collection at the time of the
 161 .I
 162 supscan;
 163 subsequent upgrades will be based on this list of files rather than
 164 actually scanning the disk at the time of the upgrade.  Of course,
 165 the upgrade will consequently bring the client machine up to the status
 166 of the repository machine as of the time of the
 167 .I
 168 supscan
 169 rather than as of the time of the upgrade; hence, if
 170 .I
 171 supscan
 172 is used, it should be run periodically on the
 173 collection.
 174 This facility is useful for extremely large file collections
 175 that are upgraded many times per day, such as the CMU UNIX system
 176 software.  The "verbose" flag
 177 .I
 178 -v
 179 will cause
 180 .I
 181 supscan
 182 to produce output messages as it scans the files in the collection.
 183 The "system" flag
 184 .I
 185 -s
 186 will cause
 187 .I
 188 supscan
 189 to scan all system collections residing on the current host.
 190 The
 191 .I
 192 basedir
 193 parameter must be specified if the collection is a private
 194 collection whose base directory is not the default.
 195 .SH "FILES"
 196 .TP
 197 /usr
 198 default base directory for a collection
 199 .TP
 200 /etc/supfiles/coll.dir
 201 base directory list for system collections
 202 .TP
 203 /etc/supfiles/coll.host
 204 host name list for system collections
 205 .TP
 206 \*[Lt]base-directory\*[Gt]/sup/\*[Lt]collection\*[Gt]/*
 207 files used by file server (see
 208 .I
 209 sup(1))
 210 .TP
 211 \*[Lt]base-directory\*[Gt]/sup/\*[Lt]collection\*[Gt]/list
 212 list file used by
 213 .I
 214 supscan
 215 to create file list
 216 .TP
 217 \*[Lt]base-directory\*[Gt]/sup/\*[Lt]collection\*[Gt]/scan
 218 file list created by
 219 .I
 220 supscan
 221 from list file
 222 .DT
 223 .PP
 224 .SH "SEE ALSO"
 225 sup(1)
 226 hosts_access(5)
 227 hosts_options(5)
 228 .br
 229 .I
 230 The SUP Software Upgrade Protocol,
 231 S.
 232 A.
 233 Shafer, CMU Computer Science Dept., 1985.
 234 .SH "DIAGNOSTICS"
 235 The file server places log messages on the
 236 standard and diagnostic output files.
 237 The process name and process
 238 id number generally accompany each message for diagnostic purposes.
 239 .SH "HISTORY"
 240 .TP
 241 31-July-92 Mary Thompson (mrt) at Carnegie Mellon University
 242 Removed references to supnameserver which has not existed for
 243 a long time. Update a few file names. Added -C switch.
 244 .TP
 245 21-May-87  Glenn Marcy (gm0w) at Carnegie-Mellon University
 246 Updated documentation for 4.3; changed /usr/cmu to /usr/cs.
 247 .TP
 248 15-Jan-86  Glenn Marcy (gm0w) at Carnegie-Mellon University
 249 Updated documentation; -s switch to supscan.
 250 .TP
 251 23-May-85  Steven Shafer (sas) at Carnegie-Mellon University
 252 Supscan created and documented; also -N flag.
 253 .TP
 254 04-Apr-85  Steven Shafer (sas) at Carnegie-Mellon University
 255 Created.