\This directory, and its subdirectories contain the source code
for ksh-93; the language described in the second edition of
the book, "The KornShell Command and Programming Language," by
Morris Bolsky and David Korn which is published by Prentice Hall.
ksh-93 has been compiled and run on several machines with several
operating systems.  The end of this file contains a partial list of
operating systems and machines that ksh-93 has been known to run on.

Most of the source code for ksh is in the src/cmd/ksh93/sh
directory. For information on what's where, see the file DESIGN.

#### COMPILE-TIME OPTIONS ####

The SHOPT.sh file contains several compilation options that can be set
before compiling ksh.  Options are of the form SHOPT_option and become
#define inside the code.  These options are set to their recommended
value and some of these may disappear as options in future releases.
A value of 0 represents off, 1 represents on, no value means probe. For
options where no feature probe is available, probe is the same as off.

The options have the following defaults and meanings:

    ACCT         off Shell accounting.
                     Noted by "L" in the version string when enabled.
                     See README-AUDIT.md.

    ACCTFILE     off Enable per user accounting info.
                     See README-AUDIT.md.

    ALL_LIBCMD   off Enables all of the available /opt/ast/bin builtin commands
                     in src/lib/libcmd (excludes vmstate if vmalloc is not
                     enabled).

    AUDIT        on  For auditing specific users.
                     Noted by "A" in the version string when enabled.
                     See README-AUDIT.md.

    AUDITFILE    "/etc/ksh_audit"
                     See README-AUDIT.md.

    BGX          on  Enables background job extensions. Noted by "J" in the
                     version string when enabled. (1) JOBMAX=n limits the
                     number of concurrent background jobs to n; the (n+1)th
                     background job will block until a running background job
                     completes. (2) SIGCHLD traps are queued so that each
                     completing background job gets its own trap; $! is set to
                     the job PID and $? is set to the job exit status at the
                     beginning of the trap.

    BRACEPAT     on  Brace expansion. Expands abc{d,e}f to abcdf abcef.
                     This feature was inspired by the C shell.

    CMDLIB_HDR   "<cmdlist.h>"
                     The header in which you can provide a custom list of
                     libcmd commands to provide as path-bound built-ins.

    CMDLIB_DIR   "\"/opt/ast/bin\""
                     The default virtual directory prefix for path-bound
                     built-ins. The value must include double quotes.

    CRNL         off <cr><nl> treated as <nl> in shell grammar.

    DEVFD            Use the more secure /dev/fd mechanism instead of FIFOs for
                     process substitutions. On by default on OSs with /dev/fd.

    DYNAMIC      off Dynamic loading of builtins. Requires dlopen() interface
                     and dynamic libshell, libdll and libast libraries.

    ECHOPRINT    off Make echo equivalent to print.

    EDPREDICT    off Enables history pattern search menu. As you begin a line
                     with a #, the following characters are treated as a shell
                     pattern and cause matching lines from the history file to
                     be displayed as a numbered list as you type. You can
                     scroll up and down this list or you can use <ESC>nTAB to
                     make this the current line (n defaults to 1 if omitted).
                     Experimental. Bugs: https://github.com/ksh93/ksh/issues/233

    ESH          on  Compile with emacs command line editing.  The original
                     emacs line editor code was provided by Mike Veach at IH.

    FILESCAN     on  Allows fast reading of files using:
                         while < file; do ...; done
                     Each line is stored in $REPLY and fields in each
                     line can be accessed as positional parameters.

    FIXEDARRAY   on  When using typeset, a name in the format NAME[N]
                     creates a fixed-size array and any attempt to access a
                     subscript N or higher is an error. Multidimensional
                     fixed-size arrays NAME[N1][N2]... are also supported.

    GLOBCASEDET      Adds the 'globcasedetect' shell option. When this shell
                     option is turned on, pathname expansion (globbing)
                     and file name listing and completion automatically become
                     case-insensitive on file systems where the difference
                     between upper- and lowercase is ignored for file names.
                     This compile-time option is enabled by default on operating
                     systems that can support case-insensitive file systems.

    HISTEXPAND   on  Enable !-style history expansion similar to csh(1).
                     This is turned on by the -H/--histexpand shell option and
                     can be modified using --histreedit and --histverify.

    KIA          off Allow generation of shell cross-reference database with -R.
                     As of 2021-05-10, no tool that can parse this database is
                     known. If you know of any, please contact us.

    MULTIBYTE        Multibyte character handling. This is on by default unless
                     the flag -DAST_NOMULTIBYTE is passed to the compiler via
                     CCFLAGS. The UTF-8 character set is fully supported.

    NAMESPACE    on  Adds a 'namespace' reserved word that allows defining name
                     spaces. Variables and functions defined within a block like
                        namespace ExampleSpace { commandlist; }
                     all have their names automatically prefixed with
                     '.ExampleSpace.' when defining or using them, creating a
                     separate space of names unique to the block. Outside of
                     the namespace block, they can be accessed using
                     .ExampleSpace.function or ${.ExampleSpace.variable}.
                     Name spaces within name spaces are also supported.

    MKSERVICE    off Enables the 'mkservice' builtin which creates a TCP or UDP
                     server that is implemented by shell functions, and the
                     'eloop' builtin which causes the shell to block waiting for
                     events to process. Experimental and probably insecure.

    NOECHOE      off Disable the '-e' option to the 'echo' command,
                     unless SHOPT_ECHOPRINT is enabled.

    OPTIMIZE     on  Optimize loop invariants for with for and while loops.

    PRINTF_LEGACY    The printf built-in accepts a format operand that starts
                     with '-' without the standard preceding '--' options
                     terminator. This is for compatibility with local scripts.
                     Enabled by default if the OS's printf(1) is POSIX-ignorant.

    P_SUID       0   If set, all real UIDs greater than or equal to this value
                     will require the -p option to run the shell setuid/setgid.

    REGRESS      off Enable the __regress__ built-in command and instrumented
                     intercepts for testing.

    REMOTE       off Set --rc (read profile scripts) even if ksh was invoked
                     with standard input on a socket, i.e. as a remote shell.

    SCRIPTONLY   off Compile out the interactive shell, resulting in a smaller
                     ksh binary that can only run scripts. Noted by "s" in the
                     version string when enabled. The option makes it an error
                     to invoke ksh as an interactive shell. The command history
                     mechanism, the fc/hist built-in, and the '-s' options to
                     the 'read' and 'print' built-ins are also compiled out.

    SPAWN        on  Use posix_spawn(3) as combined fork/exec if job control
                     is not active. Improves speed.

    STATS        on  Add .sh.stats compound variable.

    SYSRC            Source /etc/ksh.kshrc on initializing an interactive
                     shell. This is on by default if /etc/ksh.kshrc or
                     /etc/bash.bashrc exists at compile time.

    TEST_L           Add 'test -l' as an alias for 'test -L'. This is on by
                     default if the OS's external 'test' command supports it.

    TIMEOUT      off Set this to the number of seconds for timing out and
                     exiting the shell when you don't enter a command.  If
                     non-zero, TMOUT can not be set larger than this value.

    VSH          on  Compile with vi command line editing.  The original vi
                     line editor code was provided by Pat Sullivan at CB.

