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