cyclades-serial-client(8)

💖 cyclades-serial-client — the manual, but make it make sense 💖

okay bestie, sit down, hydrate, because we're learning cyclades-serial-client(8) and honestly? it's giving "tiny tool, big responsibilities". it lives in section 8 of the manual, it's a serial port interface thing for Cyclades terminal servers, and yes we're gonna go through literally every line together. no skimming. 🎀

---

✨ NAME ✨

cyclades-serial-client-SerialPortInterfaceforCycladesTerminalServers

that's the whole name. it's a mouthful, it's a run-on, it's iconic, and it literally spells out what it is: the Serial Port Interface for Cyclades Terminal Servers. periodt. 💅

---

🦋 SYNOPSIS 🦋

cyclades-serial-client (start | stop | restart | status) [devname]

so you must give it one of those four verbs — start, stop, restart or status — and you may hand it a devname. that's the shape of it. no devname, no problem. devname, and it's personal. 😌

---

🌸 DESCRIPTION 🌸

so here's the tea: there's a file called cyclades-devices, and it lists physical ports. for each physical port listed in that file, cyclades-serial-client controls the status of the matching cyclades-ser-cli interface.

that's it. that's the job. it's a little manager bestie for a little fleet of interfaces. 💖

---

💅 OPTIONS 💅

cyclades-serial-client must be invoked with one of start, stop, restart or status — like, non-negotiable, it will not figure it out for you — and optionally with an argument that points at one specific device. if you do give that argument, the action you picked gets performed only for that device. just that one. nobody else invited. 🙈

if you don't supply the argument? then the action gets performed for all the devices listed in the cyclades-devices file. all of them. the whole group chat. ✨

the mandatory options are:

• start — kicks off the cyclades-ser-cli program, using the parameters supplied in the cyclades-devices file. if that program is already running, it'll show you a message instead, and it will not start an extra copy. one copy only, bestie. no duplicates. 👑
• stop — stops the cyclades-ser-cli program(s) by issuing a SIGTERM signal. bye babe. 💀
• restart — simulates a hangup to the cyclades-ser-cli program(s) by issuing a SIGUSR1 signal. it's a lil nudge, not a full yeet. 🔥
• status — checks the status of the cyclades-ser-cli program(s). just vibes inspection. 🦋

---

🌈 EXAMPLES 🌈

okay let's say your cyclades-devices file is configured like this:

/dev/ctty01:pr3k:1:rtelnet: /dev/ctty02:pr3k:2:socket:

now watch the whole thing play out, step by step. 🍓

1. start all the devices:

cyclades-serial-client start

messages you get:

Starting /dev/ctty01 <==> pr3k:1 interface
Starting /dev/ctty02 <==> pr3k:2 interface

2. try to start them again:

cyclades-serial-client start

messages you get:

cyclades-serial-client : /dev/ctty01 already active
cyclades-serial-client : /dev/ctty02 already active

3. stop only the /dev/ctty01 device:

cyclades-serial-client stop /dev/ctty01

message you get:

Stopping /dev/ctty01 <==> pr3k:2 interface

4. checking status:

cyclades-serial-client status

messages you get:

/dev/ctty01 (rtelnet at pr3k:1) is inactive
/dev/ctty02 ( socket at pr3k:2) active, pid 2983

5. start a device that doesn't exist:

cyclades-serial-client start /dev/xtty01

message you get:

cyclades-serial-client : device /dev/xtty01 does not exist

---

👑 SEE ALSO 👑

go read these too, they're part of the lore:

• cyclades-ser-cli(1)
• cyclades-devices(5)

---

and that's the whole page, bestie. footer says cyclades-serial-client(8) right back at you — same name as the top, no date stamp, just the section name holding it down at the bottom like a little signature. 💜 you're welcome, now go status something. 🌟