#
# $Id: README,v 1.6 1998/02/17 09:53:38 mdejonge Exp $
#
#   $Source: /home/mdejonge/CVS/projects/modem/tests/README,v $
# $Revision: 1.6 $
#    Author: Merijn de Jonge
#     Email: mdejonge@wins.uva.nl
#
#
#
# This file is part of the modem communication package.
# Copyright (C) 1996-1998  Merijn de Jonge
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
#
#

This directory contains two programs to test your installation
of the modem package:

ts
   This program is used to test whether your modemd server is running
   and accessible. Furthermore this program is used to verify that
   MODEM_SERVER as configured in modem_defs.h is the correct address
   to locate a modemd server. The program simply sends a message to
   MODEM_SERVER and waits for SERVER_TIMEOUT seconds for any replies. 
   The name of each modem server that replied is printed on standard
   error. After SERVER_TIMEOUT seconds the program writes the number
   of servers that replied to standard error and the program
   terminates.

   usage:
      ts <hostname | broadcastaddr>

   examples:
      # find a modem server on localhost
      ts localhost

      # find any modem server on network 146.50.2.0
      ts 146.50.2.255


virtmodem 

   This program simulates a modem device. The program enables to test
   the modem package even when no modem device is attached to your
   system. Using this program does not require root permission and it
   thus enables an ordinary user to test the modem package.  The
   program opens two pseudo terminals (remote and local). A telnet
   session is started with standard input and output connected to
   remote. virtmodem creates a symbolic link (which name you give as
   argument to virtmodem) to the pseudo terminal local. The program
   virtmodem copies data between local and remote. To connect to the
   virtual modem you should open the virtual modem device. When the
   telnet session terminates, the local pseudo terminal is closed, a
   new telnet session is spawned and a new local pseudo terminal is
   created. To stop virtmodem send it a SIGINT, for example by
   pressing control-c.

   usage:
   For use with the modem server you should edit /etc/modems.conf
   and comment out any available modem. Next, you should add an entry
   for each virtual modem that you want to use. For example:
   
      [/tmp/virtmodem1]
         type = hayes
      [/tmp/virtmodem2]
         type = hayes

   For each virtual modem that has been configured in
   /etc/modems/conf you start virtmodem. Corresponding to the example
   above, we start two copies of virtmodem:

      ./virtmodem /tmp/virtmodem1
      ./virtmodem /tmp/virtmodem2

   You can now start the modemd server and connect to it using for
   example xcomm(1). This will open a telnet session to your local
   machine.


# EOF tests/README