#### BUILDING KSH 93U+M ####

To build ksh (as well as libcmd and libast libraries on which ksh depends),
cd to the top directory and run:

	bin/package make

The compiled binaries are stored in the arch directory, in a subdirectory
that corresponds to your architecture. The command 'bin/package host type'
outputs the name of this subdirectory.

If you have trouble or want to tune the binaries, you may pass additional
compiler and linker flags. It is usually best to export these as environment
variables before running bin/package as they could change the name of the
build subdirectory of the arch directory, so exporting them is a convenient
way to keep them consistent between build and test commands. Note that this
system uses CCFLAGS instead of the usual CFLAGS. An example that makes
Solaris Studio cc produce a 64-bit binary:

	export CCFLAGS="-m64 -O" LDFLAGS="-m64"
	bin/package make

Alternatively you can append these to the command, and they will only be
used for that command. You can also specify an alternative shell in which to
run the build scripts this way. For example:

	bin/package make SHELL=/bin/bash CCFLAGS="-O2 -I/opt/local/include" \
		LDFLAGS="-L/opt/local/lib"

Note: Do not add compiler flags that cause the compiler to emit terminal
escape codes, such as -fdiagnostics-color=always; this will cause the build
to fail as the probing code greps compiler diagnostics.

If you are certain that you don't need support for UTF-8 and other multibyte
character locales and really want to save some memory and CPU cycles, add
'-DAST_NOMULTIBYTE' to CCFLAGS to compile out all multibyte character
handling in ksh and supporting libraries. Not recommended for most users.

