xref: /freebsd/libexec/flua/flua.1 (revision cbe50f7c20cf0ca484d29cf345864a18c29850e7)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2025 The FreeBSD Foundation
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\"
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd April 28, 2025
29.Dt FLUA 1
30.Os
31.Sh NAME
32.Nm flua
33.Nd Lua interpreter for the FreeBSD base system
34.Sh SYNOPSIS
35.Nm flua
36.Op Fl EWiv
37.Op Fl e Ar string
38.Op Fl l Ar module
39.Op Fl l Ar g=module
40.Op Ar script Op Ar args
41.Op Fl -
42.Op Fl
43.Sh DESCRIPTION
44.Nm
45is a minimal Lua interpreter integrated into the FreeBSD base system.
46It is derived from Lua 5.4 with modifications to suit the needs of
47.Fx
48build infrastructure and system tooling.
49.Nm
50is intended for internal use within the base system and is
51.Em not
52designed for general-purpose scripting or use by third-party applications.
53.Pp
54Unlike full Lua installations provided by the Ports Collection,
55.Nm
56has a reduced feature set and is limited to meeting the requirements of
57base system environments such as the bootloader.
58.Sh USAGE
59.Nm
60is typically invoked internally by FreeBSD base system tools and build scripts.
61While it accepts Lua source files and arguments in a standard fashion, its
62limited environment and module support make it unsuitable for general scripting
63use.
64.Sh INCLUDED MODULES
65.Nm
66includes a subset of functionality from a small number of standard Lua modules
67as well as bespoke modules necessary for the base system:
68.Bl -bullet
69.It
70lfs (LuaFileSystem) – file attribute and directory manipulation
71.It
72lposix - basic POSIX system calls
73.It
74.Xr freebsd.kenv 3lua
75.It
76.Xr freebsd.sys.linker 3lua
77.It
78.Xr hash 3lua
79.It
80.Xr jail 3lua
81.El
82.Sh NOTES
83.Nm
84should not be used as a replacement for
85.Xr lua 1
86from the Ports Collection (e.g.,
87.Pa lang/lua54 )
88as it may be modified or updated to a newer Lua version in the future without
89retaining backwards compatibility.
90.Sh SEE ALSO
91.Xr freebsd.kenv 3lua ,
92.Xr freebsd.sys.linker 3lua ,
93.Xr hash 3lua ,
94.Xr jail 3lua ,
95.Xr style.lua 9
96.Sh HISTORY
97.Nm
98first appeared in
99.Fx 14.0 .
100