d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
716151ab18
freebsd-skq/share/man/man4/natm.4

102 lines
2.8 KiB
Groff
Raw Normal View History

Add $FreeBSD$ lines to man pages that are missing them to make it easier for translation teams. PR: docs/13418 Submitted by: Alexey Zelkin <phantom@cris.net>
1999-08-28 23:23:38 +00:00
.\" $FreeBSD$
.\"
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Dd December 29, 1997
.Dt NATM 4
mdoc(7) police: eliminate warnings.
2000-11-17 15:40:57 +00:00
.Os
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Sh NAME
.Nm natm
mdoc(7) police: normalize .Nd.
2001-04-18 15:54:10 +00:00
.Nd Native Mode ATM protocol layer
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Sh DESCRIPTION
mdoc(7) police: s/BSD/.Bx/ where appropriate.
2001-08-14 10:01:54 +00:00
The
.Bx
ATM software comes with a
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
.Em native mode ATM protocol layer
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
which provides socket level access to AAL0 and AAL5 virtual circuits.
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
To enable this protocol layer, add
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Dl options NATM
Expand *n't contractions.
2005-02-13 22:25:33 +00:00
to your kernel configuration file and re-make the kernel (do not forget
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
to do
mdoc(7) police: join split punctuation to macro calls.
2001-08-10 17:35:21 +00:00
.Dq make clean ) .
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Sh NATM API
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
The NATM layer uses a
Hiten's patchset for section four manpages, slightly edited by me.
2003-06-28 23:53:39 +00:00
.Vt struct sockaddr_natm
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
to specify a virtual circuit:
.Bd -literal -offset indent
struct sockaddr_natm {
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
uint8_t snatm_len; /* length */
uint8_t snatm_family; /* AF_NATM */
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
char snatm_if[IFNAMSIZ]; /* interface name */
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
uint16_t snatm_vci; /* vci */
uint8_t snatm_vpi; /* vpi */
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
};
.Ed
.Pp
To create an AAL5 connection to a virtual circuit with VPI 0, VCI 201
one would use the following:
.Bd -literal -offset indent
struct sockaddr_natm snatm;
int s, r;
s = socket(AF_NATM, SOCK_STREAM, PROTO_NATMAAL5);
/* note: PROTO_NATMAAL0 is AAL0 */
if (s < 0) { perror("socket"); exit(1); }
typo fixes PR: docs/10738 Submitted by:Yamaguchi Takahiro tyama@titanium.crc.uec.ac.jp
1999-03-29 04:25:09 +00:00
bzero(&snatm, sizeof(snatm));
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
snatm.snatm_len = sizeof(snatm);
snatm.snatm_family = AF_NATM;
sprintf(snatm.snatm_if, "en0");
snatm.snatm_vci = 201;
snatm.snatm_vpi = 0;
r = connect(s, (struct sockaddr *)&snatm, sizeof(snatm));
if (r < 0) { perror("connect"); exit(1); }
/* s now connected to ATM! */
.Ed
.Pp
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
The
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Fn socket
Hiten's patchset for section four manpages, slightly edited by me.
2003-06-28 23:53:39 +00:00
call simply creates an unconnected NATM socket.
The
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Fn connect
call associates an unconnected NATM socket with a
virtual circuit and tells the driver to enable that virtual circuit
Hiten's patchset for section four manpages, slightly edited by me.
2003-06-28 23:53:39 +00:00
for receiving data.
After the
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Fn connect
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
call one can
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Fn read
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
or
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Fn write
to the socket to perform ATM I/O.
.Sh Internal NATM operation
Internally, the NATM protocol layer keeps a list of all active virtual
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
circuits on the system in
.Dv natm_pcbs .
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
This includes circuits currently being used for IP to prevent NATM and
IP from clashing over virtual circuit usage.
.Pp
When a virtual circuit is enabled for receiving data, the NATM
protocol layer passes the address of the protocol control block down
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
to the driver as a receive
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Dq handle .
When inbound data arrives, the driver passes the data back with the
Hiten's patchset for section four manpages, slightly edited by me.
2003-06-28 23:53:39 +00:00
appropriate receive handle.
The NATM layer uses this to avoid the
overhead of a protocol control block lookup.
This allows us to take
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
advantage of the fact that ATM has already demultiplexed the data for
us.
.Sh SEE ALSO
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script.
2003-06-13 12:33:33 +00:00
.Xr en 4 ,
This is a driver for Fore PCA200E cards that uses busdma and works on little endian and big endian and with 32 and 64 bit pointers. It already has the hooks to be used for HARP, NATM and ngATM.
2003-06-23 14:46:12 +00:00
.Xr fatm 4 ,
Hiten's patchset for section four manpages, slightly edited by me.
2003-06-28 23:53:39 +00:00
.Xr hatm 4 ,
mdoc(7): Fix common mistakes made in the SEE ALSO section.
2003-09-12 21:54:11 +00:00
.Xr natmip 4 ,
.Xr patm 4
add Native ATM Protocol manual.
1998-07-29 05:41:20 +00:00
.Sh AUTHORS
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net>
1999-08-15 10:48:36 +00:00
.An Chuck Cranor
of Washington University implemented the NATM protocol layer
along with the EN ATM driver in 1996 for
.Nx .
mdoc: move CAVEATS, BUGS and SECURITY CONSIDERATIONS sections to the bottom of the manpages and order them consistently. GNU groff doesn't care about the ordering, and doesn't even mention CAVEATS and SECURITY CONSIDERATIONS as common sections and where to put them. Found by: mdocml lint run Reviewed by: ru
2010-05-13 12:07:55 +00:00
.Sh CAVEATS
The NATM protocol support is subject to change as
the ATM protocols develop.
Users should not depend on details of the current implementation, but rather
the services exported.
Reference in New Issue Copy Permalink