usr.sbin/atm/atmarpd/atmarpd.8

   1 .\"
   2 .\" ===================================
   3 .\" HARP  |  Host ATM Research Platform
   4 .\" ===================================
   5 .\"
   6 .\"
   7 .\" This Host ATM Research Platform ("HARP") file (the "Software") is
   8 .\" made available by Network Computing Services, Inc. ("NetworkCS")
   9 .\" "AS IS".  NetworkCS does not provide maintenance, improvements or
  10 .\" support of any kind.
  11 .\"
  12 .\" NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
  13 .\" INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
  14 .\" AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
  15 .\" SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
  16 .\" In no event shall NetworkCS be responsible for any damages, including
  17 .\" but not limited to consequential damages, arising from or relating to
  18 .\" any use of the Software or related support.
  19 .\"
  20 .\" Copyright 1994-1998 Network Computing Services, Inc.
  21 .\"
  22 .\" Copies of this Software may be made, however, the above copyright
  23 .\" notice must be reproduced on all copies.
  24 .\"
  25 .\" @(#) $FreeBSD$
  26 .\"
  27 .\"
  28 .Dd August 4, 1998
  29 .Dt ATMARPD 8
  30 .Os
  31 .Sh NAME
  32 .Nm atmarpd
  33 .Nd "ATMARP/SCSP interface daemon"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl d
  37 .Op Fl l Aq Ar log_file
  38 .Aq Ar net_intf
  39 .Ar ...
  40 .Sh DESCRIPTION
  41 .Nm Atmarpd
  42 provides an interface between the ATMARP server in the
  43 kernel and the SCSP daemon for the Host ATM Research Platform
  44 (HARP) networking software.
  45 .Nm Atmarpd
  46 reads the ATMARP cache from the kernel periodically
  47 and passes any updated entries to
  48 .Xr scspd 8
  49 so they will be
  50 propagated to remote servers.
  51 It also accepts updated entries that remote servers have sent to
  52 .Xr scspd 8
  53 and, if they are
  54 new or more up to date than current entries, installs them
  55 in the kernel's ATMARP cache.
  56 Both
  57 .Nm
  58 and
  59 .Xr scspd 8
  60 must be running before any ATMARP cache synchronization can take place.
  61 .Pp
  62 When
  63 .Nm
  64 starts, it parses its command line and puts
  65 itself into the background.
  66 .Pp
  67 The command-line options are:
  68 .Bl -tag -width "-l <log_file>"
  69 .It Fl l Aq Ar log_file
  70 Specifies that
  71 .Nm
  72 is to write log messages to the
  73 file named
  74 .Aq Ar log_file
  75 rather than to the system log.
  76 .It Fl d
  77 Specifies that
  78 .Nm
  79 is to be run in debug mode.
  80 In debug mode,
  81 .Nm
  82 is not put into the background.
  83 Log messages are written to standard output instead of to
  84 the log file.
  85 .It Aq Ar net_intf
  86 Specifies the network interface(s) for which the host is providing
  87 ATMARP service and whose caches are to be synchronized using SCSP.
  88 If multiple network interface names are specified,
  89 .Nm
  90 will provide an interface to
  91 .Xr scspd 8
  92 for the servers on all the
  93 specified interfaces.
  94 .El
  95 .Sh SIGNAL PROCESSING
  96 The following signals can be used to control
  97 .Nm :
  98 .Bl -tag -width indent
  99 .It Dv SIGINT
 100 Dump debugging information to a file.
 101 When it receives a
 102 .Dv SIGINT
 103 signal,
 104 .Nm
 105 dumps a summary of
 106 its control blocks to a text file (see
 107 .Sx FILES ) .
 108 .El
 109 .Sh FILES
 110 .Bl -tag -width indent
 111 .It Xo
 112 .Sm off
 113 .Pa /tmp/atmarpd.
 114 .Aq Ar pid
 115 .Pa \&.
 116 .Aq Ar seq
 117 .Pa .out
 118 .Sm on
 119 .Xc
 120 Debugging information dump file name.
 121 .Nm Atmarpd
 122 writes a summary of its control blocks to this file
 123 when it receives a
 124 .Dv SIGINT
 125 signal.
 126 .Aq Ar pid
 127 is the process ID of the daemon and
 128 .Aq Ar seq
 129 is a sequence
 130 number which is incremented every time a dump is taken.
 131 .El
 132 .Sh SEE ALSO
 133 .Xr atm 8 ,
 134 .Xr scspd 8
 135 .Rs
 136 .%T "Classical IP and ARP over ATM"
 137 .%O "RFC 1577"
 138 .Re
 139 .Rs
 140 .%T "Classical IP and ARP over ATM"
 141 .%O "RFC 2225"
 142 .Re
 143 .Rs
 144 .%T "Server Cache Synchronization Protocol (SCSP)"
 145 .%O "RFC 2334"
 146 .Re
 147 .Rs
 148 .%T "A Distributed ATMARP Service Using SCSP"
 149 .%O "draft\-ietf\-ion\-scsp\-atmarpd\-00.txt"
 150 .Re
 151 .Sh BUGS
 152 Results are unpredictable if multiple instantiations of
 153 .Nm
 154 are run simultaneously for a given network interface.
 155 .Pp
 156 Please report any bugs to
 157 .Aq harp\-bugs@magic.net .
 158 .Sh COPYRIGHT
 159 Copyright (c) 1994-1998, Network Computing Services, Inc.
 160 .Sh AUTHORS
 161 .An John Cavanaugh ,
 162 Network Computing Services, Inc.
 163 .An Mike Spengler ,
 164 Network Computing Services, Inc.
 165 .An Joe Thomas ,
 166 Network Computing Services, Inc.
 167 .Sh ACKNOWLEDGMENTS
 168 This software was developed with the support of the Defense
 169 Advanced Research Projects Agency (DARPA).