document prompt in shell script mode, fix man formatting, legacy awk

Documented unexpected behavior when calc is running in
"shell script mode" and the prompt builtin function is used
without the -p flag.  Updated help/prompt, help/unexpected
and the calc man page accordingly.

Unless calc is given the -p command line option, calc will reopen
stdin as /dev/null instead of just closing stdin.  This prevents
subsequent opens grabbing the 1st file descriptor.

Disable regress tests 4709, 4710, and 7763 because they print
multi-byte sequences, which are just fine for calc, the awk
used to evaluate the regression suite output in some legacy
systems report a "multibyte conversion failure".

Added a number of missing Makefile variables to the "make env" rule.

The man command is used to format the calc.1 man page into calc.usage.

The "help calc" command now prints the formatted calc man page (calc.usage).
The "help man" command now prints the formatted calc man page (calc.usage).
The "help usage" command now prints the formatted calc man page (calc.usage).

The file, calc.cat1, is formed by gzipping the calc.usage
formatted man page.  The calc.cat1 is installed as the calc
cat section 1 man page.

Updated the Copyright string in version.c to refer to
the COPYING file and the "help copying" command.

Added calc.cat1 to .gitignore.  Using "sort -d -u" to sort .gitignore content.

Avoiding use of modern [[ and ]] in Makefile for those legacy systems
whose shell do not support them.  *sigh*

Fixed the order of "help full" to match the order of topics listed
buy the "help help" command.

Sorted the halias[] help topics table in help.c using sort -d -u.
This commit is contained in:
Landon Curt Noll
2023-12-19 00:40:10 -08:00
parent d91e966f19
commit 54dd89dcf7
13 changed files with 372 additions and 205 deletions

View File

@@ -10,10 +10,43 @@ TYPES
return string
DESCRIPTION
When prompt(str) is called and input is from a terminal, the string
str is displayed and execution is halted until a newline ends a line
read from the input; the string formed by the characters in the line
(other than the newline) is returned as the value of prompt().
When prompt(str) is called and input is from a terminal, the string
str is displayed and execution is halted until a newline ends a line
read from the input; the string formed by the characters in the line
(other than the newline) is returned as the value of prompt().
Be careful when using prompt(str) while calc is being used as a
shell script. Unless calc is run with the -p command line option,
the prompt builtin will fail and return null. This is because when
calc is running as a shell script, calc will close stdin run in in
a non-interactive mode.
The following shell script will always print "got null" because
stdin will be closed by calc during startup:
#!/usr/bin/calc -q -f
# The prompt will ALWAYS FAIL and return a null value
n = prompt("Test> ");
if (isnull(n)) {
print("got null");
} else {
print("got " + n);
}
However the following shell script (note the -p before the -f in
the 1st line) will be interactive, prompt with "Test> " and print
the "got" result as expected:
#!/usr/bin/calc -q -p -f
n = prompt("Test> ");
if (isnull(n)) {
print("got null");
} else {
print("got " + n);
}
EXAMPLE
; x = prompt("? ");
@@ -35,9 +68,9 @@ LINK LIBRARY
none
SEE ALSO
fgetfield, fgetline, fgetstr
command, fgetfield, fgetline, fgetstr, unexpected
## Copyright (C) 1999-2006 Landon Curt Noll
## Copyright (C) 1999,2023 Landon Curt Noll
##
## Calc is open software; you can redistribute it and/or modify it under
## the terms of the version 2.1 of the GNU Lesser General Public License