summaryrefslogtreecommitdiffstats
path: root/kiss/mkiss.8
blob: 1cff4594c7d9884a64fe135a558cf5c4fe0d8592 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
.TH MKISS 8 "13 April 2010" Linux "Linux System Managers Manual"
.SH NAME
mkiss \- Attach a multi KISS interface
.SH SYNOPSIS
.B mkiss [-c] [-f] [-h] [-l] [-s speed] [-p pollrate] [-v] [-x n_ptmx] ttyinterface pty ..
.SH DESCRIPTION
.LP
.B Mkiss
allows dual port TNCs or multiple TNCs sharing the same serial port to be
used with the Linux AX.25 kernel software. The AX.25 software has no support
for dual port TNCs or multiple TNCs charing the same serial line. The
different ports are addressed by encoding the port number in the control
byte of every kiss frame.
.B Mkiss
watches a serial port, and routes kiss frames to/from the pseudo ttys. The
other side of the pseudo ttys are then attached with
.B kissattach
as normal.
.sp 1
Statistics about the operation of
.B mkiss
may be obtained by sending the SIGUSR1 signal to the running program. On
reception of such a signal
.B mkiss
will print a set of statistics to the system log if logging has been
enabled.
.sp 1
Although mention is made of using pseudo ttys as the last arguments,
these devices may be normal serial ports. However
.B mkiss
provides no way in which to set their speed, the speed must therefore be set
by some other method.
.sp 1
If the pty argument is "/dev/ptmx", then Unix98 behaviour
will automatically take effekt. With Unix98 pty's, the slave pty name
could not be forseen. That's why mkiss will print the corresponding slave
pty name as a separate line on stdout.
.sp 1
If the pty name is the special name "none", no pty is opened. This is useful if you have multiport tnc like the KPC-9612 on i.e. /dev/ttyUSB0 and you only like to handle packets for the second port. The KPC has no option to configure the second tnc to listen on kiss port number 0. Thus, if you like to send all frames from the pty to the kiss port number 1, we need to tell mkiss to tag them for port number 1. This is done by "mkiss /dev/ttyUSB0 none /dev/ptmx". Frames received with port number 0 are discarded.
.SH OPTIONS
.TP 10
.BI \-c
This enables a one-byte checksum on each incoming and outgoing KISS frame on
the serial port. This checksum is used by G8BPQ KISS roms to maintain the
integrity of KISS frames.
.TP 10
.BI \-f
This enables a 16-bit checksum on each incoming and outgoing KISS frame on
the serial port. This checksum is used by Flexnet Node and BayCom Mailbox
to maintain the integrity of KISS frames.
.TP 10
.BI \-h
Enables hardware handshaking on the serial line to the TNC. The KISS
specification states that no hardware flow control shall be used so the
default is off. But some KISS implementations do use hardware flow control.
.TP 10
.BI \-l
Enables system logging, the default is off.
.TP 10
.BI "\-s speed"
Set the speed of the serial port.
.TP 10
.BI "\-p pollrate"
Enables polling. Polled mode is used by G8BPQ KISS roms to prevent
contention on systems where multiple TNCs share the same serial line.
Pollrate is interval between polls (in 100ms units).
.TP 10
.BI \-v
Display the version.
.TP 10
.BI "\-x number"
This option is for Unix98 PTYs. It allocates "number" ptys; their names are written to stdout. When -x is used, the pty arguments are optional. "mkiss -x 3 ttyname" is an comfortable alternative to "mkiss ttyname /dev/ptmx /dev/ptmx /dev/ptmx".
.SH "SEE ALSO"
.BR kissattach (8),
.BR ifconfig (8),
.BR kill (1).
.SH AUTHORS
Tomi Manninen OH2BNS <oh2bns@sral.fi>
.br
Jonathan Naylor G4KLX <g4klx@g4klx.demon.co.uk>
.br
Kevin Uhlir N0BEL <kevinu@flochart.com>