From e2cc54741163d527e147fd6869d0fb71398cf5cd Mon Sep 17 00:00:00 2001 From: Tanaka Akira Date: Thu, 20 Jan 2000 18:44:54 +0000 Subject: Initial revision --- Doc/Zsh/mod_zpty.yo | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 Doc/Zsh/mod_zpty.yo (limited to 'Doc') diff --git a/Doc/Zsh/mod_zpty.yo b/Doc/Zsh/mod_zpty.yo new file mode 100644 index 000000000..6e07d36f0 --- /dev/null +++ b/Doc/Zsh/mod_zpty.yo @@ -0,0 +1,40 @@ +COMMENT(!MOD!zsh/zpty +A builtin for starting a command in a pseudo-terminal. +!MOD!) +The tt(zsh/zpty) module offers one builtin: + +startitem() +findex(zpty) +xitem(tt(zpty) [ tt(-e) ] [ tt(-b) ] var(name) var(command) [ var(args ...) ]) +xitem(tt(zpty) tt(-d) [ var(names) ... ]) +xitem(tt(zpty) tt(-w) [ tt(-n) ] var(name) var(strings ...)) +xitem(tt(zpty) tt(-r) var(name) [ var(param) [ var(pattern) ] ]) +item(tt(zpty) [ tt(-L) ])( +In the first form, the var(command) is started with the var(args) as +arguments. After this, the var(name) can be used in further calls to +tt(zpty) to refer to this command. With the tt(-e) option given, the +pseudo-terminal will be set up so that input characters are echoed and +with the tt(-b) option given, input and output from and to the +pseudo-terminal will be blocking. + +The second form with the tt(-d) option is used to delete commands +started before by giving their var(names). If no var(names) are given, +all commands are deleted. Deleting a command makes the HUP signal be +sent to the process started for it. + +The tt(-w) option can be used to sent the command var(name) the given +var(strings) as input (separated by spaces). If the tt(-n) option is +not given, a newline will be sent after the last var(string). + +The tt(-r) option can be used to read the output of the command +var(name). Without a var(param) argument, the string read will be +printed to standard output. With a var(param) argument, the string +read will be put in the parameter named var(param). If the +var(pattern) is also given, output will be read until the whole string +read matches the var(pattern). + +The last form without any arguments is used to list the commands +currently defined. If the tt(-L) option is given, this is done in the +form of calls to the tt(zpty) builtin. +) +enditem() -- cgit 1.4.1