Manual Pages  — DRAWER.LUA

drawer.lua – FreeBSD menu/screen drawer module

DESCRIPTION BRAND DEFINITIONS LOGO DEFINITIONS CUSTOM BRANDS AND LOGOS FRAME STYLES Exported functions SEE ALSO AUTHORS

drawer.lua contains functionality for drawing and manipulating the menu, logo, and brand to the screen.

Before using the functionality provided by drawer.lua, it must be included with a statement such as the following:

    local drawer = require("drawer")

The brand and logo system is designed to allow brands and logos to be easily plugged in. When an unrecognized loader_brand or loader_logo are encountered, drawer.lua will attempt to include brand-${loader_brand}.lua or logo-${loader_logo}.lua respectively. These files are expected to call either drawer.addBrand() or drawer.addLogo() to add the requested branddef or logodef. drawer.lua will attempt to do another lookup for the requested brand or logo before falling back to one of the following:

drawer.default_brand	The default brand to be used if the requested brand cannot be located.
drawer.default_color_logodef
	The default logodef to be used if an invalid logodef is requested and loader(8) has been configured to allow output of color.
drawer.default_bw_logodef	The default logodef to be used if either an invalid logodef has been requested, or a logodef has been requested that requires color and loader(8) has been configured to not output color.

drawer.lua contains the definitions for the different frame styles that may be drawn around the menu. Frame styles define the characters drawn for horizontal lines, vertical aligns, and each of the four corner styles. The following keys may be defined for a frame style:

• horizontal
• vertical
• top_left
• bottom_left
• top_right
• bottom_right

Frame styles are currently defined in the table drawer.frame_styles indexed by the name used for loader_menu_frame. No API currently exists for manipulating this table indirectly.

The following functions are exported from drawer.lua:

drawer.addBrand(name, def)
	Add the brand definition described by def to the table of known brand definitions, indexed by name.
drawer.addLogo(name, def)
	Add the logo definition described by def to the table of known logo definitions, indexed by name.
drawer.drawscreen(menudef)
	Draws the logo, brand, menu frame, and the current menu as described in menudef, formatted as defined by menu.lua(8).

The drawer.lua file was originally written by Pedro Souza <Mt pedrosouza@FreeBSD.org>. Later work and this manual page was done by Kyle Evans <Mt kevans@FreeBSD.org>.