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: src/usr.sbin/atm/atmarpd/atmarpd.8,v 1.3.2.3 2003/03/11 21:13:48 trhodes Exp $
  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 The
  42 .Nm
  43 utility provides an interface between the ATMARP server in the
  44 kernel and the SCSP daemon for the Host ATM Research Platform
  45 (HARP) networking software.
  46 The
  47 .Nm
  48 utility reads the ATMARP cache from the kernel periodically
  49 and passes any updated entries to
  50 .Xr scspd 8
  51 so they will be
  52 propagated to remote servers.
  53 It also accepts updated entries that remote servers have sent to
  54 .Xr scspd 8
  55 and, if they are
  56 new or more up to date than current entries, installs them
  57 in the kernel's ATMARP cache.
  58 Both
  59 .Nm
  60 and
  61 .Xr scspd 8
  62 must be running before any ATMARP cache synchronization can take place.
  63 .Pp
  64 When
  65 .Nm
  66 starts, it parses its command line and puts
  67 itself into the background.
  68 .Pp
  69 The command-line options are:
  70 .Bl -tag -width "-l <log_file>"
  71 .It Fl l Aq Ar log_file
  72 Specify that
  73 .Nm
  74 is to write log messages to the
  75 file named
  76 .Aq Ar log_file
  77 rather than to the system log.
  78 .It Fl d
  79 Specify that
  80 .Nm
  81 is to be run in debug mode.
  82 In debug mode,
  83 .Nm
  84 is not put into the background.
  85 Log messages are written to standard output instead of to
  86 the log file.
  87 .It Aq Ar net_intf
  88 Specify the network interface(s) for which the host is providing
  89 ATMARP service and whose caches are to be synchronized using SCSP.
  90 If multiple network interface names are specified,
  91 .Nm
  92 will provide an interface to
  93 .Xr scspd 8
  94 for the servers on all the
  95 specified interfaces.
  96 .El
  97 .Sh SIGNAL PROCESSING
  98 The following signals can be used to control
  99 .Nm :
 100 .Bl -tag -width indent
 101 .It Dv SIGINT
 102 Dump debugging information to a file.
 103 When it receives a
 104 .Dv SIGINT
 105 signal,
 106 .Nm
 107 dumps a summary of
 108 its control blocks to a text file (see
 109 .Sx FILES ) .
 110 .El
 111 .Sh FILES
 112 .Bl -tag -width indent
 113 .It Xo
 114 .Sm off
 115 .Pa /tmp/atmarpd.
 116 .Aq Ar pid
 117 .Pa \&.
 118 .Aq Ar seq
 119 .Pa .out
 120 .Sm on
 121 .Xc
 122 Debugging information dump file name.
 123 The
 124 .Nm
 125 utility writes a summary of its control blocks to this file
 126 when it receives a
 127 .Dv SIGINT
 128 signal.
 129 .Aq Ar pid
 130 is the process ID of the daemon and
 131 .Aq Ar seq
 132 is a sequence
 133 number which is incremented every time a dump is taken.
 134 .El
 135 .Sh SEE ALSO
 136 .Xr atm 8 ,
 137 .Xr scspd 8
 138 .Rs
 139 .%T "Classical IP and ARP over ATM"
 140 .%O "RFC 1577"
 141 .Re
 142 .Rs
 143 .%T "Classical IP and ARP over ATM"
 144 .%O "RFC 2225"
 145 .Re
 146 .Rs
 147 .%T "Server Cache Synchronization Protocol (SCSP)"
 148 .%O "RFC 2334"
 149 .Re
 150 .Rs
 151 .%T "A Distributed ATMARP Service Using SCSP"
 152 .%O "draft\-ietf\-ion\-scsp\-atmarpd\-00.txt"
 153 .Re
 154 .Sh BUGS
 155 Results are unpredictable if multiple instantiations of
 156 .Nm
 157 are run simultaneously for a given network interface.
 158 .Pp
 159 Please report any bugs to
 160 .Aq harp\-bugs@magic.net .
 161 .Sh COPYRIGHT
 162 Copyright (c) 1994-1998, Network Computing Services, Inc.
 163 .Sh AUTHORS
 164 .An John Cavanaugh ,
 165 Network Computing Services, Inc.
 166 .An Mike Spengler ,
 167 Network Computing Services, Inc.
 168 .An Joe Thomas ,
 169 Network Computing Services, Inc.
 170 .Sh ACKNOWLEDGMENTS
 171 This software was developed with the support of the Defense
 172 Advanced Research Projects Agency (DARPA).