summaryrefslogtreecommitdiffstats
path: root/usr.sbin/atm/atmarpd
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-01-18 16:04:48 +0000
committerru <ru@FreeBSD.org>2001-01-18 16:04:48 +0000
commit9394aea4edeb8ade34d797dbfe46e55d1640e6b0 (patch)
treeb2b0b92b4d85e9ca1859c8593fc2d8ce7de1b0e9 /usr.sbin/atm/atmarpd
parentc33caa8ae000a6d5d8a4789524b82df3f05e69f8 (diff)
downloadFreeBSD-src-9394aea4edeb8ade34d797dbfe46e55d1640e6b0.zip
FreeBSD-src-9394aea4edeb8ade34d797dbfe46e55d1640e6b0.tar.gz
man(7) -> mdoc(7).
Diffstat (limited to 'usr.sbin/atm/atmarpd')
-rw-r--r--usr.sbin/atm/atmarpd/atmarpd.8204
1 files changed, 122 insertions, 82 deletions
diff --git a/usr.sbin/atm/atmarpd/atmarpd.8 b/usr.sbin/atm/atmarpd/atmarpd.8
index 24693f0..78e543a 100644
--- a/usr.sbin/atm/atmarpd/atmarpd.8
+++ b/usr.sbin/atm/atmarpd/atmarpd.8
@@ -25,105 +25,145 @@
.\" @(#) $FreeBSD$
.\"
.\"
-.de EX \"Begin example
-.ne 5
-.if n .sp 1
-.if t .sp .5
-.nf
-.in +.5i
-..
-.de EE
-.fi
-.in -.5i
-.if n .sp 1
-.if t .sp .5
-..
-.TH ATMARPD 8 "1998-08-04" "HARP"
-
-.SH NAME
-atmarpd \- ATMARP/SCSP interface daemon
-.SH SYNOPSIS
-.B atmarpd
-[\fB-l\fP <log file>]
-[\fB-d\fP]
-<netif> ...
-
-.SH DESCRIPTION
-\fIAtmarpd\fP provides an interface between the ATMARP server in the
+.Dd August 04, 1998
+.Dt ATMARPD 8
+.Os
+.Sh NAME
+.Nm atmarpd
+.Nd "ATMARP/SCSP interface daemon"
+.Sh SYNOPSIS
+.Nm
+.Op Fl d
+.Op Fl l Aq Ar log_file
+.Aq Ar net_intf
+.Ar ...
+.Sh DESCRIPTION
+.Nm Atmarpd
+provides an interface between the ATMARP server in the
kernel and the SCSP daemon for the Host ATM Research Platform
(HARP) networking software.
-\fIAtmarpd\fP reads the ATMARP cache from the kernel periodically
-and passes any updated entries to \fIscspd\fP so they will be
+.Nm Atmarpd
+reads the ATMARP cache from the kernel periodically
+and passes any updated entries to
+.Xr scspd 8
+so they will be
propagated to remote servers.
It also accepts updated entries that remote servers have sent to
-\fIscspd\fP and, if they are
+.Xr scspd 8
+and, if they are
new or more up to date than current entries, installs them
in the kernel's ATMARP cache.
-Both \fIatmarpd\fP and \fIscspd\fP must be running before any ATMARP
-cache synchronization can take place.
-
-When \fIatmarpd\fP starts, it parses its command line and puts
+Both
+.Nm
+and
+.Xr scspd 8
+must be running before any ATMARP cache synchronization can take place.
+.Pp
+When
+.Nm
+starts, it parses its command line and puts
itself into the background.
-
+.Pp
The command-line options are:
-.IP "\fB-l\fP <log file>" 15
-Specifies that \fIatmarpd\fP is to write log messages to the
-file named <log file> rather than to the system log.
-.IP "\fB-d\fP" 15
-Specifies that \fIatmarpd\fP is to be run in debug mode.
-In debug mode, \fIatmarpd\fP is not put into the background.
+.Bl -tag -width "-l <log_file>"
+.It Fl l Aq Ar log_file
+Specifies that
+.Nm
+is to write log messages to the
+file named
+.Aq Ar log_file
+rather than to the system log.
+.It Fl d
+Specifies that
+.Nm
+is to be run in debug mode.
+In debug mode,
+.Nm
+is not put into the background.
Log messages are written to standard output instead of to
the log file.
-.IP "<netif>" 15
+.It Aq Ar net_intf
Specifies the network interface(s) for which the host is providing
ATMARP service and whose caches are to be synchronized using SCSP.
-If multiple network interface names are specified, \fIatmarpd\fP
-will provide an interface to \fIscspd\fP for the servers on all the
+If multiple network interface names are specified,
+.Nm
+will provide an interface to
+.Xr scspd 8
+for the servers on all the
specified interfaces.
-
-.SH SIGNAL PROCESSING
-The following signals can be used to control \fIatmarpd\fP:
-
-.IP \fBSIGINT\fP 10
+.El
+.Sh SIGNAL PROCESSING
+The following signals can be used to control
+.Nm :
+.Bl -tag -width indent
+.It Dv SIGINT
Dump debugging information to a file.
-When it receives a SIGINT signal, \fIatmarpd\fP dumps a summary of
-its control blocks to a text file (see "\fBFILES\fB").
-
-.SH FILES
-
-.IP "/tmp/atmarpd.<pid>.<seq>.out"
+When it receives a
+.Dv SIGINT
+signal,
+.Nm
+dumps a summary of
+its control blocks to a text file (see
+.Sx FILES ) .
+.El
+.Sh FILES
+.Bl -tag -width indent
+.It Xo
+.Sm off
+.Pa /tmp/atmarpd.
+.Aq Ar pid
+.Pa \&.
+.Aq Ar seq
+.Pa .out
+.Sm on
+.Xc
Debugging information dump file name.
-\fIAtmarpd\fP writes a summary of its control blocks to this file
-when it receives a SIGINT signal.
-<pid> is the process ID of the daemon and <seq> is a sequence
+.Nm Atmarpd
+writes a summary of its control blocks to this file
+when it receives a
+.Dv SIGINT
+signal.
+.Aq Ar pid
+is the process ID of the daemon and
+.Aq Ar seq
+is a sequence
number which is incremented every time a dump is taken.
-
-.SH "SEE ALSO"
-\fIatm\fP (8);
-\fIscspd\fP (8);
-RFC 1577, \fIClassical IP and ARP over ATM\fP;
-RFC 2225, \fIClassical IP and ARP over ATM\fP;
-RFC 2334, \fIServer Cache Synchronization Protocol (SCSP)\fP;
-draft-ietf-ion-scsp-atmarpd-00.txt, \fIA Distributed ATMARP Service
-Using SCSP\fP.
-
-
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr atm 8 ,
+.Xr scspd 8
+.Rs
+.%T "Classical IP and ARP over ATM"
+.%O "RFC 1577"
+.Re
+.Rs
+.%T "Classical IP and ARP over ATM"
+.%O "RFC 2225"
+.Re
+.Rs
+.%T "Server Cache Synchronization Protocol (SCSP)"
+.%O "RFC 2334"
+.Re
+.Rs
+.%T "A Distributed ATMARP Service Using SCSP"
+.%O "draft\-ietf\-ion\-scsp\-atmarpd\-00.txt"
+.Re
+.Sh BUGS
Results are unpredictable if multiple instantiations of
-\fIatmarpd\fP are run simulatneously for a given network interface.
-
-Please report any bugs to harp-bugs@magic.net.
-
-.SH COPYRIGHT
+.Nm
+are run simultaneously for a given network interface.
+.Pp
+Please report any bugs to
+.Aq harp\-bugs@magic.net .
+.Sh COPYRIGHT
Copyright (c) 1994-1998, Network Computing Services, Inc.
-
-.SH AUTHORS
-John Cavanaugh, Network Computing Services, Inc.
-.br
-Mike Spengler, Network Computing Services, Inc.
-.br
-Joe Thomas, Network Computing Services, Inc.
-.fi
-.SH ACKNOWLEDGMENTS
+.Sh AUTHORS
+.An John Cavanaugh ,
+Network Computing Services, Inc.
+.An Mike Spengler ,
+Network Computing Services, Inc.
+.An Joe Thomas ,
+Network Computing Services, Inc.
+.Sh ACKNOWLEDGMENTS
This software was developed with the support of the Defense
Advanced Research Projects Agency (DARPA).
OpenPOWER on IntegriCloud