tfkiss 1.3.2
============

tfkiss is a software implementation of TheFirmware (TF) by NORD><LINK,
originally written for TNC2 hardware. It implements the KISS protocol
and supports AX.25 Layer 2, AXIP, XPID, and FLEXNET. It is used in
amateur packet radio BBS and node setups in conjunction with dpbox
and TNT.

This is a maintained fork of the original work by Berndt Josef Wulf
VK5ABN. It adds 64-bit correctness fixes, ANSI C modernization, and
a modernized autoconf/automake build system.

For copyright information see doc/copyrght.txt and doc/alas.eng.

Prerequisites
-------------

To build tfkiss you need:

  gcc or compatible C compiler
  make
  autoconf (only needed when building from git)
  automake (only needed when building from git)

Building from a release tarball
--------------------------------

    ./configure
    make
    sudo make install

Building from a git clone
--------------------------

    ./autogen.sh
    ./configure
    make
    sudo make install

Configure options
-----------------

  --disable-xpid      Disable PID change code support (enabled by default)
  --disable-flexnet   Disable FLEXNET support (enabled by default)
  --disable-axip      Disable AXIP support (enabled by default)
  --enable-hibaud     Enable high baud rate support >38400 (Linux only)
  --prefix=DIR        Install to DIR instead of /usr/local

Installation
------------

By default tfkiss installs to /usr/local:

  /usr/local/sbin/tfkiss        the binary
  /usr/local/etc/tfkiss/        configuration files
  /usr/local/share/doc/tfkiss/  documentation
  /usr/local/share/examples/tfkiss/ example configuration files

To install to /usr instead:

    ./configure --prefix=/usr --enable-xpid --enable-flexnet --enable-axip

Configuration
-------------

After installation, edit the configuration file:

    /usr/local/etc/tfkiss/tfkiss.ini
    /usr/local/etc/tfkiss/tfkiss.cfg

At minimum you MUST:

  1. Set your callsign in tfkiss.cfg (replace NOCALL with your callsign)
  2. Verify the device setting in tfkiss.ini points to your TNC's
     serial port. Common values:

       Linux built-in serial:  /dev/ttyS0
       Linux USB-to-serial:    /dev/ttyUSB0
       NetBSD built-in serial: /dev/tty00
       NetBSD USB-to-serial:   /dev/ttyU0
       DragonFly:              /dev/ttyd0
       Solaris:                /dev/ttya

Supported platforms
-------------------

  Linux (x86, x86_64, arm)
  NetBSD (x86, x86_64, arm64)
  DragonFly BSD
  Solaris

Bug reports
-----------

Please report bugs at https://github.com/kq6up/tfkiss/issues
or email christopher.maness@gmail.com

73 de Chris Maness, KQ6UP
