.rn Dd xD

.de Dd

.ie \\$1$Mdocdate: \{\

. xD \\$2 \\$3, \\$4

.\}

.el .xD \\$1 \\$2 \\$3

..

.Dd $Mdocdate: January 5 2024 $

.ie \n(.g \{\

. if n .ss \n[.ss] 0

. if \*[.T]ascii .tr \-\N'45'

. if \*[.T]latin1 .tr \-\N'45'

. if \*[.T]utf8 .tr \-\N'45'

. if \*[.T]utf8 .tr \(la\*(Lt

. if \*[.T]utf8 .tr \(ra\*(Gt

. ds <= \(<=

. ds >= \(>=

. ds Rq \(rq

. ds Lq \(lq

. ds sL \(aq

. ds sR \(aq

. if \*[.T]utf8 .ds sL `

. if \*[.T]ps .ds sL `

. if \*[.T]utf8 .ds sR '

. if \*[.T]ps .ds sR '

. ds aq \(aq

. ds TI \(ti

. ds ha \(ha

. ds en \(en

. ie d volume-ds-1 .ds tT gnu

. el .ie d doc-volume-ds-1 .ds tT gnp

. el .ds tT bsd

.\}

.el \{\

. ds aq '

. ds TI ~

. ds ha ^

. ds en \(em

. ds tT ucb

.\}

.ie n \{\

. ds EM \ \(em\ \&

.\}

.el \{\

. ds EM \f(TR\|\(em\|\fP

.\}

.ie "\*(tT"gnu" \{\

. ds sP \s0

. ds tN \*[Tn-font-size]

. eo

. de Mx

. nr curr-font \n[.f]

. nr curr-size \n[.ps]

. ds str-Mx \f[\n[curr-font]]\s[\n[curr-size]u]

. ds str-Mx1 \*(tN\%MirBSD\*[str-Mx]

. if !\n[arg-limit] \

. if \n[.$] \{\

. ds macro-name Mx

. parse-args \$@

. \}

. if (\n[arg-limit] > \n[arg-ptr]) \{\

. nr arg-ptr +1

. ie (\n[type\n[arg-ptr]] == 2) \

. ds str-Mx1 \*(tN\%MirBSD\~#\*[arg\n[arg-ptr]]\*[str-Mx]

. el \

. nr arg-ptr -1

. \}

. ds arg\n[arg-ptr] "\*[str-Mx1]

. nr type\n[arg-ptr] 2

. ds space\n[arg-ptr] "\*[space]

. nr num-args (\n[arg-limit] - \n[arg-ptr])

. nr arg-limit \n[arg-ptr]

. if \n[num-args] \

. parse-space-vector

. print-recursive

..

. de Aq

. if !\n[arg-limit] \

. ds macro-name Aq

. ie \n[in-authors-section] \{\

. ds quote-left \*(Lt

. ds quote-right \*(Gt

. \}

. el \{\

. ds quote-left \[la]

. ds quote-right \[ra]

. \}

. enclose-string \$@

..

. ec

.\}

.el .ie "\*(tT"gnp" \{\

. ds sP \s0

. ie t .ds tN \s[(\n[.ps]u-1z)]

. el .ds tN

. eo

. de Mx

. nr doc-curr-font \n[.f]

. nr doc-curr-size \n[.ps]

. ds doc-str-Mx \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u]

. ds doc-str-Mx1 \*(tN\%MirBSD\*[doc-str-Mx]

. if !\n[doc-arg-limit] \

. if \n[.$] \{\

. ds doc-macro-name Mx

. doc-parse-args \$@

. \}

. if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\

. nr doc-arg-ptr +1

. ie (\n[doc-type\n[doc-arg-ptr]] == 2) \

. ds doc-str-Mx1 \*(tN\%MirBSD\~#\*[doc-arg\n[doc-arg-ptr]]\*[doc-str-Mx]

. el \

. nr doc-arg-ptr -1

. \}

. ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Mx1]

. nr doc-type\n[doc-arg-ptr] 2

. ds doc-space\n[doc-arg-ptr] "\*[doc-space]

. nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr])

. nr doc-arg-limit \n[doc-arg-ptr]

. if \n[doc-num-args] \

. doc-parse-space-vector

. doc-print-recursive

..

. ec

.\}

.el \{\

. de Mx

. nr cF \\n(.f

. nr cZ \\n(.s

. ds aa \&\f\\n(cF\s\\n(cZ

. if \\n(aC==0 \{\

. ie \\n(.$==0 \&\\*(tNMirBSD\\*(aa

. el .aV \\$1 \\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9

. \}

. if \\n(aC>\\n(aP \{\

. nr aP \\n(aP+1

. ie \\n(C\\n(aP==2 \{\

. nr xX 0

. nr xX 1+\\*(A\\n(aP

. as b1 \&\\*(tNMirBSD\ \&

. if \\n(xX>0 .as b1 #\&

. as b1 \&\\*(A\\n(aP\\*(aa

. rr xX

. ie \\n(aC>\\n(aP \{\

. nr aP \\n(aP+1

. nR

. \}

. el .aZ

. \}

. el \{\

. as b1 \&\\*(tNMirBSD\\*(aa

. nR

. \}

. \}

..

.\}

.Os MirBSD

.Nm lksh

.Nd Legacy Korn shell built on mksh

.Nm

.Bk -words

.Op Fl +abCefhiklmnprUuvXx

.Op Fl +o Ar opt

.Oo

.Fl c Ar string \*(Ba

.Fl s \*(Ba

.Ar file

.Op Ar args ...

.Oc

.Ek

.Nm

is a command interpreter intended exclusively for running legacy

shell scripts.

It is built on

.Nm mksh ;

refer to its manual page for details on the scripting language.

It is recommended to port scripts to

.Nm mksh

instead of relying on legacy or objectionable POSIX-mandated behaviour,

since the MirBSD Korn Shell scripting language is much more consistent.

.Pp

Do not use

.Nm

as an interactive or login shell; use

.Nm mksh

instead.

.Pp

Note that it's strongly recommended to invoke

.Nm

with

.Fl o Ic posix

to fully enjoy better compatibility to the

.Tn POSIX

standard (which is probably why you use

.Nm

over

.Nm mksh

in the first place);

.Fl o Ic sh

(possibly additionally to the above) may be needed for some legacy scripts.

.Nm

currently has the following differences from

.Nm mksh :

.Bl -bullet

.It

The

.Ev KSH_VERSION

string identifies

.Nm

as

.Dq Li LEGACY KSH

instead of

.Dq Li MIRBSD KSH .

Note that the rest of the version string is identical between

the two shell flavours, and the behaviour and differences can

change between versions; see the accompanying manual page

.Xr mksh 1

for the versions this document applies to.

.It

.Nm

uses

.Tn POSIX

arithmetic, which has quite a few implications:

The data type for arithmetic operations is the host

.Tn ISO

C

.Vt long

data type.

Signed integer wraparound is Undefined Behaviour; this means that...

.Bd -literal -offset indent

$ echo $((2147483647 + 1))

.Ed

.Pp

\&... is permitted to, e.g. delete all files on your system

(the figure differs for non-32-bit systems, the rule doesn't).

The sign of the result of a modulo operation with at least one

negative operand is unspecified.

Shift operations on negative numbers are unspecified.

Division of the largest negative number by \-1 is Undefined Behaviour.

The compiler is permitted to delete all data and crash the system

if Undefined Behaviour occurs (see above for an example).

.It

The rotation arithmetic operators are not available.

.It

The shift arithmetic operators take all bits of the second operand into

account; if they exceed permitted precision, the result is unspecified.

.It

Unless

.Ic set -o posix

is active,

.Nm

always uses traditional mode for constructs like:

.Bd -literal -offset indent

$ set -- $(getopt ab:c "$@")

$ echo $?

.Ed

.Pp

POSIX mandates this to show 0, but traditional mode

passes through the errorlevel from the

.Xr getopt 1

command.

.It

Functions defined with the

.Ic function

reserved word share the shell options

.Pq Ic set -o

instead of locally scoping them.

.El

.Xr mksh 1

.Pp

.Pa http://www.mirbsd.org/mksh.htm

.Pp

.Pa http://www.mirbsd.org/ksh\-chan.htm

To use

.Nm

as

.Pa /bin/sh ,

compilation to enable

.Ic set -o posix

by default if called as

.Nm sh

.Pq adding Dv \-DMKSH_BINSHPOSIX to Dv CPPFLAGS

is highly recommended for better standards compliance.

.Pp

For better compatibility with legacy scripts, such as many

.Tn Debian

maintainer scripts, Upstart and SYSV init scripts, and other

unfixed scripts, also adding the

.Dv \-DMKSH_BINSHREDUCED

compile-time option to enable

.Em both

.Ic set -o posix -o sh

when the shell is run as

.Nm sh ,

as well as integrating the optional disrecommended

.Xr printf 1

builtin, might be necessary.

.Pp

.Nm

tries to make a cross between a legacy bourne/posix compatibl-ish

shell and a legacy pdksh-alike but

.Dq legacy

is not exactly specified.

.Pp

Talk to the

.Mx

development team and users using the mailing list at

.Aq Mt miros\-[email protected]

or in the

.Li \&#\&!/bin/mksh

IRC channel; mind the infos from

.Pa http://www.mirbsd.org/mksh\-faq.htm#contact

for either.

Consider migrating your legacy scripts to work with

.Nm mksh

instead of requiring

.Nm .