| 1 | '\" t |
|---|
| 2 | .TH X3270IF 1 "1 October 1995" |
|---|
| 3 | .SH NAME |
|---|
| 4 | x3270if \- |
|---|
| 5 | command interface to x3270 |
|---|
| 6 | .SH SYNOPSIS |
|---|
| 7 | .B x3270if |
|---|
| 8 | [ |
|---|
| 9 | .B \-v |
|---|
| 10 | ] |
|---|
| 11 | .I action |
|---|
| 12 | [ |
|---|
| 13 | .B ( |
|---|
| 14 | .I param |
|---|
| 15 | [ ,... ] |
|---|
| 16 | .B ) |
|---|
| 17 | ] |
|---|
| 18 | .br |
|---|
| 19 | .B x3270if |
|---|
| 20 | [ |
|---|
| 21 | .B \-v |
|---|
| 22 | ] |
|---|
| 23 | .B \-s |
|---|
| 24 | .I field |
|---|
| 25 | .SH DESCRIPTION |
|---|
| 26 | .B x3270if |
|---|
| 27 | provides an interface between |
|---|
| 28 | .IR x3270 (1) |
|---|
| 29 | and child processes run with the |
|---|
| 30 | .B Script() |
|---|
| 31 | action. |
|---|
| 32 | .LP |
|---|
| 33 | .B x3270if |
|---|
| 34 | performs one of two functions: passing an action and optional parameters to |
|---|
| 35 | .I x3270 |
|---|
| 36 | for execution, or reporting the value of one of |
|---|
| 37 | .IR x3270 's |
|---|
| 38 | status fields. |
|---|
| 39 | .LP |
|---|
| 40 | The result of the command execution, or the value of the requested status |
|---|
| 41 | field, is written to standard output. |
|---|
| 42 | .SH OPTIONS |
|---|
| 43 | .TP |
|---|
| 44 | .B \-v |
|---|
| 45 | Turns on verbose debug messages, showing the literal data that is passed |
|---|
| 46 | between |
|---|
| 47 | .I x3270 |
|---|
| 48 | and |
|---|
| 49 | .BR x3270if . |
|---|
| 50 | .TP |
|---|
| 51 | .BI \-s " field" |
|---|
| 52 | Causes |
|---|
| 53 | .B 3270if |
|---|
| 54 | to return the value of an |
|---|
| 55 | .I x3270 |
|---|
| 56 | status field, rather than passing an action to be executed. |
|---|
| 57 | .I Field |
|---|
| 58 | is an integer in the range 0 through 11, indicating the desired status |
|---|
| 59 | field. |
|---|
| 60 | The indices and meanings of each field are documented on the |
|---|
| 61 | .IR x3270-script (1) |
|---|
| 62 | manual page. |
|---|
| 63 | .SH EXIT STATUS |
|---|
| 64 | If the requested |
|---|
| 65 | .I action |
|---|
| 66 | succeeds, |
|---|
| 67 | .B x3270if |
|---|
| 68 | exits with status 0. |
|---|
| 69 | If the action fails, |
|---|
| 70 | .B x3270if |
|---|
| 71 | exits with status 1. |
|---|
| 72 | If there is an operational error within |
|---|
| 73 | .B x3270if |
|---|
| 74 | itself, such as a command-line syntax error, missing environment |
|---|
| 75 | variable, or closed pipe, |
|---|
| 76 | .B x3270if |
|---|
| 77 | exits with status 2. |
|---|
| 78 | .SH ENVIRONMENT |
|---|
| 79 | .I x3270 |
|---|
| 80 | uses a pair of pipes for communication with each child process. |
|---|
| 81 | The values of the file descriptors for these pipes are encoded as text |
|---|
| 82 | in two environment variables, which are required by |
|---|
| 83 | .BR x3270if : |
|---|
| 84 | .TP |
|---|
| 85 | .B X3270OUTPUT |
|---|
| 86 | Output from |
|---|
| 87 | .IR x3270 , |
|---|
| 88 | input to the child process. |
|---|
| 89 | .TP |
|---|
| 90 | .B X3270INPUT |
|---|
| 91 | Input to |
|---|
| 92 | .IR x3270 , |
|---|
| 93 | output from the child process. |
|---|
| 94 | .SH "SEE ALSO" |
|---|
| 95 | .IR x3270 (1), " x3270-script" (1) |
|---|
| 96 | .SH COPYRIGHT |
|---|
| 97 | Copyright 1995 by Paul Mattes. |
|---|
| 98 | .RS |
|---|
| 99 | Permission to use, copy, modify, and distribute this software and its |
|---|
| 100 | documentation for any purpose and without fee is hereby granted, |
|---|
| 101 | provided that the above copyright notice appear in all copies and that |
|---|
| 102 | both that copyright notice and this permission notice appear in |
|---|
| 103 | supporting documentation. |
|---|
| 104 | .RE |
|---|
