From: Kirk McKusick <mckusick@ucbvax.Berkeley.EDU>
Date: Thu, 24 Apr 1986 14:49:37 +0000 (-0800)
Subject: document distributed with 4.1BSD
X-Git-Tag: BSD-4_3-Snapshot-Development~2629
X-Git-Url: https://git.subgeniuskitty.com/unix-history/.git/commitdiff_plain/66e2adb545fc9c80f97cc212a081f170ed42e927

document distributed with 4.1BSD

SCCS-vsn: lib/libcurses/PSD.doc/intro.2 4.1
---

diff --git a/usr/src/lib/libcurses/PSD.doc/intro.2 b/usr/src/lib/libcurses/PSD.doc/intro.2
new file mode 100644
index 0000000000..e68d17db18
--- /dev/null
+++ b/usr/src/lib/libcurses/PSD.doc/intro.2
@@ -0,0 +1,63 @@
+.\" Copyright (c) 1980 Regents of the University of California.
+.\" All rights reserved.  The Berkeley software License Agreement
+.\" specifies the terms and conditions for redistribution.
+.\"
+.\"	@(#)intro.2	4.1 (Berkeley) %G%
+.\"
+.sh 1 Variables
+.pp
+Many variables which are used to describe the terminal environment
+are available to the programmer. They are:
+.TS
+expand;
+lw(6m) lw(8n) lw(50n).
+type	name	description
+_
+WINDOW *	curscr	T{
+.fi
+current version of the screen (terminal screen).
+T}
+WINDOW *	stdscr	T{
+standard screen.  Most updates are usually done here.
+T}
+char *	Def\*_term	T{
+default terminal type if type cannot be determined
+T}
+bool	My\*_term	T{
+use the terminal specification in \fIDef\*_term\fR as terminal,
+irrelevant of real terminal type
+T}
+char *	ttytype	T{
+full name of the current terminal.
+T}
+int	LINES	T{
+number of lines on the terminal
+T}
+int	COLS	T{
+number of columns on the terminal
+T}
+int	ERR	T{
+error flag returned by routines on a fail.
+T}
+int	OK	T{
+error flag returned by routines when things go right.
+T}
+.TE
+.pp
+There are also several
+.q #define
+constants and types
+which are of general usefulness:
+.sp
+.ev 1
+.ta 11n
+.(b L
+.nf
+reg	storage class ``register'' (e.g., \fIreg int i;\fR\|)
+bool	boolean type, actually a ``char'' (e.g., \fIbool doneit;\fR\|)
+TRUE	boolean ``true'' flag (1).
+FALSE	boolean ``false'' flag (0).
+.fi
+.ev
+.)b
+.lp