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