summaryrefslogtreecommitdiffstats
path: root/ax25
diff options
context:
space:
mode:
authorRalf Baechle <ralf@linux-mips.org>2021-07-27 18:57:52 +0200
committerRalf Baechle <ralf@linux-mips.org>2021-07-27 18:57:52 +0200
commit599384db74f3874b5185e64891235ea0805d6b9b (patch)
tree93e4ee01a0b0653860439ff4b63941c8b4a68c9c /ax25
parent3595f878131400ad6bbe9231a9dfad8921c9d722 (diff)
ax25.4: Use .B nroff highliting as is common practice for man pages.
Signed-off-by: Ralf Baechle <ralf@linux-mips.org>
Diffstat (limited to 'ax25')
-rw-r--r--ax25/ax25.455
1 files changed, 38 insertions, 17 deletions
diff --git a/ax25/ax25.4 b/ax25/ax25.4
index 12003d7..73a9a98 100644
--- a/ax25/ax25.4
+++ b/ax25/ax25.4
@@ -14,7 +14,9 @@ frame modes. IP traffic may be stacked on top of AX.25 frames for IP
transmission over the AX.25 medium.
.LP
The primary mode of operation is connected mode which is the mode used for a
-socket of type SOCK_SEQPACKET (stream sockets are not available in AX.25).
+socket of type
+.B SOCK_SEQPACKET
+(stream sockets are not available in AX.25).
This requires that the user ensures output data is suitably packetised, and
that input data is read a packet at a time into a buffer of suitable size.
The Linux AX.25 protocol layer can operate in standard AX.25 mode with three
@@ -22,9 +24,16 @@ bit sequence numbers or in PE1CHL extended AX.25 mode which uses seven bit
sequence numbers. The protocol passed to the socket is used for all outgoing
frames. Passing 0 causes the normal AX.25 Text PID to be used.
.LP
-SOCK_DGRAM gives access to AX.25 UI frames. For access to special frames (of
-any form) SOCK_RAW can be used. There is no SOCK_PACKET support under AX.25.
-Instead an AF_INET socket of type SOCK_PACKET should be used.
+.B SOCK_DGRAM
+gives access to AX.25 UI frames. For access to special frames (of
+any form) SOCK_RAW can be used. There is no
+.B SOCK_PACKET
+support under AX.25.
+Instead an
+.B AF_INET
+socket of type
+.B SOCK_PACKET
+should be used.
.LP
AX.25 addresses consist of 6 ascii characters and a number called the SSID.
These are encoded into a sockaddr_ax25 structure which is provided to the
@@ -39,19 +48,30 @@ table, and in addition the superuser may use an arbitary callsign by binding
to the callsign desired and specifying the port to use as a first digipeated
hop.
.LP
-AX.25 supports the following socket options for SOL_AX25. AX25_T1 is the T1
-timer in 1/10ths of a second, AX25_T2 is the T2 timer in 1/10ths of a
-second, AX25_T3 is the T3 timer. The window is settable with AX25_WINDOW.
-AX25_N2, the retry counter is also configurable. There is no 'infinite
-retry' option supported however. The method of backoff for retries is
-configurable via the socket option AX25_BACKOFF, a value of true indicates
-the use of exponential backoff and false simple linear backoff. The mode of
-a connection made be altered to be either standard AX.25 or extended AX.25
-via AX25_EXTSEQ. It is possible to have the complete AX.25 header returned
-to the application by setting AX25_HDRINCL to true, programs must be aware
-of the internal structure of AX.25 frames to use this option. Note that if
-AX.25 fragmentation is encountered, only the control information of the
-first frame is returned along with the defragmented data.
+AX.25 supports the following socket options for
+.BR SOL_AX25 .
+.B AX25_T1
+is the T1 timer in 1/10ths of a second, AX25_T2 is the T2 timer in 1/10ths of
+a second,
+.B AX25_T3
+is the T3 timer. The window is settable with
+.BR AX25_WINDOW .
+.BR AX25_N2 ,
+the retry counter is also configurable. There is no 'infinite retry' option
+supported however. The method of backoff for retries is configurable via the
+socket option
+.BR AX25_BACKOFF ,
+a value of true indicates the use of exponential backoff and false simple
+linear backoff. The mode of a connection made be altered to be either
+standard AX.25 or extended AX.25 via
+.BR AX25_EXTSEQ .
+It is possible to have the complete AX.25 header returned to the application
+by setting
+.B AX25_HDRINCL
+to true, programs must be aware of the internal structure of AX.25 frames to
+use this option. Note that if AX.25 fragmentation is encountered, only the
+control information of the first frame is returned along with the defragmented
+data.
.SH "SEE ALSO"
.BR call (1),
.BR socket (2),
@@ -60,6 +80,7 @@ first frame is returned along with the defragmented data.
.BR axctl (8),
.BR axports (5),
.BR axparms (8),
+.BR packet (7),
.BR kissattach (8).
.LP
.SH BUGS