summaryrefslogtreecommitdiff
path: root/static/freebsd/man8/screen.lua.8
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
commitac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (patch)
tree9367490586c84cba28652e443e3166d66c33b0d9 /static/freebsd/man8/screen.lua.8
parent253e67c8b3a72b3a4757fdbc5845297628db0a4a (diff)
docs: Added All FreeBSD Manuals
Diffstat (limited to 'static/freebsd/man8/screen.lua.8')
-rw-r--r--static/freebsd/man8/screen.lua.8100
1 files changed, 100 insertions, 0 deletions
diff --git a/static/freebsd/man8/screen.lua.8 b/static/freebsd/man8/screen.lua.8
new file mode 100644
index 00000000..a41ce6fa
--- /dev/null
+++ b/static/freebsd/man8/screen.lua.8
@@ -0,0 +1,100 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
+.\" Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
+.\"
+.\" 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 March 29, 2025
+.Dt SCREEN.LUA 8
+.Os
+.Sh NAME
+.Nm screen.lua
+.Nd bootloader screen manipulation module
+.Sh DESCRIPTION
+.Nm
+contains functionality for manipulating the screen.
+This includes functionality such as clearing the screen, moving the cursor, and
+setting foreground/background colors using sequences provided by
+.Xr color.lua 8 .
+.Pp
+Before using the functionality provided by
+.Nm ,
+it must be included with a statement such as the following:
+.Pp
+.Dl local screen = require("screen")
+.Pp
+The following variables are exported from
+.Nm :
+.Bl -tag -width "Ic screen.default_x" -offset indent
+.It Ic screen.default_x
+The x component of the default cursor position.
+.It Ic screen.default_y
+The y component of the default cursor position.
+.El
+.Pp
+The following functions are exported from
+.Nm :
+.Bl -tag -width "Fn screen.clear" -offset indent
+.It Fn screen.clear
+Clears the screen.
+.Fn screen.clear
+will do nothing if a serial boot is detected.
+.It Fn screen.setcursor x y
+Sets the cursor position to
+.Fa x ,
+.Fa y .
+.Fn screen.setcursor
+will do nothing if a serial boot is detected.
+.It Fn screen.setforeground color_value
+Sets the foreground color to
+.Fa color_value ,
+which should be a constant defined in
+.Xr color.lua 8 .
+.Fn screen.setforeground
+will do nothing if color is disabled.
+.It Fn screen.setbackground color_value
+Sets the background color to
+.Fa color_value ,
+which should be a constant defined in
+.Xr color.lua 8 .
+.Fn screen.setbackground
+will do nothing if color is disabled.
+.It Fn screen.defcolor
+Sets the default color scheme, as defined by
+.Fn color.default .
+.Fn screen.defcolor
+will do nothing if color is disabled.
+.It Fn screen.defcursor
+Sets the default cursor position to that defined by
+.Ic screen.default_x ,
+.Ic screen.default_y .
+.El
+.Sh SEE ALSO
+.Xr color.lua 8
+.Sh AUTHORS
+The
+.Nm
+file was originally written by
+.An Pedro Souza Aq Mt pedrosouza@FreeBSD.org .
+Later work and this manual page was done by
+.An Kyle Evans Aq Mt kevans@FreeBSD.org .