From nobody Mon Apr 21 19:17:06 2025 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4ZhFVV4bqYz5svBh; Mon, 21 Apr 2025 19:17:06 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4ZhFVV3JHwz4QL0; Mon, 21 Apr 2025 19:17:06 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1745263026; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=RfGCNTmMUJz90AhzO6DnE+wFAXhomctpx5dCH5S/2Ds=; b=han04bC6ySeoL9BOZ1H7EMwnH3TVe41Z6gt67yODrnPxKNQoOau+QOeaGrHZh+zo8s7g5m KpwGsz8mnjN/G+WFzLQYsd1s6674FEggdVh5CNZUsqwUBdjbP6R3nUgIlYJq9PGdYVseLE oHn9HqoEVtVYj6gV4PDEVNv98kpMn5fj/ZgOdjW7inZZfFPmCejjcIbSUqlVRw1VMy91Mo MMo1luFMiShSegRDagyskmfZhcgge48DbLVugerrE4rGaUKImtMnISjpSEZ5kpBSYuQRhQ jfVFAF/nVyUr+X5MPPAGsmT7rvmChlPxnEtvv8s9Tng4rt7cE653CuSwrTC5SA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1745263026; a=rsa-sha256; cv=none; b=ZwcjwtNOvydZvwtTbIUYmh4u0FxC8By5OvoqtEt8REAvC/knNO/o5/L0Qq6ARXLlJyzCL9 /ZIb+NRO70B7pDczNgGtdE1CE9UVn2MyP0Igw65RoH/v9ZL+TDt73ub/d4cr/9KsSFsTgG R2w7KQIILuL3oNnXRurZ1ziFYZEbZAb5opASfA2kjJxU+PZpDoM/ssFX+Alwm5IJiGuNYB OpYESlZ+UsaykgImR47b5897bOBGPhba3gBgZFf2vuYyRthXnw+QxgQCBJVx+K4EBDO5+3 ynPfbVUVRsSznl3F2g1N4DaOqc8pBDRMFRaNlpwzvsB7WWOadafFEXi8SlxMNg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1745263026; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=RfGCNTmMUJz90AhzO6DnE+wFAXhomctpx5dCH5S/2Ds=; b=Y5xDkXZixRBY8BN18l9QS74jGZfTnM7JLDJWY++g3CL6qqJQp2fqb5LJJnuWVIfyPqJwen +mXXGtJ82rMLqzfpSh/uf1b35CxOy3cZZgxeov/HshnCyVbHsBzgS5qvYkVIhJdTKq5z/x joy0jsKJs8aqim4A/UA64RtbdbCQGvIU/8fwXdA+9x18hmtDY+fzuOhU8Zqn5kI4yKs5/Z mFpNUADbVHUZa04xZfO555+OWI//YQIt/J9W4x8QVgB349GAfEK5dT5ctgk3ieBLLtIyLJ Q1mI/doJ3HHarPJK/Ax0l1SMIn0hTYCZQTliTep09zDng93WqdhupZO0BiNvDA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4ZhFVV2pV1z12rZ; Mon, 21 Apr 2025 19:17:06 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 53LJH6Us008579; Mon, 21 Apr 2025 19:17:06 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 53LJH6EU008576; Mon, 21 Apr 2025 19:17:06 GMT (envelope-from git) Date: Mon, 21 Apr 2025 19:17:06 GMT Message-Id: <202504211917.53LJH6EU008576@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Ed Maste Subject: git: 550289771d5c - main - flua: Add minimal man page List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: emaste X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 550289771d5cb73befb6a1645fb9cdf0b9fb65a7 Auto-Submitted: auto-generated The branch main has been updated by emaste: URL: https://cgit.FreeBSD.org/src/commit/?id=550289771d5cb73befb6a1645fb9cdf0b9fb65a7 commit 550289771d5cb73befb6a1645fb9cdf0b9fb65a7 Author: Ed Maste AuthorDate: 2025-04-15 15:23:39 +0000 Commit: Ed Maste CommitDate: 2025-04-21 19:16:42 +0000 flua: Add minimal man page Flua is a minimal Lua interpreter integrated into the FreeBSD base system. It is intended for internal use and is not designed for general-purpose scripting or use by third-party applications, and was originally intentionally undocumented. There have been questions about its purpose, and questions about the available functionality from internal users, so provide a minimal man page including these details. Reviewed by: kevans, Isaac Freund Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D49835 --- libexec/flua/Makefile | 1 - libexec/flua/flua.1 | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 1 deletion(-) diff --git a/libexec/flua/Makefile b/libexec/flua/Makefile index 08ea9c002d61..770f05bf2938 100644 --- a/libexec/flua/Makefile +++ b/libexec/flua/Makefile @@ -10,7 +10,6 @@ LUASRC?= ${SRCTOP}/contrib/lua/src PROG= flua WARNS?= 3 -MAN= # No manpage; this is internal. CWARNFLAGS.gcc+= -Wno-format-nonliteral diff --git a/libexec/flua/flua.1 b/libexec/flua/flua.1 new file mode 100644 index 000000000000..796ab813f89f --- /dev/null +++ b/libexec/flua/flua.1 @@ -0,0 +1,98 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2025 The FreeBSD Foundation +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd April 21, 2025 +.Dt FLUA 1 +.Os +.Sh NAME +.Nm flua +.Nd Lua interpreter for the FreeBSD base system +.Sh SYNOPSIS +.Nm flua +.Op Fl EWiv +.Op Fl e Ar string +.Op Fl l Ar module +.Op Fl l Ar g=module +.Op Ar script Op Ar args +.Op Fl - +.Op Fl +.Sh DESCRIPTION +.Nm +is a minimal Lua interpreter integrated into the FreeBSD base system. +It is derived from Lua 5.4 with modifications to suit the needs of +.Fx +build infrastructure and system tooling. +.Nm +is intended for internal use within the base system and is +.Em not +designed for general-purpose scripting or use by third-party applications. +.Pp +Unlike full Lua installations provided by the Ports Collection, +.Nm +has a reduced feature set and is limited to meeting the requirements of +base system environments such as the bootloader. +.Sh USAGE +.Nm +is typically invoked internally by FreeBSD base system tools and build scripts. +While it accepts Lua source files and arguments in a standard fashion, its +limited environment and module support make it unsuitable for general scripting +use. +.Sh INCLUDED MODULES +.Nm +includes a subset of functionality from a small number of standard Lua modules +as well as bespoke modules necessary for the base system: +.Bl -bullet +.It +lfs (LuaFileSystem) – file attribute and directory manipulation +.It +lposix - basic POSIX system calls +.It +.Xr freebsd.kenv 3lua +.It +.Xr freebsd.sys.linker 3lua +.It +.Xr hash 3lua +.It +.Xr jail 3lua +.El +.Sh NOTES +.Nm +should not be used as a replacement for +.Xr lua 1 +from the Ports Collection (e.g., +.Pa lang/lua54 ) +as it may be modified or updated to a newer Lua version in the future without +retaining backwards compatibility. +.Sh SEE ALSO +.Xr freebsd.kenv 3lua , +.Xr freebsd.sys.linker 3lua , +.Xr hash 3lua , +.Xr jail 3lua +.Sh HISTORY +.Nm +first appeared in +.Fx 14.0 .