xref: /freebsd/libexec/flua/libfreebsd/kenv/freebsd.kenv.3lua (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2024, Baptiste Daroussin <bapt@FreeBSD.org>
5.\"
6.Dd September 6, 2024
7.Dt FREEBSD.KENV 3lua
8.Os
9.Sh NAME
10.Nm freebsd.kenv
11.Nd Lua binding to
12.Fx 's
13Linker functions
14.Sh SYNOPSIS
15.Bd -literal
16local kenv = require('freebsd.kenv')
17.Ed
18.Pp
19.Bl -tag -width XXXX -compact
20.It Dv table = kenv.get()
21.It Dv value = kenv.get(key)
22.El
23.Sh DESCRIPTION
24The
25.Nm
26module is a binding to the
27.Xr kenv 2
28function.
29.Pp
30List of functions:
31.Bl -tag -width XXXX
32.It Dv table = freebsd.kenv.get()
33Dump the kernel environnement into a key/value
34.Fa table .
35.It Dv value = freebsd.kenv.get(key)
36Return the
37.Fa value
38associated to the
39.Fa key ,
40if it exists, or
41.Va nil
42otherwise.
43.Sh SEE ALSO
44.Xr kenv 2
45