receive(n) [mojave man page]

term::receive(n)						 Terminal control						  term::receive(n)

__________________________________________________________________________________________________________________________________________________

NAME

       term::receive - General input from terminals

SYNOPSIS

       package require Tcl  8.4

       package require term::receive  ?0.1?

       ::term::receive::getch ?chan?

       ::term::receive::listen cmd ?chan?

       cmd process string

       cmd eof

       ::term::receive::unlisten ?chan?

_________________________________________________________________

DESCRIPTION

       This  package  provides	the most primitive commands for receiving characters to a terminal. They are in essence convenient wrappers around
       the builtin commands read and fileevent.

       ::term::receive::getch ?chan?
	      This command reads a single character from the channel with handle chan and returns it as the result of the command.

	      If not specified chan defaults to stdin.

	      It is the responsibility of the caller to make sure that the channel can provide single characters. On unix this can  be	done,  for
	      example, by using the command of package term::ansi::ctrl::unix.

       ::term::receive::listen cmd ?chan?
	      This  command  sets  up  a filevent listener for the channel with handle chan and invokes the command prefix cmd whenever characters
	      have been received, or EOF was reached.

	      If not specified chan defaults to stdin.

	      The signature of the command prefix is

	      cmd process string
		     This method is invoked when characters were received, and string holds them for processing.

	      cmd eof
		     This method is invoked when EOF was reached on the channel we listen on.  It will be the last call  to  be  received  by  the
		     callback.

       ::term::receive::unlisten ?chan?
	      This command disables the filevent listener for the channel with handle chan.

	      If not specified chan defaults to stdin.

BUGS, IDEAS, FEEDBACK
       This  document, and the package it describes, will undoubtedly contain bugs and other problems.	Please report such in the category term of
       the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883].  Please also report any ideas for enhancements you  may  have  for
       either package and/or documentation.

KEYWORDS

       character input, control, get character, listener, receiver, terminal

CATEGORY

       Terminal control

COPYRIGHT

       Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>

term									0.1							  term::receive(n)

term::ansi::ctrl::unix(n)					 Terminal control					 term::ansi::ctrl::unix(n)

__________________________________________________________________________________________________________________________________________________

NAME

       term::ansi::ctrl::unix - Control operations and queries

SYNOPSIS

       package require Tcl  8.4

       package require term::ansi::ctrl::unix  ?0.1?

       ::term::ansi::ctrl::unix::import ?ns? ?arg...?

       ::term::ansi::ctrl::unix::raw

       ::term::ansi::ctrl::unix::raw

       ::term::ansi::ctrl::unix::columns

       ::term::ansi::ctrl::unix::rows

_________________________________________________________________

DESCRIPTION

       WARNING:  This  package	is  unix-specific  and depends on the availability of two unix system commands for terminal control, i.e. stty and
       tput, both of which have to be found in the $PATH. If any of these two commands is missing the loading of the package will fail.

       The package provides commands to switch the standard input of the current process between raw and cooked input modes, and to query the size
       of terminals, i.e. the available number of columns and lines.

API

   INTROSPECTION
       ::term::ansi::ctrl::unix::import ?ns? ?arg...?
	      This  command imports some or all attribute commands into the namespace ns. This is by default the namespace ctrl. Note that this is
	      relative namespace name, placing the imported command into a child of the current namespace. By default all commands  are  imported,
	      this can howver be restricted by listing the names of the wanted commands after the namespace argument.

   OPERATIONS
       ::term::ansi::ctrl::unix::raw
	      This command switches the standard input of the current process to raw input mode. This means that from then on all characters typed
	      by the user are immediately reported to the application instead of waiting in the OS buffer until the Enter/Return key is received.

       ::term::ansi::ctrl::unix::raw
	      This command switches the standard input of the current process to cooked input mode. This means that from then  on  all	characters
	      typed by the user are kept in OS buffers for editing until the Enter/Return key is received.

       ::term::ansi::ctrl::unix::columns
	      This command queries the terminal connected to the standard input for the number of columns available for display.

       ::term::ansi::ctrl::unix::rows
	      This command queries the terminal connected to the standard input for the number of rows (aka lines) available for display.

BUGS, IDEAS, FEEDBACK
       This  document, and the package it describes, will undoubtedly contain bugs and other problems.	Please report such in the category term of
       the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883].  Please also report any ideas for enhancements you  may  have  for
       either package and/or documentation.

KEYWORDS

       ansi, columns, control, cooked, input mode, lines, raw, rows, terminal

CATEGORY

       Terminal control

COPYRIGHT

       Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>

term									0.1						 term::ansi::ctrl::unix(n)