changed for new commands and command line flags.

SCCS-vsn: usr.bin/window/window.1 3.2

diff --git a/usr/src/usr.bin/window/window.1 b/usr/src/usr.bin/window/window.1
index c84f194..d6ce5d9 100644 (file)
--- a/usr/src/usr.bin/window/window.1
+++ b/usr/src/usr.bin/window/window.1
@@ -1,34 +1,75 @@
-.\" @(#)window.1       3.1 83/08/09
+.\" @(#)window.1       3.2 83/08/22

 .TH WINDOW 1 local
 .SH NAME
 window \- multiple window shell
 .SH SYNOPSIS
 .TH WINDOW 1 local
 .SH NAME
 window \- multiple window shell
 .SH SYNOPSIS

-window
+.B window
+[
+.B \-t
+] [
+.B \-f
+] [
+.B \-d
+] [
+.B -e escape-char
+]

 .SH DESCRIPTION
 \fIWindow\fP provides a window oriented working environment
 on ordinary CRT terminals.
 .PP
 Windows are rectangular partitions on the physical terminal screen
 that are indistinguishable from real terminals to processes running in
 .SH DESCRIPTION
 \fIWindow\fP provides a window oriented working environment
 on ordinary CRT terminals.
 .PP
 Windows are rectangular partitions on the physical terminal screen
 that are indistinguishable from real terminals to processes running in

-them.  Their sizes and placement are determined at creation
+them.  Their sizes are determined at creation

 time.  They are framed as necessary to mark the boundaries between
 windows.  Each window, like terminals, has a cursor and a set of
 control functions.  Most intelligent terminal functions such as line and
 time.  They are framed as necessary to mark the boundaries between
 windows.  Each window, like terminals, has a cursor and a set of
 control functions.  Most intelligent terminal functions such as line and

-character deletion and insertion are supported.  A \fItermcap (5)\fP
-entry tailored to each window is passed on to its processes
-in the environment (see \fIenviron (8)\fP).  A pseudo-terminal
-device (\fIpty (4)\fP) is allocated for each window.  This becomes
-the standard input, output, and diagnostic output of the processes.
-Initially a shell, usually \fIcsh (1)\fP, is placed in the window.
+character deletion and insertion are supported.  Display modes
+such as underlining and reverse video are supported if the terminal
+allows them.

 .PP
 Windows are labeled with the digits ``1'' through ``9'',
 .PP
 Windows are labeled with the digits ``1'' through ``9'',

-thus a maximum of nine windows are supported.
+thus a maximum of nine windows can exist at the same time.

 One window, the current window, is treated specially.
 One window, the current window, is treated specially.

-This window is indicated by displaying its label in reverse video.
+This window is indicated by displaying its labels in reverse video.

 .PP
 Windows can overlap.  Some can be completely obscured by others.
 The current window is always on top of all others.
 .PP
 .PP
 Windows can overlap.  Some can be completely obscured by others.
 The current window is always on top of all others.
 .PP

+With each newly created window, a shell program is spawned with its
+process environment tailored to that window.  In particular,
+a pseudo-terminal device (\fIpty (4)\fP) is allocated, and becomes
+the standard input, output and diagnostic output of the shell.  It's
+special characters and modes (see \fIstty (1)\fP) are copied from
+the user's real terminal.  Also,
+a \fItermcap (5)\fP entry for this window is created
+and passed to the shell as \fIenviron (8)\fP
+variable \fBTERMCAP\fP.  This \fItermcap\fP entry contains the window's
+size and characteristics as well as information about
+the real terminal, such as the existence of underline, reverse
+video and other display modes, and the codes produced by the terminal's
+keypad (if any).
+.PP
+When \fIwindow\fP starts up, the file \fI.windowrc\fP in the
+user's home directory is checked.  If it exists, then the
+commands contained in it are executed (see \fIsource\fP command below).
+If \fI.windowrc\fP does not exist, then two
+equal sized windows are created by default.
+.PP
+The command line arguments are
+.TP
+.B -t
+Turn on terse mode (see \fIterse\fP command below).
+.TP
+.B -f
+Don't perform any startup action.
+.TP
+.B -d
+Ignore \fI.windowrc\fP and create the two default
+windows instead.
+.TP
+.B -e escape-char
+Set the escape character to \fIescape-char\fP.
+.PP

 The \fIwindow\fP program has two functional modes:  command mode
 and conversation mode.
 In conversation mode, the terminal's
 The \fIwindow\fP program has two functional modes:  command mode
 and conversation mode.
 In conversation mode, the terminal's


@@ -39,10 +80,7 @@ even in command mode.
 Typing \fIwindow\fP's escape character (normally ^P)
 in conversation mode switches \fIwindow\fP into
 command mode.  In command mode, the top line of the
 Typing \fIwindow\fP's escape character (normally ^P)
 in conversation mode switches \fIwindow\fP into
 command mode.  In command mode, the top line of the