To install, use: bin/package install DESTINATION_DIRECTORY [ COMMAND ... ]

Any command from the arch directory can be installed. If no COMMAND is
specified, ksh and shcomp are assumed.

The DESTINATION_DIRECTORY is created if it does not exist. Commands are
installed in its bin subdirectory and each command's manual page, if
available, is installed in share/man.

Destination directories with whitespace or shell pattern characters in their
pathnames are not yet supported.

For more information, run:

	bin/package help

Many other commands in this repo self-document via the --help, --man and
--html options; those that do have no separate manual page.

The build should also generate shcomp, a program that will precompile
a script.  ksh93 is able to recognize files in this format and process
them as scripts.  You can use shcomp to send out scripts when you
don't want to give away the original script source.

#### TESTING KSH ####

The tests subdirectory contains a number of regression tests for ksh.
To run all these tests with the shell you just built, run the command
	bin/shtests
For help and more options, type
	bin/shtests --man

#### OTHER DOCUMENTATION ####

The file PROMO.mm is an advertisement that extolls the virtues of ksh.
The file sh.1 contains the troff (man) description of this Shell.
The file nval.3 contains the troff (man) description of the name-value
pair library that is needed for writing built-ins that need to
access shell variables.

The file sh.memo contains a draft troff (mm) memo describing ksh.  The
file builtins.mm is a draft troff (mm) memo describing how to write
built-in commands that can be loaded at run time.

The file NEWS in the top-level directory contains bug fixes and other
changes made in the ksh 93u+m fork and supporting libraries.  The file
COMPATIBILITY contains a list of potential incompatibilities.

#### TESTED SYSTEMS ####

ksh 93u+m/1.0.5 has been compiled and tested on the following.
An asterisk signifies minor regression test failures (one or two minor
things amiss), two asterisks signify moderate regression test failures
(some functionality does not work), and three asterisks signify serious
failures (crashes, and/or important functionality does not work).

**	DragonFly BSD 6.2.2 on x86_64
	FreeBSD 12.2 on x86_64
	FreeBSD 13.0 on x86_64
	FreeBSD 12.2 on arm64 (thanks to hyenias for donating access to a Pi)
	FreeBSD 13.1 on arm64
	GNU/Linux: ArchLinux 6.2.8-1 on arm64
	GNU/Linux: Alpine 3.16.1 (musl C library) on x86_64
*	GNU/Linux: Alpine 3.18.0 (musl C library) on arm64
	GNU/Linux: CentOS 7 on x86_64
	GNU/Linux: Debian 11 (bullseye) on arm64
	GNU/Linux: Fedora 36 on x86_64
	GNU/Linux: Gentoo 2.8 on i386
	GNU/Linux: NixOS 22.11 on arm64
	GNU/Linux: Slackware 14.2 on x86_64
	GNU/Linux: Slackware 15.0 on i386
*	GNU/Linux: Ubuntu 20.04.6 on armv7l (32-bit)
	GNU/Linux: Void Linux (musl C library) on x86_64
***	Haiku R1/beta3 on x86_64
**	illumos: OmniOS r151044 (gcc) on x86_64
	macOS 10.14.6 (Mojave) on x86_64
	macOS 12.6.3 (Monterey) on arm64
	MidnightBSD 2.2.0 on x86_64
*	NetBSD 9.1 on x86_64
*	NetBSD 9.3 on x86_64
*	OpenBSD 7.0 on x86_64
**	OpenBSD 7.0 on i386
***	QNX Neutrino 6.5.0 on i386
	Solaris 10.1 (gcc) on i386
	Solaris 10.1 (gcc) on x86_64
	Solaris 11.4 (Solaris Studio 12.5 cc) on x86_64
***	Windows 7 using Cygwin on i386

#### REPORTING BUGS ####

Please report any problems or suggestions by opening an issue at:
https://github.com/ksh93/ksh
Alternatively, email martijn@inlv.org (timely response *not* promised).

Good luck!!

The ksh 93u+m contributors
https://github.com/ksh93/ksh

Originally written by:
David Korn
dgk@research.att.com
