Config...:server(3pm)

📦
version 2.055 · 4 versions
, in debian trixie, ubuntu resolute

✨ NAME ✨

Config::Model::models::LCDd::server — that's the Configuration class for LCDd::server, bestie. This whole thing lives in the Config...:server(3pm) manual page, under User Contributed Perl Documentation, and yes it's a Perl one. 🫶

🌸 DESCRIPTION 🌸

These are Configuration classes used by Config::Model — and they were generated from LCDd.conf. No cap, that's literally where they come from. 💅

🦋 ELEMENTS 🦋

Okay so this is the part where we go through every single one. Buckle up, there's a lot, but they're all kinda iconic. ✨

AutoRotate

If you set this to no, LCDd will start with screen rotation disabled. It has the same effect as if the ToggleRotateKey had been pressed. Rotation will start if the ToggleRotateKey is pressed. Lowkey important: this setting does not turn off priority sorting of screens. 👑

  • Optional? yes, it's optional.
  • Type: boolean
  • upstream_default value: on

Backlight

Sets the master backlight setting. If you set it to 'open', a client may control the backlight for its own screens — and only its own screens. 🙈

  • Optional? yes.
  • Type: enum
  • choice: 'off', 'open', 'on'
  • upstream_default value: open

Bind

Tells the driver to bind to the given interface. Simple as that. 💫

  • Optional? yes.
  • Type: uniline
  • upstream_default value: 127.0.0.1

Driver

Tells the server to load the given drivers. Multiple lines can be given. 🚗✨

The name of the driver is case sensitive and determines the section where to look for further configuration options of the specific driver, as well as the name of the dynamic driver module to load at runtime. That module name can be changed by giving a File= directive in the driver specific section.

The following drivers are supported:

bayrad, CFontz, CFontzPacket, curses, CwLnx, ea65, EyeboxOne, futaba,
g15, glcd, glcdlib, glk, hd44780, icp_a106, imon, imonlcd,, IOWarrior,
irman, joy, lb216, lcdm001, lcterm, linux_input, lirc, lis, MD8800,
mdm166a, ms6931, mtc_s16209x, MtxOrb, mx5000, NoritakeVFD,
Olimex_MOD_LCD1x9, picolcd, pyramid, rawserial, sdeclcd, sed1330,
sed1520, serialPOS, serialVFD, shuttleVFD, sli, stv5730, svga, t6963,
text, tyan, ula200, vlsys_m428, xosd, yard2LCD.
bestie don't come for me about the double comma after imonlcd — that's in the source, I'm just the messenger 💀
  • Optional? yes.
  • Type: check_list
  • choice: 'bayrad', 'CFontz', 'CFontzPacket', 'curses', 'CwLnx', 'ea65', 'EyeboxOne', 'futaba', 'g15', 'glcd', 'glcdlib', 'glk', 'hd44780', 'icp_a106', 'imon', 'imonlcd', 'IOWarrior', 'irman', 'joy', 'lb216', 'lcdm001', 'lcterm', 'linux_input', 'lirc', 'lis', 'MD8800', 'mdm166a', 'ms6931', 'mtc_s16209x', 'MtxOrb', 'mx5000', 'NoritakeVFD', 'Olimex_MOD_LCD1x9', 'picolcd', 'pyramid', 'rawserial', 'sdeclcd', 'sed1330', 'sed1520', 'serialPOS', 'serialVFD', 'shuttleVFD', 'sli', 'stv5730', 'svga', 't6963', 'text', 'tyan', 'ula200', 'vlsys_m428', 'xosd', 'yard2LCD'

DriverPath

Where can we find the driver modules? 👀

IMPORTANT: Make sure to change this setting to reflect your specific setup! Otherwise LCDd won't be able to find the driver modules and will thus not be able to function properly.
NOTE: Always place a slash as last character!
  • Optional? yes.
  • Type: uniline

Note: DriverPath is computed with

use Dpkg::Arch qw/get_host_arch debarch_to_multiarch/;
             my $triplet = debarch_to_multiarch(get_host_arch());
             "/usr/lib/$triplet/lcdproc/";

and with:

  • (the bullet right here is literally empty in the original — not me skipping it, I promise 😭)

Foreground

The server will stay in the foreground if set to yes. Main character energy, never leaves. 💅

  • Optional? yes.
  • Type: uniline
  • upstream_default value: no,legal:yes,no

FrameInterval

Sets the interval in microseconds for updating the display. The default is 125000, meaning 8Hz. ⏱️

  • Optional? yes.
  • Type: uniline
  • upstream_default value: 125000

GoodBye

  • Optional? yes.
  • Type: list of uniline

Heartbeat

Set the master heartbeat setting. If you set it to 'open', a client may control the heartbeat for its own screens — again, only its own. 💓

  • Optional? yes.
  • Type: enum
  • choice: 'off', 'open', 'on'
  • upstream_default value: open

Hello

  • Optional? yes.
  • Type: list of uniline

NextScreenKey

  • Optional? yes.
  • Type: uniline
  • default value: Right

Port

Listen on this specified port. 🚪

  • Optional? yes.
  • Type: integer
  • upstream_default value: 13666

PrevScreenKey

  • Optional? yes.
  • Type: uniline
  • default value: Left

ReportLevel

Sets the reporting level; defaults to warnings and errors only. So it's giving chill, not chatty. 🤫

  • Optional? yes.
  • Type: integer
  • upstream_default value: 2

ReportToSyslog

Should we report to syslog instead of stderr? 👑

  • Optional? yes.
  • Type: boolean
  • default value: yes

ScrollDownKey

  • Optional? yes.
  • Type: uniline
  • upstream_default value: Down

ScrollUpKey

  • Optional? yes.
  • Type: uniline
  • upstream_default value: Up

ServerScreen

If yes, the the serverscreen will be rotated as a usual info screen. If no, it will be a background screen, only visible when no other screens are active. The special value 'blank' is similar to no, but only a blank screen is displayed. ✨

(yes, "the the" is in the source, I am NOT fixing it, that's not my job 🫶)
  • Optional? yes.
  • Type: enum
  • choice: 'on', 'off', 'blank'
  • upstream_default value: on

TitleSpeed

Sets the title scrolling speed. 🎀

  • Optional? yes.
  • Type: integer
  • upstream_default value: 10

ToggleRotateKey

The "...Key=" lines define what the server does with keypresses that don't go to any client. The ToggleRotateKey stops rotation of screens, while the PrevScreenKey and NextScreenKey go back / forward one screen (even if rotation is disabled).

Assign the key string returned by the driver to the ...Key setting. These are the defaults: ⌨️

  • Optional? yes.
  • Type: uniline
  • default value: Enter

User

User to run as. LCDd will drop its root privileges and run as this user instead. Very demure, very mindful, very not-root. 🙈

  • Optional? yes.
  • Type: uniline

WaitTime

Sets the default time in seconds to displays a screen. ⏳

  • Optional? yes.
  • Type: integer
  • upstream_default value: 4

🌈 SEE ALSO 🌈

  • cme

and that's the whole thing, bestie — you ate that. this page is perl v5.40.1, dated 2025-03-04, and it's filed under Config...:server(3pm). go forth and configure your LCDd server like the icon you are 💖✨👑

📦 where this page comes from