diff options
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/Zsh/.distfiles | 2 | ||||
-rw-r--r-- | Doc/Zsh/builtins.yo | 1 | ||||
-rw-r--r-- | Doc/Zsh/mod_tcp.yo | 97 |
3 files changed, 99 insertions, 1 deletions
diff --git a/Doc/Zsh/.distfiles b/Doc/Zsh/.distfiles index 7d32c3599..5623166d5 100644 --- a/Doc/Zsh/.distfiles +++ b/Doc/Zsh/.distfiles @@ -6,7 +6,7 @@ DISTFILES_SRC=' mod_clone.yo mod_compctl.yo mod_complete.yo mod_complist.yo mod_computil.yo mod_deltochar.yo mod_example.yo mod_files.yo mod_mapfile.yo mod_mathfunc.yo mod_parameter.yo mod_pcre.yo mod_sched.yo - mod_stat.yo mod_termcap.yo mod_terminfo.yo mod_zftp.yo mod_zle.yo + mod_stat.yo mod_tcp.so mod_termcap.yo mod_terminfo.yo mod_zftp.yo mod_zle.yo mod_zleparameter.yo mod_zutil.yo mod_zprof.yo mod_zpty.yo modules.yo modlist.yo modmenu.yo manmodmenu.yo options.yo params.yo prompt.yo redirect.yo restricted.yo seealso.yo diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo index f2383d86d..fe4942e83 100644 --- a/Doc/Zsh/builtins.yo +++ b/Doc/Zsh/builtins.yo @@ -1675,4 +1675,5 @@ module(zprof)(zsh/zprof) module(zpty)(zsh/zpty) module(zregexparse)(zsh/zutil) module(zstyle)(zsh/zutil) +module(ztcp)(zsh/net/tcp) enditem() diff --git a/Doc/Zsh/mod_tcp.yo b/Doc/Zsh/mod_tcp.yo new file mode 100644 index 000000000..5cd3aa2d3 --- /dev/null +++ b/Doc/Zsh/mod_tcp.yo @@ -0,0 +1,97 @@ +COMMENT(!MOD!zsh/net/tcp +Manipulation of TCP sockets +!MOD!) +The tt(zsh/net/tcp) module makes available one builtin command: + +startitem() +findex(ztcp) +cindex(TCP) +cindex(sockets, TCP) +item(tt(ztcp) [ tt(-acdfltv) ] [ var(args) ])( +tt(ztcp) is implemented as a builtin to allow full use of shell +command line editing, file I/O, and job control mechanisms. + +If tt(ztcp) is run with no options, it will output +the contents of its session table. +) +enditem() + +subsect(Outbound Connections) +cindex(sockets, outbound TCP) + +startitem() +item(tt(ztcp) [ tt(-v) ] [ tt(-d) var(fd) ] var(host) [ var(port) ])( +Open a new TCP connection to var(host). If the var(port) is +omitted, it will default to port 23. The connection will +be added to the session table and the shell parameter +tt(REPLY) will be set to the file descriptor associated +with that connection. + +If tt(-d) is specified, the first non-option argument +will be taken as the target file descriptor for the +connection. + +In order to elicit more verbose output, use tt(-v). +) +enditem() + +subsect(Inbound Connections) +cindex(sockets, inbound TCP) + +startitem() +item(tt(ztcp) tt(-l) [ tt(-v) ] [ tt(-d) var(fd) ] var(port))( +tt(ztcp -l) will open a socket listening on TCP +var(port). The socket will be added to the +session table and the shell parameter tt(REPLY) +will be set to the file descriptor associated +with that listener. + +If tt(-d) is specified, the first non-option argument +will be taken as the target file descriptor for +the connection. + +In order to elicit more verbose output, use tt(-v). +) +item(tt(ztcp) tt(-a) [ tt(-tv) ] [ tt(-d) var(targetfd) ] var(listenfd))( +tt(ztcp -a) will accept an incoming connection +to the port associated with var(listenfd). +The connection will be added to the session +table and the shell parameter tt(REPLY) will +be set to the file descriptor associated with +the inbound connection. + +If tt(-d) is specified, the first non-option argument +will be taken as the target file descriptor for the +connection. + +If tt(-t) is specified, tt(ztcp) will return +if no incoming connection is pending. Otherwise +it will wait for one. + +In order to elicit more verbose output, use tt(-v). +) +enditem() + +subsect(Closing Connections) +cindex(sockets, closing TCP) + +startitem() +xitem(tt(ztcp) tt(-cf) [ tt(-v) ] [ var(fd) ]) +item(tt(ztcp) tt(-c) [ tt(-v) ] [ var(fd) ])( +tt(ztcp -c) will close the socket associated +with var(fd). The socket will be removed from the +session table. If var(fd) is not specified, +tt(ztcp) will close everything in the session table. + +Normally, sockets registered by zftp (see +ifzman(\ +zmanref(zshmodules) +)\ +ifnzman(\ +noderef(The zsh/zftp Module) +)) cannot be closed this way. In order +to force such a socket closed, use tt(-f). + +In order to elicit more verbose output, use tt(-v). +) +enditem() |