2021-05-11 02:29:21 +02:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > TCP Function System - Zsh Manual< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
2022-09-01 07:20:37 +02:00
< link rel = "stylesheet" href = "./theme/catppuccin.css" >
< link rel = "stylesheet" href = "./theme/catppuccin-highlight.css" >
2021-05-11 02:29:21 +02:00
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2022-08-24 15:22:41 +02:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "The-Z-Shell-Manual.html" > < strong aria-hidden = "true" > 1.< / strong > The Z Shell Manual< / a > < / li > < li class = "chapter-item expanded " > < a href = "Introduction.html" > < strong aria-hidden = "true" > 2.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "Roadmap.html" > < strong aria-hidden = "true" > 3.< / strong > Roadmap< / a > < / li > < li class = "chapter-item expanded " > < a href = "Invocation.html" > < strong aria-hidden = "true" > 4.< / strong > Invocation< / a > < / li > < li class = "chapter-item expanded " > < a href = "Files.html" > < strong aria-hidden = "true" > 5.< / strong > Files< / a > < / li > < li class = "chapter-item expanded " > < a href = "Shell-Grammar.html" > < strong aria-hidden = "true" > 6.< / strong > Shell Grammar< / a > < / li > < li class = "chapter-item expanded " > < a href = "Redirection.html" > < strong aria-hidden = "true" > 7.< / strong > Redirection< / a > < / li > < li class = "chapter-item expanded " > < a href = "Command-Execution.html" > < strong aria-hidden = "true" > 8.< / strong > Command Execution< / a > < / li > < li class = "chapter-item expanded " > < a href = "Functions.html" > < strong aria-hidden = "true" > 9.< / strong > Functions< / a > < / li > < li class = "chapter-item expanded " > < a href = "Jobs-&-Signals.html" > < strong aria-hidden = "true" > 10.< / strong > Jobs & Signals< / a > < / li > < li class = "chapter-item expanded " > < a href = "Arithmetic-Evaluation.html" > < strong aria-hidden = "true" > 11.< / strong > Arithmetic Evaluation< / a > < / li > < li class = "chapter-item expanded " > < a href = "Conditional-Expressions.html" > < strong aria-hidden = "true" > 12.< / strong > Conditional Expressions< / a > < / li > < li class = "chapter-item expanded " > < a href = "Prompt-Expansion.html" > < strong aria-hidden = "true" > 13.< / strong > Prompt Expansion< / a > < / li > < li class = "chapter-item expanded " > < a href = "Expansion.html" > < strong aria-hidden = "true" > 14.< / strong > Expansion< / a > < / li > < li class = "chapter-item expanded " > < a href = "Parameters.html" > < strong aria-hidden = "true" > 15.< / strong > Parameters< / a > < / li > < li class = "chapter-item expanded " > < a href = "Options.html" > < strong aria-hidden = "true" > 16.< / strong > Options< / a > < / li > < li class = "chapter-item expanded " > < a href = "Shell-Builtin-Commands.html" > < strong aria-hidden = "true" > 17.< / strong > Shell Builtin Commands< / a > < / li > < li class = "chapter-item expanded " > < a href = "Zsh-Line-Editor.html" > < strong aria-hidden = "true" > 18.< / strong > Zsh Line Editor< / a > < / li > < li class = "chapter-item expanded " > < a href = "Completion-Widgets.html" > < strong aria-hidden = "true" > 19.< / strong > Completion Widgets< / a > < / li > < li class = "chapter-item expanded " > < a href = "Completion-System.html" > < strong aria-hidden = "true" > 20.< / strong > Completion System< / a > < / li > < li class = "chapter-item expanded " > < a href = "Completion-Using-compctl.html" > < strong aria-hidden = "true" > 21.< / strong > Completion Using compctl< / a > < / li > < li class = "chapter-item expanded " > < a href = "Zsh-Modules.html" > < strong aria-hidden = "true" > 22.< / strong > Zsh Modules< / a > < / li > < li class = "chapter-item expanded " > < a href = "Calendar-Function-System.html" > < strong aria-hidden = "true" > 23.< / strong > Calendar Function System< / a > < / li > < li class = "chapter-item expanded " > < a href = "TCP-Function-System.html" class = "active" > < strong aria-hidden = "true" > 24.< / strong > TCP Function System< / a > < / li > < li class = "chapter-item expanded " > < a href = "Zftp-Function-System.html" > < strong aria-hidden = "true" > 25.< / strong > Zftp Function System< / a > < / li > < li class = "chapter-item expanded " > < a href = "User-Contributions.html" > < strong aria-hidden = "true" > 26.< / strong > User Contributions< / a > < / li > < / ol >
2021-05-11 02:29:21 +02:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2022-08-24 15:22:41 +02:00
< div id = "menu-bar-hover-placeholder" > < / div >
2021-05-11 02:29:21 +02:00
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
2022-09-01 07:20:37 +02:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "latte" > Latte< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "frappe" > Frappé< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "macchiato" > Macchiato< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "mocha" > Mocha< / button > < / li >
2021-05-11 02:29:21 +02:00
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > Zsh Manual< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2021-05-17 17:00:52 +02:00
2021-05-11 02:29:21 +02:00
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
2021-05-17 17:00:52 +02:00
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
2021-05-11 02:29:21 +02:00
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE - RUN doctoc TO UPDATE -->
< p > < strong > Table of Contents< / strong > < em > generated with < a href = "https://github.com/thlorenz/doctoc" > DocToc< / a > < / em > < / p >
< ul >
< li > < a href = "#24-tcp-function-system" > 24 TCP Function System< / a >
< ul >
< li > < a href = "#241-description" > 24.1 Description< / a > < / li >
< li > < a href = "#242-tcp-user-functions" > 24.2 TCP User Functions< / a >
< ul >
< li > < a href = "#2421-basic-io" > 24.2.1 Basic I/O< / a > < / li >
< li > < a href = "#2422-session-management" > 24.2.2 Session Management< / a > < / li >
< li > < a href = "#2423-advanced-io" > 24.2.3 Advanced I/O< / a > < / li >
< li > < a href = "#2424-one-shot-file-transfer" > 24.2.4 ‘ ’ < / a > < / li >
< / ul >
< / li >
< li > < a href = "#243-tcp-user-defined-functions" > 24.3 TCP User-defined Functions< / a > < / li >
< li > < a href = "#244-tcp-utility-functions" > 24.4 TCP Utility Functions< / a > < / li >
< li > < a href = "#245-tcp-user-parameters" > 24.5 TCP User Parameters< / a > < / li >
< li > < a href = "#246-tcp-user-defined-parameters" > 24.6 TCP User-defined Parameters< / a > < / li >
< li > < a href = "#247-tcp-utility-parameters" > 24.7 TCP Utility Parameters< / a > < / li >
< li > < a href = "#248-tcp-examples" > 24.8 TCP Examples< / a > < / li >
< li > < a href = "#249-tcp-bugs" > 24.9 TCP Bugs< / a > < / li >
< / ul >
< / li >
< / ul >
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2022-08-24 15:22:41 +02:00
< p > < span id = "TCP-Function-System" > < / span > < span
id="TCP-Function-System-1">< / span > < / p >
2021-05-11 02:29:21 +02:00
< h1 id = "24-tcp-function-system" > < a class = "header" href = "#24-tcp-function-system" > 24 TCP Function System< / a > < / h1 >
2022-08-24 15:22:41 +02:00
< p > < span id = "index-TCP-function-system" > < / span > < span
id="index-ztcp_002c-function-system-based-on">< / span > < / p >
2021-05-11 02:29:21 +02:00
< hr / >
2022-08-24 15:22:41 +02:00
< p > < span id = "Description-9" > < / span > < / p >
2021-05-11 02:29:21 +02:00
< h2 id = "241-description" > < a class = "header" href = "#241-description" > 24.1 Description< / a > < / h2 >
2022-08-24 15:22:41 +02:00
< p > A module zsh/net/tcp is provided to provide network I/O over TCP/IP from
within the shell; see its description in < a href = "Zsh-Modules.html#Zsh-Modules" > Zsh
2021-05-11 02:29:21 +02:00
Modules< / a > . This manual page describes a
function suite based on the module. If the module is installed, the
functions are usually installed at the same time, in which case they
will be available for autoloading in the default function search path.
2022-08-24 15:22:41 +02:00
In addition to the zsh/net/tcp module, the zsh/zselect module is used to
implement timeouts on read operations. For troubleshooting tips, consult
the corresponding advice for the zftp functions described in < a href = "Zftp-Function-System.html#Zftp-Function-System" > Zftp
Function System< / a > .< / p >
2021-05-11 02:29:21 +02:00
< p > There are functions corresponding to the basic I/O operations open,
2022-08-24 15:22:41 +02:00
close, read and send, named tcp_open etc., as well as a function
tcp_expect for pattern match analysis of data read as input. The system
makes it easy to receive data from and send data to multiple named
sessions at once. In addition, it can be linked with the shell’
editor in such a way that input data is automatically shown at the
2021-05-11 02:29:21 +02:00
terminal. Other facilities available including logging, filtering and
configurable output prompts.< / p >
< p > To use the system where it is available, it should be enough to
2022-08-24 15:22:41 +02:00
‘ ’
session. The tcp_open function will autoload the remaining functions.< / p >
2021-05-11 02:29:21 +02:00
< hr / >
< p > < span id = "TCP-Functions" > < / span > < span id = "TCP-User-Functions" > < / span > < / p >
< h2 id = "242-tcp-user-functions" > < a class = "header" href = "#242-tcp-user-functions" > 24.2 TCP User Functions< / a > < / h2 >
< hr / >
< p > < span id = "Basic-I_002fO" > < / span > < / p >
< h3 id = "2421-basic-io" > < a class = "header" href = "#2421-basic-io" > 24.2.1 Basic I/O< / a > < / h3 >
< p > < span id = "index-tcp_005fopen" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_open [ -qz ] < code > host port< / code > [ < code > sess< / code > ]< / p >
< p > tcp_open [ -qz ] [ -s < code > sess< / code > | -l < code > sess< / code > [,...] ] ...< / p >
< p > tcp_open [ -qz ] [ -a < code > fd< / code > | -f < code > fd< / code > ] [ < code > sess< / code > ]< / p >
2021-05-11 02:29:21 +02:00
< p > Open a new session. In the first and simplest form, open a TCP
connection to host < code > host< / code > at port < code > port< / code > ; numeric and symbolic forms are
understood for both.< / p >
< p > If < code > sess< / code > is given, this becomes the name of the session which can be
used to refer to multiple different TCP connections. If < code > sess< / code > is not
given, the function will invent a numeric name value (note this is < em > not< / em >
the same as the file descriptor to which the session is attached). It is
recommended that session names not include ‘ ’
funny characters are not well-defined but certainly do not include
alphanumerics or underscores, and certainly do include whitespace.< / p >
< p > In the second case, one or more sessions to be opened are given by name.
2022-08-24 15:22:41 +02:00
A single session name is given after -s and a comma-separated list after
-l; both options may be repeated as many times as necessary. A failure
to open any session causes tcp_open to abort. The host and port are read
from the file .ztcp_sessions in the same directory as the user’
initialisation files, i.e. usually the home directory, but $ZDOTDIR if
that is set. The file consists of lines each giving a session name and
the corresponding host and port, in that order (note the session name
comes first, not last), separated by whitespace.< / p >
< p > The third form allows passive and fake TCP connections. If the option -a
is used, its argument is a file descriptor open for listening for
2021-05-11 02:29:21 +02:00
connections. No function front-end is provided to open such a file
2022-08-24 15:22:41 +02:00
descriptor, but a call to ‘ < code > port< / code > ’
descriptor stored in the parameter $REPLY. The listening port can be
closed with ‘ < code > fd< / code > ’ ‘ < code > fd< / code > ’
until a remote TCP connection is made to < code > port< / code > on the local machine. At
this point, a session is created in the usual way and is largely
indistinguishable from an active connection created with one of the
first two forms.< / p >
< p > If the option -f is used, its argument is a file descriptor which is
2021-05-11 02:29:21 +02:00
used directly as if it were a TCP session. How well the remainder of the
TCP function system copes with this depends on what actually underlies
this file descriptor. A regular file is likely to be unusable; a FIFO
(pipe) of some sort will work better, but note that it is not a good
idea for two different sessions to attempt to read from the same FIFO at
once.< / p >
2022-08-24 15:22:41 +02:00
< p > If the option -q is given with any of the three forms, tcp_open will not
print informational messages, although it will in any case exit with an
appropriate status.< / p >
2021-05-11 02:29:21 +02:00
< p > If the line editor (zle) is in use, which is typically the case if the
2022-08-24 15:22:41 +02:00
shell is interactive, tcp_open installs a handler inside zle which will
check for new data at the same time as it checks for keyboard input.
This is convenient as the shell consumes no CPU time while waiting; the
test is performed by the operating system. Giving the option -z to any
of the forms of tcp_open prevents the handler from being installed, so
data must be read explicitly. Note, however, this is not necessary for
executing complete sets of send and read commands from a function, as
zle is not active at this point. Generally speaking, the handler is only
active when the shell is waiting for input at a command prompt or in the
vared builtin. The option has no effect if zle is not active; ‘
zle]]’ < / p >
2021-05-11 02:29:21 +02:00
< p > The first session to be opened becomes the current session and
2022-08-24 15:22:41 +02:00
subsequent calls to tcp_open do not change it. The current session is
stored in the parameter $TCP_SESS; see below for more detail about the
2021-05-11 02:29:21 +02:00
parameters used by the system.< / p >
2022-08-24 15:22:41 +02:00
< p > The function tcp_on_open, if defined, is called when a session is
2021-05-11 02:29:21 +02:00
opened. See the description below.< / p >
< p > < span id = "index-tcp_005fclose" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_close [ -qn ] [ -a | -l < code > sess< / code > [,...] | < code > sess< / code > ... ]< / p >
2021-05-11 02:29:21 +02:00
< p > Close the named sessions, or the current session if none is given, or
2022-08-24 15:22:41 +02:00
all open sessions if -a is given. The options -l and -s are both handled
for consistency with tcp_open, although the latter is redundant.< / p >
< p > If the session being closed is the current one, $TCP_SESS is unset,
2021-05-11 02:29:21 +02:00
leaving no current session, even if there are other sessions still open.< / p >
2022-08-24 15:22:41 +02:00
< p > If the session was opened with tcp_open -f, the file descriptor is
2021-05-11 02:29:21 +02:00
closed so long as it is in the range 0 to 9 accessible directly from the
2022-08-24 15:22:41 +02:00
command line. If the option -n is given, no attempt will be made to
close file descriptors in this case. The -n option is not used for
genuine ztcp session; the file descriptors are always closed with the
2021-05-11 02:29:21 +02:00
session.< / p >
2022-08-24 15:22:41 +02:00
< p > If the option -q is given, no informational messages will be printed.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005fread" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_read [ -bdq ] [ -t < code > TO< / code > ] [ -T < code > TO< / code > ]< / p >
< p > < code > fd< / code > [,...] | -l < code > sess< / code > [,...] | -s < code > sess< / code > ...
]< / p >
2021-05-11 02:29:21 +02:00
< p > Perform a read operation on the current session, or on a list of
2022-08-24 15:22:41 +02:00
sessions if any are given with -u, -l or -s, or all open sessions if the
option -a is given. Any of the -u, -l or -s options may be repeated or
mixed together. The -u option specifies a file descriptor directly (only
those managed by this system are useful), the other two specify sessions
as described for tcp_open above.< / p >
2021-05-11 02:29:21 +02:00
< p > The function checks for new data available on all the sessions listed.
2022-08-24 15:22:41 +02:00
Unless the -b option is given, it will not block waiting for new data.
2021-05-11 02:29:21 +02:00
Any one line of data from any of the available sessions will be read,
2022-08-24 15:22:41 +02:00
stored in the parameter $TCP_LINE, and displayed to standard output
unless $TCP_SILENT contains a non-empty string. When printed to standard
output the string $TCP_PROMPT will be shown at the start of the line;
the default form for this includes the name of the session being read.
See below for more information on these parameters. In this mode,
tcp_read can be called repeatedly until it returns status 2 which
indicates all pending input from all specified sessions has been
2021-05-11 02:29:21 +02:00
handled.< / p >
2022-08-24 15:22:41 +02:00
< p > With the option -b, equivalent to an infinite timeout, the function will
block until a line is available to read from one of the specified
2021-05-11 02:29:21 +02:00
sessions. However, only a single line is returned.< / p >
2022-08-24 15:22:41 +02:00
< p > The option -d indicates that all pending input should be drained. In
this case tcp_read may process multiple lines in the manner given above;
only the last is stored in $TCP_LINE, but the complete set is stored in
the array $tcp_lines. This is cleared at the start of each call to
tcp_read.< / p >
< p > The options -t and -T specify a timeout in seconds, which may be a
floating point number for increased accuracy. With -t the timeout is
applied before each line read. With -T, the timeout applies to the
2021-05-11 02:29:21 +02:00
overall operation, possibly including multiple read operations if the
2022-08-24 15:22:41 +02:00
option -d is present; without this option, there is no distinction
between -t and -T.< / p >
< p > The function does not print informational messages, but if the option -q
is given, no error message is printed for a non-existent session.< / p >
2021-05-11 02:29:21 +02:00
< p > A return status of 2 indicates a timeout or no data to read. Any other
non-zero return status indicates some error condition.< / p >
2022-08-24 15:22:41 +02:00
< p > See tcp_log for how to control where data is sent by tcp_read.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005fsend" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_send [ -cnq ] [ -s < code > sess< / code > | -l < code > sess< / code > [,...] ] < code > data< / code > ...< / p >
< p > tcp_send [ -cnq ] -a < code > data< / code > ...< / p >
2021-05-11 02:29:21 +02:00
< p > Send the supplied data strings to all the specified sessions in turn.
2022-08-24 15:22:41 +02:00
The underlying operation differs little from a ‘ ’
2021-05-11 02:29:21 +02:00
session’
2022-08-24 15:22:41 +02:00
from dying owing to a SIGPIPE caused by an attempt to write to a defunct
session.< / p >
< p > The option -c causes tcp_send to behave like cat. It reads lines from
standard input until end of input and sends them in turn to the
2021-05-11 02:29:21 +02:00
specified session(s) exactly as if they were given as < code > data< / code > arguments
2022-08-24 15:22:41 +02:00
to individual tcp_send commands.< / p >
< p > The option -n prevents tcp_send from putting a newline at the end of the
data strings.< / p >
< p > The remaining options all behave as for tcp_read.< / p >
2021-05-11 02:29:21 +02:00
< p > The data arguments are not further processed once they have been passed
2022-08-24 15:22:41 +02:00
to tcp_send; they are simply passed down to print -r.< / p >
< p > If the parameter $TCP_OUTPUT is a non-empty string and logging is
2021-05-11 02:29:21 +02:00
enabled then the data sent to each session will be echoed to the log
2022-08-24 15:22:41 +02:00
file(s) with $TCP_OUTPUT in front where appropriate, much in the manner
of $TCP_PROMPT.< / p >
2021-05-11 02:29:21 +02:00
< hr / >
< p > < span id = "Session-Management" > < / span > < / p >
< h3 id = "2422-session-management" > < a class = "header" href = "#2422-session-management" > 24.2.2 Session Management< / a > < / h3 >
< p > < span id = "index-tcp_005falias" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_alias [ -q ] < code > alias< / code > =< code > sess< / code > ...< / p >
< p > tcp_alias [ -q ] [ < code > alias< / code > ... ]< / p >
< p > tcp_alias -d [ -q ] < code > alias< / code > ...< / p >
2021-05-11 02:29:21 +02:00
< p > This function is not particularly well tested.< / p >
< p > The first form creates an alias for a session name; < code > alias< / code > can then be
used to refer to the existing session < code > sess< / code > . As many aliases may be
listed as required.< / p >
< p > The second form lists any aliases specified, or all aliases if none.< / p >
< p > The third form deletes all the aliases listed. The underlying sessions
are not affected.< / p >
2022-08-24 15:22:41 +02:00
< p > The option -q suppresses an inconsistently chosen subset of error
2021-05-11 02:29:21 +02:00
messages.< / p >
< p > < span id = "index-tcp_005flog" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_log [ -asc ] [ -n | -N ] [ < code > logfile< / code > ]< / p >
< p > With an argument < code > logfile< / code > , all future input from tcp_read will be
logged to the named file. Unless -a (append) is given, this file will
2021-05-11 02:29:21 +02:00
first be truncated or created empty. With no arguments, show the current
status of logging.< / p >
2022-08-24 15:22:41 +02:00
< p > With the option -s, per-session logging is enabled. Input from tcp_read
is output to the file < code > logfile< / code > .< code > sess< / code > . As the session is automatically
discriminated by the filename, the contents are raw (no $TCP_PROMPT).
The option -a applies as above. Per-session logging and logging of all
data in one file are not mutually exclusive.< / p >
< p > The option -c closes all logging, both complete and per-session logs.< / p >
< p > The options -n and -N respectively turn off or restore output of data
read by tcp_read to standard output; hence ‘ ’
output by tcp_read.< / p >
2021-05-11 02:29:21 +02:00
< p > The function is purely a convenient front end to setting the parameters
2022-08-24 15:22:41 +02:00
$TCP_LOG, $TCP_LOG_SESS, $TCP_SILENT, which are described below.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005frename" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_rename < code > old< / code > < code > new< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > Rename session < code > old< / code > to session < code > new< / code > . The old name becomes invalid.< / p >
< p > < span id = "index-tcp_005fsess" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_sess [ < code > sess< / code > [ < code > command< / code > [ < code > arg< / code > ... ] ] ]< / p >
2021-05-11 02:29:21 +02:00
< p > With no arguments, list all the open sessions and associated file
descriptors. The current session is marked with a star. For use in
2022-08-24 15:22:41 +02:00
functions, direct access to the parameters $tcp_by_name, $tcp_by_fd and
$TCP_SESS is probably more convenient; see below.< / p >
2021-05-11 02:29:21 +02:00
< p > With a < code > sess< / code > argument, set the current session to < code > sess< / code > . This is
2022-08-24 15:22:41 +02:00
equivalent to changing $TCP_SESS directly.< / p >
2021-05-11 02:29:21 +02:00
< p > With additional arguments, temporarily set the current session while
executing ‘ < code > command< / code > < code > arg< / code > ...’ < code > command< / code > is re-evaluated so as to
expand aliases etc., but the remaining < code > arg< / code > s are passed through as that
2022-08-24 15:22:41 +02:00
appear to tcp_sess. The original session is restored when tcp_sess
2021-05-11 02:29:21 +02:00
exits.< / p >
< hr / >
< p > < span id = "Advanced-I_002fO" > < / span > < / p >
< h3 id = "2423-advanced-io" > < a class = "header" href = "#2423-advanced-io" > 24.2.3 Advanced I/O< / a > < / h3 >
< p > < span id = "index-tcp_005fcommand" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_command < code > send-option< / code > ... < code > send-argument< / code > ...< / p >
< p > This is a convenient front-end to tcp_send. All arguments are passed to
tcp_send, then the function pauses waiting for data. While data is
arriving at least every $TCP_TIMEOUT (default 0.3) seconds, data is
2021-05-11 02:29:21 +02:00
handled and printed out according to the current settings. Status 0 is
always returned.< / p >
< p > This is generally only useful for interactive use, to prevent the
display becoming fragmented by output returned from the connection.
Within a programme or function it is generally better to handle reading
data by a more explicit method.< / p >
< p > < span id = "index-tcp_005fexpect" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_expect [ -q ] [ -p < code > var< / code > | -P < code > var< / code > ] [ -t < code > TO< / code > | -T < code > TO< / code > ]< / p >
< p > < code > sess< / code > | -l < code > sess< / code > [,...] ] < code > pattern< / code > ...< / p >
2021-05-11 02:29:21 +02:00
< p > Wait for input matching any of the given < code > pattern< / code > s from any of the
specified sessions. Input is ignored until an input line matches one of
the given patterns; at this point status zero is returned, the matching
2022-08-24 15:22:41 +02:00
line is stored in $TCP_LINE, and the full set of lines read during the
call to tcp_expect is stored in the array $tcp_expect_lines.< / p >
< p > Sessions are specified in the same way as tcp_read: the default is to
use the current session, otherwise the sessions specified by -a, -s, or
-l are used.< / p >
2021-05-11 02:29:21 +02:00
< p > Each < code > pattern< / code > is a standard zsh extended-globbing pattern; note that it
needs to be quoted to avoid it being expanded immediately by filename
generation. It must match the full line, so to match a substring there
2022-08-24 15:22:41 +02:00
must be a ‘ ’
the $TCP_PROMPT added by tcp_read. It is possible to include the
globbing flags ‘ ’ ‘ ’
available in the parameters $MATCH, $match, etc., as described in the
base zsh documentation on pattern matching.< / p >
< p > Unlike tcp_read, the default behaviour of tcp_expect is to block
2021-05-11 02:29:21 +02:00
indefinitely until the required input is found. This can be modified by
2022-08-24 15:22:41 +02:00
specifying a timeout with -t or -T; these function as in tcp_read,
2021-05-11 02:29:21 +02:00
specifying a per-read or overall timeout, respectively, in seconds, as
2022-08-24 15:22:41 +02:00
an integer or floating-point number. As tcp_read, the function returns
2021-05-11 02:29:21 +02:00
status 2 if a timeout occurs.< / p >
< p > The function returns as soon as any one of the patterns given match. If
2022-08-24 15:22:41 +02:00
the caller needs to know which of the patterns matched, the option -p
< code > var< / code > can be used; on return, $var is set to the number of the pattern
2021-05-11 02:29:21 +02:00
using ordinary zsh indexing, i.e. the first is 1, and so on. Note the
2022-08-24 15:22:41 +02:00
absence of a ‘ ’ < code > var< / code > . To avoid clashes, the parameter
cannot begin with ‘ ’
and 0 if there is no match.< / p >
< p > The option -P < code > var< / code > works similarly to -p, but instead of numerical
2021-05-11 02:29:21 +02:00
indexes the regular arguments must begin with a prefix followed by a
colon: that prefix is then used as a tag to which < code > var< / code > is set when the
2022-08-24 15:22:41 +02:00
argument matches. The tag timeout is used if there is a timeout and the
empty string if there is no match. Note it is matches do not need to be
distinguished.< / p >
< p > The option -q is passed directly down to tcp_read.< / p >
< p > As all input is done via tcp_read, all the usual rules about output of
lines read apply. One exception is that the parameter $tcp_lines will
only reflect the line actually matched by tcp_expect; use
$tcp_expect_lines for the full set of lines read during the function
2021-05-11 02:29:21 +02:00
call.< / p >
< p > < span id = "index-tcp_005fproxy" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_proxy< / p >
2021-05-11 02:29:21 +02:00
< p > This is a simple-minded function to accept a TCP connection and execute
a command with I/O redirected to the connection. Extreme caution should
be taken as there is no security whatsoever and this can leave your
computer open to the world. Ideally, it should only be used behind a
firewall.< / p >
< p > The first argument is a TCP port on which the function will listen.< / p >
< p > The remaining arguments give a command and its arguments to execute with
standard input, standard output and standard error redirected to the
file descriptor on which the TCP session has been accepted. If no
command is given, a new zsh is started. This gives everyone on your
network direct access to your account, which in many cases will be a bad
thing.< / p >
2022-08-24 15:22:41 +02:00
< p > The command is run in the background, so tcp_proxy can then accept new
2021-05-11 02:29:21 +02:00
connections. It continues to accept new connections until interrupted.< / p >
< p > < span id = "index-tcp_005fspam" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_spam [ -ertv ] [ -a | -s < code > sess< / code > | -l < code > sess< / code > [,...] ] < code > cmd< / code > [
< code > arg< / code > ... ]< / p >
2021-05-11 02:29:21 +02:00
< p > Execute ‘ < code > cmd< / code > [ < code > arg< / code > ... ]’
executes the command and arguments; it does not send the command line as
2022-08-24 15:22:41 +02:00
data unless the -t (transmit) option is given.< / p >
< p > The sessions may be selected explicitly with the standard -a, -s or -l
options, or may be chosen implicitly. If none of the three options is
given the rules are: first, if the array $tcp_spam_list is set, this is
taken as the list of sessions, otherwise all sessions are taken. Second,
any sessions given in the array $tcp_no_spam_list are removed from the
list of sessions.< / p >
< p > Normally, any sessions added by the ‘ ’
2021-05-11 02:29:21 +02:00
chosen implicitly are spammed in alphabetic order; sessions given by the
2022-08-24 15:22:41 +02:00
$tcp_spam_list array or on the command line are spammed in the order
given. The -r flag reverses the order however it was arrived it.< / p >
< p > The -v flag specifies that a $TCP_PROMPT will be output before each
session. This is output after any modification to TCP_SESS by the
user-defined tcp_on_spam function described below. (Obviously that
2021-05-11 02:29:21 +02:00
function is able to generate its own output.)< / p >
2022-08-24 15:22:41 +02:00
< p > If the option -e is present, the line given as ‘ < code > cmd< / code > [ < code > arg< / code > ... ]’
is executed using eval, otherwise it is executed without any further
2021-05-11 02:29:21 +02:00
processing.< / p >
< p > < span id = "index-tcp_005ftalk" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_talk< / p >
2021-05-11 02:29:21 +02:00
< p > This is a fairly simple-minded attempt to force input to the line editor
2022-08-24 15:22:41 +02:00
to go straight to the default TCP_SESS.< / p >
< p > An escape string, $TCP_TALK_ESCAPE, default ‘ ’
to normal shell operation. If it is on its own at the start of the line,
or followed only by whitespace, the line editor returns to normal
operation. Otherwise, the string and any following whitespace are
2021-05-11 02:29:21 +02:00
skipped and the remainder of the line executed as shell input without
any change of the line editor’ < / p >
< p > The current implementation is somewhat deficient in terms of use of the
command history. For this reason, many users will prefer to use some
form of alternative approach for sending data easily to the current
session. One simple approach is to alias some special character (such as
2022-08-24 15:22:41 +02:00
‘ ’ ‘ ’ < / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005fwait" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_wait< / p >
2021-05-11 02:29:21 +02:00
< p > The sole argument is an integer or floating point number which gives the
seconds to delay. The shell will do nothing for that period except wait
2022-08-24 15:22:41 +02:00
for input on all TCP sessions by calling tcp_read -a. This is similar to
the interactive behaviour at the command prompt when zle handlers are
2021-05-11 02:29:21 +02:00
installed.< / p >
< hr / >
< p > < span id = "g_t_0060One_002dshot_0027-file-transfer" > < / span > < / p >
< h3 id = "2424-one-shot-file-transfer" > < a class = "header" href = "#2424-one-shot-file-transfer" > 24.2.4 ‘ ’ < / a > < / h3 >
2022-08-24 15:22:41 +02:00
< p > tcp_point < code > port< / code > < br / >
tcp_shoot < code > host< / code > < code > port< / code > < br / >
This pair of functions provide a simple way to transfer a file between
two hosts within the shell. Note, however, that bulk data transfer is
currently done using cat. tcp_point reads any data arriving at < code > port< / code >
and sends it to standard output; tcp_shoot connects to < code > port< / code > on < code > host< / code >
and sends its standard input. Any unused < code > port< / code > may be used; the
standard mechanism for picking a port is to think of a random four-digit
number above 1024 until one works.< / p >
< p > To transfer a file from host woodcock to host springes, on springes:< / p >
2021-05-11 02:29:21 +02:00
< div class = "example" >
2022-08-24 15:22:41 +02:00
< pre > < code class = "language-zsh" > tcp_point 8091 > output_file
2021-05-11 02:29:21 +02:00
< / code > < / pre >
< / div >
2022-08-24 15:22:41 +02:00
< p > and on woodcock:< / p >
2021-05-11 02:29:21 +02:00
< div class = "example" >
2022-08-24 15:22:41 +02:00
< pre > < code class = "language-zsh" > tcp_shoot springes 8091 < input_file
2021-05-11 02:29:21 +02:00
< / code > < / pre >
< / div >
2022-08-24 15:22:41 +02:00
< p > As these two functions do not require tcp_open to set up a TCP
2021-05-11 02:29:21 +02:00
connection first, they may need to be autoloaded separately.< / p >
< hr / >
< p > < span id = "TCP-User_002ddefined-Functions" > < / span > < / p >
< h2 id = "243-tcp-user-defined-functions" > < a class = "header" href = "#243-tcp-user-defined-functions" > 24.3 TCP User-defined Functions< / a > < / h2 >
< p > Certain functions, if defined by the user, will be called by the
function system in certain contexts. This facility depends on the module
2022-08-24 15:22:41 +02:00
zsh/parameter, which is usually available in interactive shells as the
2021-05-11 02:29:21 +02:00
completion system depends on it. None of the functions need be defined;
they simply provide convenient hooks when necessary.< / p >
< p > Typically, these are called after the requested action has been taken,
so that the various parameters will reflect the new state.< / p >
< p > < span id = "index-tcp_005fon_005falias" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_alias < code > alias< / code > < code > fd< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > When an alias is defined, this function will be called with two
arguments: the name of the alias, and the file descriptor of the
corresponding session.< / p >
< p > < span id = "index-tcp_005fon_005fawol" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_awol < code > sess< / code > < code > fd< / code > < / p >
< p > If the function tcp_fd_handler is handling input from the line editor
2021-05-11 02:29:21 +02:00
and detects that the file descriptor is no longer reusable, by default
it removes it from the list of file descriptors handled by this method
2022-08-24 15:22:41 +02:00
and prints a message. If the function tcp_on_awol is defined it is
2021-05-11 02:29:21 +02:00
called immediately before this point. It may return status 100, which
indicates that the normal handling should still be performed; any other
return status indicates that no further action should be taken and the
2022-08-24 15:22:41 +02:00
tcp_fd_handler should return immediately with the given status.
Typically the action of tcp_on_awol will be to close the session.< / p >
< p > The variable TCP_INVALIDATE_ZLE will be a non-empty string if it is
necessary to invalidate the line editor display using ‘ ’
2021-05-11 02:29:21 +02:00
printing output from the function.< / p >
< p > (‘ ’ ‘ ’
It has no pre-existing technical meaning known to the author.)< / p >
< p > < span id = "index-tcp_005fon_005fclose" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_close < code > sess< / code > < code > fd< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > This is called with the name of a session being closed and the file
descriptor which corresponded to that session. Both will be invalid by
the time the function is called.< / p >
< p > < span id = "index-tcp_005fon_005fopen" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_open < code > sess< / code > < code > fd< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > This is called after a new session has been defined with the session
name and file descriptor as arguments. If it returns a non-zero status,
opening the session is assumed to fail and the session is closed again;
2022-08-24 15:22:41 +02:00
however, tcp_open will continue to attempt to open any remaining
2021-05-11 02:29:21 +02:00
sessions given on the command line.< / p >
< p > < span id = "index-tcp_005fon_005frename" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_rename < code > oldsess< / code > < code > fd< / code > < code > newsess< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > This is called after a session has been renamed with the three arguments
old session name, file descriptor, new session name.< / p >
< p > < span id = "index-tcp_005fon_005fspam" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_spam < code > sess< / code > < code > command ...< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > This is called once for each session spammed, just < em > before< / em > a command is
2022-08-24 15:22:41 +02:00
executed for a session by tcp_spam. The arguments are the session name
followed by the command list to be executed. If tcp_spam was called with
the option -t, the first command will be tcp_send.< / p >
< p > This function is called after $TCP_SESS is set to reflect the session to
be spammed, but before any use of it is made. Hence it is possible to
alter the value of $TCP_SESS within this function. For example, the
session arguments to tcp_spam could include extra information to be
stripped off and processed in tcp_on_spam.< / p >
< p > If the function sets the parameter $REPLY to ‘ ’
not executed; in addition, no prompt is printed for the -v option to
tcp_spam.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005fon_005funalias" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_unalias < code > alias< / code > < code > fd< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > This is called with the name of an alias and the corresponding session’
file descriptor after an alias has been deleted.< / p >
< hr / >
< p > < span id = "TCP-Utility-Functions" > < / span > < / p >
< h2 id = "244-tcp-utility-functions" > < a class = "header" href = "#244-tcp-utility-functions" > 24.4 TCP Utility Functions< / a > < / h2 >
< p > The following functions are used by the TCP function system but will
rarely if ever need to be called directly.< / p >
< p > < span id = "index-tcp_005ffd_005fhandler" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_fd_handler< / p >
< p > This is the function installed by tcp_open for handling input from
2021-05-11 02:29:21 +02:00
within the line editor, if that is required. It is in the format
2022-08-24 15:22:41 +02:00
documented for the builtin ‘ ’ < a href = "Zsh-Line-Editor.html#Zle-Builtins" > Zle
2021-05-11 02:29:21 +02:00
Builtins< / a > .< / p >
2022-08-24 15:22:41 +02:00
< p > While active, the function sets the parameter TCP_HANDLER_ACTIVE to 1.
2021-05-11 02:29:21 +02:00
This allows shell code called internally (for example, by setting
2022-08-24 15:22:41 +02:00
tcp_on_read) to tell if is being called when the shell is otherwise idle
at the editor prompt.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005foutput" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_output [ -q ] -P < code > prompt< / code > -F < code > fd< / code > -S < code > sess< / code > < / p >
2021-05-11 02:29:21 +02:00
< p > This function is used for both logging and handling output to standard
2022-08-24 15:22:41 +02:00
output, from within tcp_read and (if $TCP_OUTPUT is set) tcp_send.< / p >
< p > The < code > prompt< / code > to use is specified by -P; the default is the empty string.
It can contain:< / p >
< p > %c< br / >
Expands to 1 if the session is the current session, otherwise 0. Used
with ternary expressions such as ‘ ’ ‘ ’
current session and ‘ ’ < / p >
< p > %f< br / >
2021-05-11 02:29:21 +02:00
Replaced by the session’ < / p >
2022-08-24 15:22:41 +02:00
< p > %s< br / >
2021-05-11 02:29:21 +02:00
Replaced by the session name.< / p >
2022-08-24 15:22:41 +02:00
< p > %%< br / >
Replaced by a single ‘ ’ < / p >
< p > The option -q suppresses output to standard output, but not to any log
2021-05-11 02:29:21 +02:00
files which are configured.< / p >
2022-08-24 15:22:41 +02:00
< p > The -S and -F options are used to pass in the session name and file
2021-05-11 02:29:21 +02:00
descriptor for possible replacement in the prompt.< / p >
< hr / >
< p > < span id = "TCP-Parameters" > < / span > < span id = "TCP-User-Parameters" > < / span > < / p >
< h2 id = "245-tcp-user-parameters" > < a class = "header" href = "#245-tcp-user-parameters" > 24.5 TCP User Parameters< / a > < / h2 >
< p > Parameters follow the usual convention that uppercase is used for
scalars and integers, while lowercase is used for normal and associative
array. It is always safe for user code to read these parameters. Some
parameters may also be set; these are noted explicitly. Others are
included in this group as they are set by the function system for the
user’ < / p >
2022-08-24 15:22:41 +02:00
< p > For example, ‘ ’
2021-05-11 02:29:21 +02:00
function call will not be printed to standard output, regardless of the
2022-08-24 15:22:41 +02:00
setting outside the function. Likewise, ‘ < code > sess< / code > ’
session for the duration of a function, and ‘ ’
2021-05-11 02:29:21 +02:00
specifies that no prompt is used for input during the function.< / p >
< p > < span id = "index-tcp_005fexpect_005flines" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_expect_lines< / p >
< p > Array. The set of lines read during the last call to tcp_expect,
including the last ($TCP_LINE).< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005ffilter" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_filter< / p >
2021-05-11 02:29:21 +02:00
< p > Array. May be set directly. A set of extended globbing patterns which,
2022-08-24 15:22:41 +02:00
if matched in tcp_output, will cause the line not to be printed to
2021-05-11 02:29:21 +02:00
standard output. The patterns should be defined as described for the
2022-08-24 15:22:41 +02:00
arguments to tcp_expect. Output of line to log files is not affected.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fHANDLER_005fACTIVE" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_HANDLER_ACTIVE< / p >
< p > Scalar. Set to 1 within tcp_fd_handler to indicate to functions called
2021-05-11 02:29:21 +02:00
recursively that they have been called during an editor session.
Otherwise unset.< / p >
< p > < span id = "index-TCP_005fLINE" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_LINE< / p >
< p > The last line read by tcp_read, and hence also tcp_expect.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fLINE_005fFD" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_LINE_FD< / p >
< p > The file descriptor from which $TCP_LINE was read.
${tcp_by_fd[$TCP_LINE_FD]} will give the corresponding session name.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005flines" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_lines< / p >
< p > Array. The set of lines read during the last call to tcp_read, including
the last ($TCP_LINE).< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fLOG" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_LOG< / p >
< p > May be set directly, although it is also controlled by tcp_log. The name
of a file to which output from all sessions will be sent. The output is
proceeded by the usual $TCP_PROMPT. If it is not an absolute path name,
it will follow the user’ < / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fLOG_005fSESS" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_LOG_SESS< / p >
< p > May be set directly, although it is also controlled by tcp_log. The
2021-05-11 02:29:21 +02:00
prefix for a set of files to which output from each session separately
2022-08-24 15:22:41 +02:00
will be sent; the full filename is ${TCP_LOG_SESS}.< code > sess< / code > . Output to
2021-05-11 02:29:21 +02:00
each file is raw; no prompt is added. If it is not an absolute path
name, it will follow the user’ < / p >
< p > < span id = "index-tcp_005fno_005fspam_005flist" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_no_spam_list< / p >
< p > Array. May be set directly. See tcp_spam for how this is used.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fOUTPUT" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_OUTPUT< / p >
2021-05-11 02:29:21 +02:00
< p > May be set directly. If a non-empty string, any data sent to a session
2022-08-24 15:22:41 +02:00
by tcp_send will be logged. This parameter gives the prompt to be used
in a file specified by $TCP_LOG but not in a file generated from
$TCP_LOG_SESS. The prompt string has the same format as TCP_PROMPT and
the same rules for its use apply.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fPROMPT" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_PROMPT< / p >
< p > May be set directly. Used as the prefix for data read by tcp_read which
is printed to standard output or to the log file given by $TCP_LOG, if
any. Any ‘ ’ ‘ ’ ‘ ’
the name of the session, the session’
single ‘ ’ ‘ ’
session being read is the current session, else 0; this is most useful
in ternary expressions such as ‘ ’ ‘ ’
session is the current one, else ‘ ’ < / p >
< p > If the prompt starts with %P, this is stripped and the complete result
of the previous stage is passed through standard prompt %-style
2021-05-11 02:29:21 +02:00
formatting before being output.< / p >
< p > < span id = "index-TCP_005fREAD_005fDEBUG" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_READ_DEBUG< / p >
< p > May be set directly. If this has non-zero length, tcp_read will give
2021-05-11 02:29:21 +02:00
some limited diagnostics about data being read.< / p >
< p > < span id = "index-TCP_005fSECONDS_005fSTART" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_SECONDS_START< / p >
2021-05-11 02:29:21 +02:00
< p > This value is created and initialised to zero by tcp_open.< / p >
2022-08-24 15:22:41 +02:00
< p > The functions tcp_read and tcp_expect use the shell’
for their own timing purposes. If that parameter is not of floating
point type on entry to one of the functions, it will create a local
parameter SECONDS which is floating point and set the parameter
TCP_SECONDS_START to the previous value of $SECONDS. If the parameter is
already floating point, it is used without a local copy being created
and TCP_SECONDS_START is not set. As the global value is zero, the shell
elapsed time is guaranteed to be the sum of $SECONDS and
$TCP_SECONDS_START.< / p >
< p > This can be avoided by setting SECONDS globally to a floating point
value using ‘ ’
a local copy and never set TCP_SECONDS_START to a non-zero value.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fSESS" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_SESS< / p >
2021-05-11 02:29:21 +02:00
< p > May be set directly. The current session; must refer to one of the
2022-08-24 15:22:41 +02:00
sessions established by tcp_open.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fSILENT" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_SILENT< / p >
< p > May be set directly, although it is also controlled by tcp_log. If of
non-zero length, data read by tcp_read will not be written to standard
2021-05-11 02:29:21 +02:00
output, though may still be written to a log file.< / p >
< p > < span id = "index-tcp_005fspam_005flist" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_spam_list< / p >
< p > Array. May be set directly. See the description of the function tcp_spam
for how this is used.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-TCP_005fTALK_005fESCAPE" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_TALK_ESCAPE< / p >
< p > May be set directly. See the description of the function tcp_talk for
2021-05-11 02:29:21 +02:00
how this is used.< / p >
< p > < span id = "index-TCP_005fTIMEOUT" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > TCP_TIMEOUT< / p >
2021-05-11 02:29:21 +02:00
< p > May be set directly. Currently this is only used by the function
2022-08-24 15:22:41 +02:00
tcp_command, see above.< / p >
2021-05-11 02:29:21 +02:00
< hr / >
< p > < span id = "TCP-User_002ddefined-Parameters" > < / span > < / p >
< h2 id = "246-tcp-user-defined-parameters" > < a class = "header" href = "#246-tcp-user-defined-parameters" > 24.6 TCP User-defined Parameters< / a > < / h2 >
< p > The following parameters are not set by the function system, but have a
special effect if set by the user.< / p >
< p > < span id = "index-tcp_005fon_005fread" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_on_read< / p >
2021-05-11 02:29:21 +02:00
< p > This should be an associative array; if it is not, the behaviour is
undefined. Each key is the name of a shell function or other command,
2022-08-24 15:22:41 +02:00
and the corresponding value is a shell pattern (using EXTENDED_GLOB).
Every line read from a TCP session directly or indirectly using tcp_read
(which includes lines read by tcp_expect) is compared against the
pattern. If the line matches, the command given in the key is called
with two arguments: the name of the session from which the line was
read, and the line itself.< / p >
2021-05-11 02:29:21 +02:00
< p > If any function called to handle a line returns a non-zero status, the
2022-08-24 15:22:41 +02:00
line is not output. Thus a tcp_on_read handler containing only the
instruction ‘ ’
lines (see, however, tcp_filter above). However, the line is still
stored in TCP_LINE and tcp_lines; this occurs after all tcp_on_read
processing.< / p >
2021-05-11 02:29:21 +02:00
< hr / >
< p > < span id = "TCP-Utility-Parameters" > < / span > < / p >
< h2 id = "247-tcp-utility-parameters" > < a class = "header" href = "#247-tcp-utility-parameters" > 24.7 TCP Utility Parameters< / a > < / h2 >
< p > These parameters are controlled by the function system; they may be read
directly, but should not usually be set by user code.< / p >
< p > < span id = "index-tcp_005faliases" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_aliases< / p >
2021-05-11 02:29:21 +02:00
< p > Associative array. The keys are the names of sessions established with
2022-08-24 15:22:41 +02:00
tcp_open; each value is a space-separated list of aliases which refer to
that session.< / p >
2021-05-11 02:29:21 +02:00
< p > < span id = "index-tcp_005fby_005ffd" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_by_fd< / p >
2021-05-11 02:29:21 +02:00
< p > Associative array. The keys are session file descriptors; each value is
the name of that session.< / p >
< p > < span id = "index-tcp_005fby_005fname" > < / span > < / p >
2022-08-24 15:22:41 +02:00
< p > tcp_by_name< / p >
2021-05-11 02:29:21 +02:00
< p > Associative array. The keys are the names of sessions; each value is the
file descriptor associated with that session.< / p >
< hr / >
< p > < span id = "TCP-Examples" > < / span > < span id = "TCP-Examples-1" > < / span > < / p >
< h2 id = "248-tcp-examples" > < a class = "header" href = "#248-tcp-examples" > 24.8 TCP Examples< / a > < / h2 >
< p > Here is a trivial example using a remote calculator.< / p >
2022-08-24 15:22:41 +02:00
< p > To create a calculator server on port 7337 (see the dc manual page for
2021-05-11 02:29:21 +02:00
quite how infuriating the underlying command is):< / p >
< div class = "example" >
2022-08-24 15:22:41 +02:00
< pre > < code class = "language-zsh" > tcp_proxy 7337 dc
2021-05-11 02:29:21 +02:00
< / code > < / pre >
< / div >
2022-08-24 15:22:41 +02:00
< p > To connect to this from the same host with a session also named ‘ ’ < / p >
2021-05-11 02:29:21 +02:00
< div class = "example" >
2022-08-24 15:22:41 +02:00
< pre > < code class = "language-zsh" > tcp_open localhost 7337 dc
2021-05-11 02:29:21 +02:00
< / code > < / pre >
< / div >
< p > To send a command to the remote session and wait a short while for
2022-08-24 15:22:41 +02:00
output (assuming dc is the current session):< / p >
2021-05-11 02:29:21 +02:00
< div class = "example" >
2022-08-24 15:22:41 +02:00
< pre > < code class = "language-zsh" > tcp_command 2 4 + p
2021-05-11 02:29:21 +02:00
< / code > < / pre >
< / div >
< p > To close the session:< / p >
< div class = "example" >
2022-08-24 15:22:41 +02:00
< pre > < code class = "language-zsh" > tcp_close
2021-05-11 02:29:21 +02:00
< / code > < / pre >
< / div >
2022-08-24 15:22:41 +02:00
< p > The tcp_proxy needs to be killed to be stopped. Note this will not
2021-05-11 02:29:21 +02:00
usually kill any connections which have already been accepted, and also
that the port is not immediately available for reuse.< / p >
< p > The following chunk of code puts a list of sessions into an xterm
header, with the current session followed by a star.< / p >
< div class = "example" >
2022-08-24 15:22:41 +02:00
< pre > < code class = "language-zsh" > print -n " \033]2;TCP:" ${(k)tcp_by_name:/$TCP_SESS/$TCP_SESS\*} " \a"
2021-05-11 02:29:21 +02:00
< / code > < / pre >
< / div >
< hr / >
< p > < span id = "TCP-Bugs" > < / span > < span id = "TCP-Bugs-1" > < / span > < / p >
< h2 id = "249-tcp-bugs" > < a class = "header" href = "#249-tcp-bugs" > 24.9 TCP Bugs< / a > < / h2 >
2022-08-24 15:22:41 +02:00
< p > The function tcp_read uses the shell’
2021-05-11 02:29:21 +02:00
reads a complete line at once, data arriving without a terminating
newline can cause the function to block indefinitely.< / p >
< p > Though the function suite works well for interactive use and for data
arriving in small amounts, the performance when large amounts of data
are being exchanged is likely to be extremely poor.< / p >
< hr / >
2022-08-24 15:22:41 +02:00
< p > This document was generated on < em > May 14, 2022< / em > using < a href = "http://www.nongnu.org/texi2html/" > < em > texi2html
5.0< / em > < / a > .< br / >
Zsh version 5.9, released on May 14, 2022.< / p >
2021-05-11 02:29:21 +02:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "Calendar-Function-System.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "Zftp-Function-System.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "Calendar-Function-System.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "Zftp-Function-System.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
2022-09-01 07:20:37 +02:00
<!-- Livereload script (if served using the cli tool) -->
< script type = "text/javascript" >
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};
window.onbeforeunload = function() {
socket.close();
}
< / script >
2021-05-11 02:29:21 +02:00
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
