olad(1)

๐Ÿ’… olad โ€” the manual, but make it cute

okay so bestie, you're holding the page for olad from the General Commands Manual โ€” yes, the one and only Open Lighting Architecture Daemon. put your hair up, grab a strawberry drink ๐Ÿ“, and let's get into it.


โœจ NAME โœจ

olad โ€” The Open Lighting Architecture Daemon ๐Ÿ‘‘


๐ŸŒˆ SYNOPSIS ๐ŸŒˆ

olad [options]

that's it. that's the whole vibe. options go in, daemon comes out ๐Ÿ’–


๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

olad is the Open Lighting Architecture (OLA) daemon, fr fr. it's the main character that handles all the talking to your DMX512 / RDM hardware devices and the remote network hosts, over a whole bunch of different lighting control protocols. so likeโ€ฆ it's the social butterfly of your lighting setup ๐Ÿซถโœจ


๐ŸŽ€ OPTIONS ๐ŸŽ€

here come the flags, bestie. every single one. no skips, no cuts ๐Ÿ’ฏ

  • -c, --config-dir <string> โ€” the path to the config directory. defaults to ~/.ola/ on *nix and %LOCALAPPDATA%.ola on Windows ๐Ÿ—‚๏ธ
  • -d, --http-data-dir <string> โ€” the path to the static www content. it's giving web server realness ๐ŸŒ
  • -f, --daemon โ€” fork and run as a background process. bye bestie, you're on your own now ๐Ÿ‘‹
  • -h, --help โ€” display the help message. we love a self-explanatory queen ๐Ÿ’โ€โ™€๏ธ
  • -i, --interface <string> โ€” the interface name (e.g. eth0) or IP address of the network interface to use for the web server ๐Ÿ”Œ
  • -l, --log-level <int8_t> โ€” set the logging level 0 .. 4. see LOGGING below for the tea ๐Ÿ“
  • -p, --http-port <uint16_t> โ€” the port to run the HTTP server on. defaults to 9090 ๐Ÿšช
  • -r, --rpc-port <uint16_t> โ€” the port to listen for RPCs on. defaults to 9010 ๐Ÿ“ž
  • -v, --version โ€” print olad version information. proof of identity, periodt โœจ
  • --no-http โ€” disable the HTTP server. no web server for you ๐Ÿšซ
  • --no-http-quit โ€” disable the HTTP /quit handler. can't rage-quit through the browser anymore ๐Ÿ˜ค
  • --no-register-with-dns-sd โ€” don't register the web service using DNS-SD (Bonjour). staying lowkey, we respect it ๐Ÿ™ˆ
  • --no-use-async-libusb โ€” disable the use of the asynchronous libusb calls, revert to synchronous. old school, but make it work ๐Ÿ”„
  • --no-use-epoll โ€” disable the use of epoll(), revert to select() โช
  • --no-use-kqueue โ€” disable the use of kqueue(), revert to select() โช
  • --pid-location <string> โ€” the directory containing the PID definitions. gotta know where your processes live ๐Ÿ 
  • --scheduler-policy <policy> โ€” the thread scheduling policy, one of {fifo, rr} ๐Ÿงต
  • --scheduler-priority <priority> โ€” the thread priority, only used if --scheduler-policy is set. it needs its bestie to be there first, iykyk ๐Ÿค
  • --syslog โ€” send to syslog rather than stderr ๐Ÿ“ฎ

๐Ÿงš LOGGING ๐Ÿงš

olad can either log to stderr(4) or syslog(5). and here's the important part, bestie โ€” each log level includes those of higher severity. so level 3 isn't just level 3, it's 3 and up. the way that works?? iconic.

  1. 0 โ€” No logging. silence. the quiet luxury era ๐Ÿคซ
  2. 1 โ€” Fatal logging. ๐Ÿ’€
  3. 2 โ€” Warnings. โš ๏ธ
  4. 3 โ€” Informational logging. ๐Ÿ“ฐ
  5. 4 โ€” Debug logging. the full gossip, everything, all of it ๐Ÿ”

๐ŸŒธ SIGNALS ๐ŸŒธ

once it's running, these signals control the behavior of olad, no cap:

  • SIGHUP โ€” Reloads the plugins. refresh, restart, rebrand โœจ
  • SIGUSR1 โ€” Increases the logging level, eventually wrapping ๐Ÿ”

๐Ÿ’œ SEE ALSO ๐Ÿ’œ

go say hi to the siblings, they're lovely ๐Ÿซถ


and that's the whole page, bestie. you're officially fluent in olad ๐Ÿ’…

โœง๏ฝฅ๏พŸ mwah, and good luck out there ๏ฝฅ๏พŸโœง


this little masterpiece is from August 2018, and it's page olad(1) โ€” daemon queen, version of record, forever iconic. thanks for coming to my ted talk ๐ŸŽ€