-terminal screen becomes the command prompt window,
-and the cursor in the current window is replaced by a
-blinking reverse video block (if these functions are supported
-by the terminal).
+terminal screen becomes the command prompt window.

 .PP
 There are two types of commands.  Short commands are
 usually one or two key strokes.  Long commands are entered
 .PP
 There are two types of commands.  Short commands are
 usually one or two key strokes.  Long commands are entered


@@ -81,6 +119,9 @@ character takes the place of ^P here.
 .B q
 Exit \fIwindow\fP.  Confirmation is requested.
 .TP
 .B q
 Exit \fIwindow\fP.  Confirmation is requested.
 .TP

+.B ^Z
+Suspend \fIwindow\fP.
+.TP

 .B w
 Create a new window.  You are prompted for the positions
 of the upper left and lower right corners of the window.
 .B w
 Create a new window.  You are prompted for the positions
 of the upper left and lower right corners of the window.


@@ -88,21 +129,18 @@ The cursor is placed on the screen and the keys ``h'', ``j'',
 ``k'', and ``l''
 move the cursor left, down, up, and right, respectively.
 The keys ``H'', ``J'', ``K'', and ``L'' move the cursor to the respective
 ``k'', and ``l''
 move the cursor left, down, up, and right, respectively.
 The keys ``H'', ``J'', ``K'', and ``L'' move the cursor to the respective

-limits of the screen.  Number before the movement keys
+limits of the screen.  Typing a number before the movement keys

 repeats the movement that number of times.
 Return enters the cursor position
 as the upper left corner of the window.  The lower right corner
 is entered in the same manner.  Typing escape (or ^[) at any
 point cancels this command.
 .IP
 repeats the movement that number of times.
 Return enters the cursor position
 as the upper left corner of the window.  The lower right corner
 is entered in the same manner.  Typing escape (or ^[) at any
 point cancels this command.
 .IP

-The environment variable SHELL is checked to find the
-name of the shell program to place in the window.
-\fICsh\fP (1) is used by default.
-.IP
-This window is given the first available label.
+This window becomes the current window,
+and is given the first available label.

 .TP
 .B c[1-9]
 .TP
 .B c[1-9]

-Close the window \fI[1-9]\fP.  The process in the window is sent
+Close window \fI[1-9]\fP.  The process in the window is sent

 the hangup signal (see \fIkill (1)\fP).  \fICsh (1)\fP should
 handle this signal correctly and cause no problems.
 .TP
 the hangup signal (see \fIkill (1)\fP).  \fICsh (1)\fP should
 handle this signal correctly and cause no problems.
 .TP


@@ -117,6 +155,16 @@ Return will display the next one.  This command is useful
 when there are a large number of windows and some are completely
 hidden by others.
 .TP
 when there are a large number of windows and some are completely
 hidden by others.
 .TP

+.B L
+List all windows.  A special window is opened and all user windows are
+listed in it with their labels.
+.TP
+.B ^Y
+Scroll the current window up by one line.
+.TP
+.B ^E
+Scroll the current window down by one line.
+.TP

 .B ^U
 Scroll the current window up by half the window size.
 .TP
 .B ^U
 Scroll the current window up by half the window size.
 .TP


@@ -159,21 +207,22 @@ Open a window with upper left corner at \fIrow\fP, \fIcol\fP
 and size \fInrow\fP, \fIncol\fP.
 .TP
 .B label [1-9] string
 and size \fInrow\fP, \fIncol\fP.
 .TP
 .B label [1-9] string

-Label the window \fI[1-9]\fP with \fIstring\fP.  This is in addition
+Label window \fI[1-9]\fP with \fIstring\fP.  This is in addition

 to the numeric label that is always displayed.
 .TP
 .B %[1-9]
 Make window \fI[1-9]\fP the current window.
 .TP
 to the numeric label that is always displayed.
 .TP
 .B %[1-9]
 Make window \fI[1-9]\fP the current window.
 .TP

+.B write [1-9] string
+Write \fIstring\fP to window \fI[1-9]\fP.
+.TP
+.B close [1-9] ...
+Close window \fI[1-9]\fP.  More than one window can be specified.
+If no window is given, then all windows are closed.
+.TP

 .B source file
 Read and execute the long commands in \fIfile\fP.  Recursive
 \fIsource\fP is not allowed.
 .B source file
 Read and execute the long commands in \fIfile\fP.  Recursive
 \fIsource\fP is not allowed.

-.PP
-When \fIwindow\fP starts up, the file \fI.windowrc\fP in the
-user's home directory is checked.  If it exists, then the
-commands contained in it are executed (using \fIsource\fP).
-If \fI.windowrc\fP does not exist, then two
-equal sized windows are created by default.

 .SH FILES
 .ta 15
 ~/.windowrc    startup command file.
 .SH FILES
 .ta 15
 ~/.windowrc    startup command file.