BSD 4_4 release

[unix-history] / usr / src / usr.bin / learn / learn / learn.1

diff --git a/usr/src/usr.bin/learn/learn/learn.1 b/usr/src/usr.bin/learn/learn/learn.1
index 36c140a..6165c28 100644 (file)
--- a/usr/src/usr.bin/learn/learn/learn.1
+++ b/usr/src/usr.bin/learn/learn/learn.1
@@ -1,104 +1,169 @@
-.\"    @(#)learn.1     5.1 (Berkeley) %G%
+.\" Copyright (c) 1990, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.TH LEARN 1 "26 April 1983"
-.AT 3
-.SH NAME
-learn \- computer aided instruction about UNIX
-.SH SYNOPSIS
-.B learn
-[
-.BR \- directory
-]
-[ subject [ lesson ] ]
-.SH DESCRIPTION
-.I Learn
+.\" This module is believed to contain source code proprietary to AT&T.
+.\" Use and redistribution is subject to the Berkeley Software License
+.\" Agreement and your Software Agreement with AT&T (Western Electric).
+.\"
+.\"    @(#)learn.1     8.1 (Berkeley) 6/6/93
+.\"
+.Dd June 6, 1993
+.Dt LEARN 1
+.Os ATT 7th
+.Sh NAME
+.Nm learn
+.Nd computer aided instruction about
+.Ux
+.Sh SYNOPSIS
+.Nm learn
+.Op Fl Ar directory
+.Op Ar subject Op Ar lesson
+.Sh DESCRIPTION
+.Nm Learn

 gives Computer Aided Instruction courses and
 gives Computer Aided Instruction courses and

-practice in the use of UNIX, the C Shell,
+practice in the use of
+.Tn UNIX ,
+the C Shell,

 and the Berkeley text editors.
 To get started simply type
 and the Berkeley text editors.
 To get started simply type

-.BR learn .
-The program will ask questions to find out what
-you want to do.
+.Nm learn  .
+If you had used
+.Nm learn
+before and left your last session without completing a subject,
+the program will use information in
+.Pa $HOME/.learnrc
+to start you up
+in the same place you left off.
+Your first time through,
+.Nm learn
+will ask questions to find out what you want to do.

 Some questions may be bypassed by naming a
 Some questions may be bypassed by naming a

-.IR subject ,
+.Ar subject  ,

 and more yet by naming a
 and more yet by naming a

-.IR lesson .
+.Ar lesson  .

 You may enter the
 You may enter the

-.I lesson
+.Ar lesson

 as a number that
 as a number that

-.I learn
+.Nm learn

 gave you in a previous session.
 If you do not know the lesson number,
 you may enter the
 gave you in a previous session.
 If you do not know the lesson number,
 you may enter the

-.I lesson
+.Ar lesson

 as a word, and
 as a word, and

-.I learn
+.Nm learn

 will look for the first lesson containing it.
 If the
 will look for the first lesson containing it.
 If the

-.I lesson
-is `\fB\-\fP',
-.I learn
+.Ar lesson
+is
+.Sq Fl ,
+.Nm learn

 prompts for each lesson;
 this is useful for debugging.
 prompts for each lesson;
 this is useful for debugging.

-.PP
+.Pp

 The
 The

-.IR subject \|'s
+.Ar subject 's

 presently handled are
 presently handled are

-.if n .sp 1v
-.if t .sp .5v
-.nf
-           files
-           editor
-           vi
-           morefiles
-           macros
-           eqn
-           C
-.fi
-.PP
+.Bd -unfilled -offset indent
+files
+editor
+vi
+morefiles
+macros
+eqn
+C
+.Ed
+.Pp

 There are a few special commands.
 There are a few special commands.

-The command `bye' terminates a 
-.I learn
-session and `where' tells you of your progress,
-with `where\0m' telling you more.
-The command `again' re-displays the text of the lesson
-and `again\0\fIlesson\fP' lets you review
-.IR lesson .
-.PP
+The command
+.Ql bye
+terminates a
+.Nm learn
+session and
+.Ql where
+tells you of your progress,
+with
+.Ql where m
+telling you more.
+The command
+.Ql again
+re-displays the text of the lesson
+and
+.Ql again Ar lesson
+lets you review
+.Ar lesson  .
+There is no way for
+.Nm learn
+to tell you the answers it expects in English, however,
+the command
+.Ql hint
+prints the last part of the lesson script
+used to evaluate a response, while
+.Ql hint m
+prints the
+whole lesson script.
+This is useful for debugging
+lessons and might possibly give you an idea about what it expects.
+.Pp
+Normally, lesson scripts are found in the directory
+.Pa /usr/libata/learn.

 The
 The

-.BI \- directory
-option allows one to exercise a script in
-a nonstandard place.
-.SH FILES
-.nf
-/usr/lib/learn subtree for all dependent directories and files
-/usr/tmp/pl\(**        playpen directories
-.SH SEE ALSO
-csh(1), ex(1)
-.SH BUGS
+.Fl  directory
+option allows one to specify a nonstandard place to look for scripts.
+.Sh FILES
+.Bl -tag -width /usr/libdata/learn -compact
+.It Pa /usr/lib/learn
+Subtree for all dependent directories and files.
+.It Pa /usr/tmp/pl\(**
+Playpen directories.
+.It $HOME/.learnrc
+Startup information.
+.El
+.Sh SEE ALSO
+.Xr csh 1 ,
+.Xr ex 1
+.Rs
+.%A B. W. Kernighan
+.%A M. E. Lesk
+.%T "LEARN \- Computer-Aided Instruction on UNIX"
+.Re
+.Sh BUGS

 The main strength of
 The main strength of

-.I learn,
-that it asks the student to use the real UNIX,
+.Nm learn ,
+that it asks the student to use the real
+.Ux ,

 also makes possible baffling mistakes.
 It is helpful, especially for nonprogrammers,
 also makes possible baffling mistakes.
 It is helpful, especially for nonprogrammers,

-to have a UNIX initiate near at hand during the first
+to have a
+.Ux
+initiate near at hand during the first

 sessions.
 sessions.

-.PP
+.Pp

 Occasionally lessons are incorrect, sometimes because the local version
 of a command operates in a non-standard way.
 Occasionally lessons are incorrect, sometimes because the local version
 of a command operates in a non-standard way.

+Occasionally a lesson script does not recognize all the different
+correct responses, in which case the `hint' command may be useful.

 Such lessons may be skipped with the `skip' command,
 Such lessons may be skipped with the `skip' command,

-but it takes some sophistication to recognize
-the situation.
-.PP
+but it takes some sophistication to recognize the situation.
+.Pp

 To find a
 To find a

-.I lesson
+.Ar lesson

 given as a word,
 given as a word,

-.I learn
+.Nm learn

 does a simple
 does a simple

-.IR fgrep (1)
+.Xr fgrep  1

 through the lessons.
 It is unclear whether this sort
 of subject indexing is better than none.
 through the lessons.
 It is unclear whether this sort
 of subject indexing is better than none.

-.PP
+.Pp

 Spawning a new shell is required for each of many
 user and internal functions.
 Spawning a new shell is required for each of many
 user and internal functions.

+.Pp
+The
+.Xr \&vi
+lessons are provided separately from the others.
+To use them see your system administrator.
+.Sh HISTORY
+The
+.Nm learn
+command appeared in
+.At 32v .