1term::ansi::ctrl::unix(n)      Terminal control      term::ansi::ctrl::unix(n)
2
3
4
5______________________________________________________________________________
6

NAME

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

SYNOPSIS

11       package require Tcl  8.4
12
13       package require term::ansi::ctrl::unix  ?0.1.1?
14
15       ::term::ansi::ctrl::unix::import ?ns? ?arg...?
16
17       ::term::ansi::ctrl::unix::raw
18
19       ::term::ansi::ctrl::unix::cooked
20
21       ::term::ansi::ctrl::unix::columns
22
23       ::term::ansi::ctrl::unix::rows
24
25______________________________________________________________________________
26

DESCRIPTION

28       WARNING:  This package is unix-specific and depends on the availability
29       of two unix system commands for terminal control, i.e. stty  and  tput,
30       both  of  which have to be found in the $PATH. If any of these two com‐
31       mands is missing the loading of the package will fail.
32
33       The package provides commands to switch the standard input of the  cur‐
34       rent  process between raw and cooked input modes, and to query the size
35       of terminals, i.e. the available number of columns and lines.
36

API

38   INTROSPECTION
39       ::term::ansi::ctrl::unix::import ?ns? ?arg...?
40              This command imports some or all  attribute  commands  into  the
41              namespace  ns.  This is by default the namespace ctrl. Note that
42              this is relative namespace name, placing  the  imported  command
43              into  a  child of the current namespace. By default all commands
44              are imported, this can howver be restricted by listing the names
45              of the wanted commands after the namespace argument.
46
47   OPERATIONS
48       ::term::ansi::ctrl::unix::raw
49              This  command switches the standard input of the current process
50              to raw input mode. This means that from then on  all  characters
51              typed  by  the  user are immediately reported to the application
52              instead of waiting in the OS buffer until the  Enter/Return  key
53              is received.
54
55       ::term::ansi::ctrl::unix::cooked
56              This  command switches the standard input of the current process
57              to cooked input mode. This means that from then on  all  charac‐
58              ters  typed by the user are kept in OS buffers for editing until
59              the Enter/Return key is received.
60
61       ::term::ansi::ctrl::unix::columns
62              This command queries the  terminal  connected  to  the  standard
63              input for the number of columns available for display.
64
65       ::term::ansi::ctrl::unix::rows
66              This  command  queries  the  terminal  connected to the standard
67              input for the number of rows (aka lines) available for display.
68

BUGS, IDEAS, FEEDBACK

70       This document, and the package it describes, will  undoubtedly  contain
71       bugs  and  other  problems.  Please report such in the category term of
72       the  Tcllib  Trackers  [http://core.tcl.tk/tcllib/reportlist].   Please
73       also  report any ideas for enhancements you may have for either package
74       and/or documentation.
75
76       When proposing code changes, please provide unified diffs, i.e the out‐
77       put of diff -u.
78
79       Note  further  that  attachments  are  strongly  preferred over inlined
80       patches. Attachments can be made by going  to  the  Edit  form  of  the
81       ticket  immediately  after  its  creation, and then using the left-most
82       button in the secondary navigation bar.
83

KEYWORDS

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

CATEGORY

88       Terminal control
89

91       Copyright (c) 2006-2011 Andreas Kupries <andreas_kupries@users.sourceforge.net>
92
93
94
95
96tcllib                               0.1.1           term::ansi::ctrl::unix(n)
Impressum