x3270if(1) [redhat man page]
X3270IF(1) General Commands Manual X3270IF(1) NAME
x3270if - command interface to x3270, c3270 and s3270 SYNOPSIS
x3270if [ -v ] action [ ( param [ ,... ] ) ] x3270if [ -v ] -s field x3270if -i DESCRIPTION
x3270if provides an interface between scripts and the 3270 emulators x3270, c3270, and s3270. x3270if performs one of three functions. In action mode (the default), it passes a single action and optional parameters to the emulator for execution; the result of the command is written to standard output. In status mode, it reports to standard output the value of one of the emulator's status fields. In iterative mode, it forms a continuous conduit between a script and the emulator. OPTIONS
-v Turns on verbose debug messages, showing the literal data that is passed between the emulator and x3270if. -s field Puts x3270if in status mode: it outputs the value of an emulator status field. Field is an integer in the range 0 through 11. The value 0 is a no-op and is used only to return exit status indicating the state of the emulator. The indices 1-11 and meanings of each field are documented on the x3270-script(1) manual page. -i Puts x3270if in iterative mode. Data from x3270if's standard input is copied to the emulator's script input; data from the emula- tor's script output is copied to x3270if's standard output. x3270if runs until it detects end-of-file on its standard input or on the output from the emulator. (This mode exists primarily to give expect(1) a process to run, on systems which do not support bidi- rectional pipes.) EXIT STATUS
In action mode, if the requested action succeeds, x3270if exits with status 0. If the action fails, x3270if exits with status 1. In iter- ative mode, x3270if exits with status 0 when it encounters end-of-file. If there is an operational error within x3270if itself, such as a command-line syntax error, missing environment variable, or an unexpectedly closed pipe, x3270if exits with status 2. ENVIRONMENT
x3270, c3270, and s3270 use a pair of pipes for communication with each child process. The values of the file descriptors for these pipes are encoded as text in two environment variables, which are required by x3270if: X3270OUTPUT Output from the emulator, input to the child process. X3270INPUT Input to the emulator, output from the child process. SEE ALSO
x3270(1), c3270(1), s3270(1), x3270-script(1) COPYRIGHT
Copyright 1999, 2000 by Paul Mattes. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. 01 May 2002 X3270IF(1)
Check Out this Related Man Page
isdn_audio(4) Special files isdn_audio(4) NAME
isdn_audio - audio extension of ttyI ISDN character devices DESCRIPTION
This document describes the audio related extensions of the modem emulation, provided by /dev/ttyIx. The ISDN tty devices are equipped with a modem emulation implementing a set of traditional and some special AT commands. This provides easy use together with almost all communication software that uses modem commands: minicom(1), seyon(1), XCept(1), uucico(8), mgetty(8), dip(8), pppd(8) and more. When enabled during kernel configuration, the emulator is capable of a reduced set of commands to support audio. To use audio features, an ISDN card with a audio-capable low-level driver is needed. Currently the only audio-capable drivers are the teles and HiSax driver. The port speed of the ISDN tty devices is always 64000 bps. AUDIO RELATED AT COMMAND SET
This description does not include the standard AT command set. For a description of the standard AT command set, provided by the Linux ISDN subsystem, see ttyI(4). All commands starting with AT+ except AT+FCLASS are enabled only, if audio mode is active. The following audio related AT commands are supported by ISDN tty devices: AT+FCLASS=0 Disable audio mode (default). This command sets register 18 to 4. AT+FCLASS=8 Enable audio mode. This command sets register 18 to 5. AT+FCLASS=? Show possible modes. AT+FCLASS? Show current mode. AT+VNH=x No function, provided for compatibility only. AT+VNH=? Always showing "1". AT+VNH? Always showing "1". AT+VIP Reset all audio parameters. AT+VLS=x Select line x, where x is one of the following: 0 = No device. 2 = Phone line. AT+VLS=? Always showing "0,2". AT+VLS? Show current line. AT+VRX Start audio recording. See below for more information. AT+VSD=x,y Set silence-detection parameters. Possible parameters: x = 0 ... 31 sensitivity threshold level. (default 0 , deactivated) y = 0 ... 255 range of interval in units of 0.1 second. (default 70) AT+VSD=? Show possible parameters. AT+VSD? Show current parameters. AT+VSM=x Select audio data format to x, where x is: 2 = ADPCM-2 3 = ADPCM-3 4 = ADPCM-4 5 = aLAW 6 = uLAW AT+VSM=? Show possible audio data formats. AT+VSM? Show current audio data format. AT+VTX Start audio playback. See below for more information. GENERAL BEHAVIOUR
On incoming calls, if the application responds to a RING by sending ATA, depending on the calling service, the emulator responds with either CONNECT (data call) or VCON (voice call). When starting audio playback or recording, the emulator responds with CONNECT. After that, the data transfer protocol described below is used. It is possible to initiate full duplex data transfer by issuing AT+VRX+VTX in a single command. In this case, no CONNECT message is sent to the application and the protocol described below is started immediately. When stopping audio playback or recording, the message returned by the emulator depends on how the data transfer is stopped. If the data transfer is stopped by a remote hangup, NO CARRIER is sent to the application, while stopping data transfer with one of the DLE sequences, VCON is sent. In any case, the message is preceded by the appropriate DLE sequence for end of audio data and/or abort respectively. On outgoing voice calls, the emulator responds with VCON upon connection setup. AUDIO DATA FORMAT
When recording or playing back audio data, a kind of modified bisync protocol is used. When recording audio data, the modem emulator is considered to be the sender, while the application is the receiver. When playing back, this relationship is reversed: The modem emulator acts as receiver, while the application is the sender. With the bisync protocol the character DLE (0x10) has a special meaning and is used like an escape character. It is always followed by a second character which has the following meanings defined: ETX (0x03) End of audio data. This code has to be sent by the sender, indicating end of audio data. DC4 (0x14) Abort sending. This code has to be sent by the receiver, when it wishes to abort receiving data. The sender has to reply by stop sending data and finally indicating end of audio data. DLE (0x10) a single byte with value 0x10 in the data stream. 0 Touch-tone "0" received. Valid only in direction from emulator to application. 1 Touch-tone "1" received. Valid only in direction from emulator to application. 2 Touch-tone "2" received. Valid only in direction from emulator to application. 3 Touch-tone "3" received. Valid only in direction from emulator to application. 4 Touch-tone "4" received. Valid only in direction from emulator to application. 5 Touch-tone "5" received. Valid only in direction from emulator to application. 6 Touch-tone "6" received. Valid only in direction from emulator to application. 7 Touch-tone "7" received. Valid only in direction from emulator to application. 8 Touch-tone "8" received. Valid only in direction from emulator to application. 9 Touch-tone "9" received. Valid only in direction from emulator to application. # Touch-tone "#" received. Valid only in direction from emulator to application. * Touch-tone "*" received. Valid only in direction from emulator to application. A Touch-tone "A" received. Valid only in direction from emulator to application. B Touch-tone "B" received. Valid only in direction from emulator to application. C Touch-tone "C" received. Valid only in direction from emulator to application. D Touch-tone "D" received. Valid only in direction from emulator to application. AUTHOR
Fritz Elfert <fritz@isdn4linux.de> SEE ALSO
ttyI(4). ISDN 4 Linux 3.13 1999/09/06 isdn_audio(4)