changeset 3168:fdc657942606

Expand help messages after inspection of source code
author Neal Crook <foofoobedoo@gmail.com>
date Mon, 17 Apr 2017 21:29:07 +0100
parents 33f8afc79af2
children 1ff3d7673e36
files level1/sys/error.hp level1/sys/help.hp
diffstat 2 files changed, 11 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/level1/sys/error.hp	Sat Apr 08 20:26:29 2017 +0100
+++ b/level1/sys/error.hp	Mon Apr 17 21:29:07 2017 +0100
@@ -1,3 +1,5 @@
 @ERROR
 Syntax: Error <errno> [<errno> [...]]
-Usage : Outputs text error messages for given error numbers
+Usage : Outputs text error message(s) for given error number(s)
+
+The error messages are extracted from /DD/SYS/errmsg
--- a/level1/sys/help.hp	Sat Apr 08 20:26:29 2017 +0100
+++ b/level1/sys/help.hp	Mon Apr 17 21:29:07 2017 +0100
@@ -1,5 +1,10 @@
 @HELP
-Syntax: Help [<subject>] [<opts>]
-Usage : Give on-line help to users
+Syntax: Help [<subject>]
+Usage : Give on-line help on subject
         will prompt if no subjects given
-Opts  :
+
+The help text is extracted from the file /DD/SYS/helpmsg
+
+Entries in helpmsg are in plain text. An entry for subject FOO
+starts with a line containing the text "@FOO". helpmsg is
+typically created by concatenating a set of per-subject .hp files.