1[comment {-*- tcl -*- doctools manpage}] 2[manpage_begin term::ansi::ctrl::unix n 0.1] 3[copyright {2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>}] 4[moddesc {Terminal control}] 5[titledesc {Control operations and queries}] 6[category {Terminal control}] 7[require Tcl 8.4] 8[require term::ansi::ctrl::unix [opt 0.1]] 9[description] 10 11[emph {WARNING}]: This package is unix-specific and depends on the 12availability of two unix system commands for terminal control, 13i.e. [syscmd stty] and [syscmd tput], both of which have to be found 14in the [var {$PATH}]. If any of these two commands is missing the 15loading of the package will fail. 16 17[para] 18 19The package provides commands to switch the standard input of the 20current process between [term raw] and [term cooked] input modes, and 21to query the size of terminals, i.e. the available number of columns 22and lines. 23 24[section API] 25[subsection Introspection] 26 27[list_begin definitions] 28[call [cmd ::term::ansi::ctrl::unix::import] [opt [arg ns]] [opt [arg arg]...]] 29 30This command imports some or all attribute commands into the namespace 31[arg ns]. This is by default the namespace [emph ctrl]. Note that this 32is relative namespace name, placing the imported command into a child 33of the current namespace. By default all commands are imported, this 34can howver be restricted by listing the names of the wanted commands 35after the namespace argument. 36 37[list_end] 38 39[subsection Operations] 40[list_begin definitions] 41 42[call [cmd ::term::ansi::ctrl::unix::raw]] 43 44This command switches the standard input of the current process to 45[term raw] input mode. This means that from then on all characters 46typed by the user are immediately reported to the application instead 47of waiting in the OS buffer until the Enter/Return key is received. 48 49[call [cmd ::term::ansi::ctrl::unix::raw]] 50 51This command switches the standard input of the current process to 52[term cooked] input mode. This means that from then on all characters 53typed by the user are kept in OS buffers for editing until the 54Enter/Return key is received. 55 56[call [cmd ::term::ansi::ctrl::unix::columns]] 57 58This command queries the terminal connected to the standard input for 59the number of columns available for display. 60 61[call [cmd ::term::ansi::ctrl::unix::rows]] 62 63This command queries the terminal connected to the standard input for 64the number of rows (aka lines) available for display. 65 66[list_end] 67[section {BUGS, IDEAS, FEEDBACK}] 68 69This document, and the package it describes, will undoubtedly contain 70bugs and other problems. 71 72Please report such in the category [emph term] of the 73[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}]. 74 75Please also report any ideas for enhancements you may have for either 76package and/or documentation. 77 78 79[keywords ansi terminal control raw cooked] 80[keywords {input mode} lines rows columns] 81[manpage_end] 82