AMSSHELL(1)

Okay bestie, come sit with me 🧚 this is the manual for amsshell, a little program from the AMS executables crew, and I'm about to explain it in a way that actually makes sense 💖

✨ NAME ✨

amsshell is the Asynchronous Message Service (AMS) test message sender (UNIX) 💅

🎀 SYNOPSIS 🎀

amsshell unit_name role_name application_name authority_name [{ p | s | q | a }]

🌸 DESCRIPTION 🌸

okay so amsshell is a message issuance program, and its whole purpose is testing AMS functionality 🦋 it's giving test-drive energy.

When you start amsshell, it registers itself as an application module in the unit named by unit_name, inside the venture named by application_name and authority_name 🫶. You have to say which role it registers in with role_name. Before it can run, a configuration server for the local continuum AND a registrar for that unit of that venture need to be running ✨ (they can both live in one amsd daemon task, which is iconic).

amsshell runs two threads at once 🔥. There's a background thread that catches watches for AMS configuration events (shutdown included 💀), and a foreground thread that reads console lines from stdin to pick up your operating parameters and message content, then issues the messages.

The first character of every line on stdin tells amsshell what that line is for:

• = — sets the subject that every message goes out on, until another = line replaces it. The subject name starts at the second character of the line. You can also add a single ' ' (space) after the subject name, followed by the text of the first message, which gets issued right away on that subject 💌
• r — sets the role number that limits the domain of message issuance. The role number starts at the second character.
• c — sets the continuum number that limits the domain of message issuance. The continuum number starts at the second character.
• u — sets the unit number that limits the domain of message issuance. The unit number starts at the second character.
• m — sets the module number that subsequent messages get sent to. The module number starts at the second character.
• . — terminates amsshell 👋

If the first character of a line is none of the above, the whole line counts as message text and gets issued right away, on the previously set subject, to the previously set module (if one was set), and inside the previously set domain (if one was set) ✨

By default, amsshell runs in "publish" mode, so each message is simply published. You can override that by giving a fifth command-line argument, a "mode" indicator 🌈 The modes are:

• p — "publish" mode. Every message is published.
• s — "send" mode. Every message is sent privately to the application module identified by the specified module, unit, and continuum numbers.
• q — "query" mode. Every message is sent privately to the application module identified by the specified module, unit, and continuum numbers, and then amsshell waits for a reply message before it continues 🙈
• a — "announce" mode. Every message is announced to all modules in the domain established by the previously specified role, unit, and continuum numbers.

👑 EXIT STATUS 👑

• -1 — amsshell ended with an error, which you can look up in the ion.log file 💀
• "0" — amsshell ended normally 💖

📁 FILES 📁

You need a MIB initialization file with the applicable default name (check out amsrc(5)) or things won't work 🥺

🌈 ENVIRONMENT 🌈

No environment variables apply. Zero env vars, zero drama ✨

🚨 DIAGNOSTICS 🚨

• amsshell can't register. — amsshell failed to register, and the reason is noted in the ion.log file 😭
• amsshell can't set event manager. — amsshell failed to start its background thread, and the reason is noted in the ion.log file 💀

🐛 BUGS 🐛

Report bugs to <ion-bugs@korgano.eecs.ohiou.edu> 🙈

🔗 SEE ALSO 🔗

• amslog(1)
• amsrc(5)

---

That's the whole manual, bestie 🦋 it's stamped perl v5.24.1 and dated 2016-07-07, and it's still giving 🌸 stay iconic 💖