ESTMASTER(1)

πŸ“¦ version 1.4.13, in fedora 43, fedora 44

πŸ’– ESTMASTER β€” the master process of node servers πŸ’–

okay bestie, welcome to the ESTMASTER(1) page from the Hyper Estraier manual, dated way back but still iconic. this is the boss-level command, the main character of the whole node-server situation. let's get into it 🫢


✨ NAME ✨

estmaster β€” master process of node servers

like, it literally runs the node servers. that's the whole job. πŸ‘‘


🌸 SYNOPSIS 🌸

estmaster init [-ex] rootdir

estmaster start [-bg] [-ro] [-st] rootdir

estmaster stop rootdir

estmaster unittest rootdir

estmaster crypt key [hash]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the tea: estmaster isn't just one command, it's an aggregation of sub commands. like a whole squad in one binary. πŸ’…

the first argument you give it is the name of the sub command, and everything after that gets parsed according to whichever sub command you picked. no cap.

and rootdir? that's the server root directory β€” it's the folder holding the configuration file and so on. everything lives in there. it's the home base. 🏠

estmaster init [-ex] rootdir

creates the server root directory, bestie. brand new. fresh start. ✨

  • if -ex is specified, some users and some nodes get set up, like, for example purposes.
  • by default though? only a super user is set, and their name and password are both "admin". that's it. just the one.
ngl, please change that default password, it's giving "hunter2" energy πŸ’€

estmaster start [-bg] [-ro] [-st] rootdir

starts the node master. this is the moment. the main character moment. πŸ”₯

  • if -bg is specified, the server runs in background as a daemon process. it just vibes quietly in the back, doing its thing.
  • if -ro is specified, the server runs in read-only mode regardless of the configuration. like, it's not taking notes today, only reading. πŸ™ˆ
  • if -st is specified, the server runs in single thread mode.

estmaster stop rootdir

stops the running node master. bye bestie, it was real. πŸ‘‹

estmaster unittest rootdir

performs unit tests. yes she tests herself, that's self-care. πŸŽ€

estmaster crypt key [hash]

outputs an encrypted string of a string. ✨

  • key specifies the target string.
  • if hash is specified, it checks whether the key and the hash match. lowkey a vibe check. πŸ”

🌈 THE IMPORTANT DEETS 🌈

all sub commands return 0 if the operation is a success, else they return 1. simple as that, fr fr.

a running node master finishes with closing the database when it catches the signal 1 (SIGHUP), 2 (SIGINT), 3 (SIGQUIT), or 15 (SIGTERM). it cleans up after itself, we love to see it. πŸ’–

moreover β€” and this is the fun part β€” when a node master running as a daemon catches the signal 1 (SIGHUP), the process is re-start and re-read the configuration files. like a little glow-up where it picks up your new config. πŸ”„βœ¨

⚠️ okay this next bit is serious, bestie. a running node server should be finished by valid means β€” either by command line or via network. otherwise, the index may be broken. do not just yolo-kill it. i'm so serious. the index does not deserve that. 😭

πŸ‘‘ SEE ALSO πŸ‘‘

please see http://hyperestraier.sourceforge.net/nguide-en.html for detail. πŸ’œ


and that's the whole page, gorgeous. this came out of the Hyper Estraier manual, dated 2007-03-06, and the man page itself is the ESTMASTER(1) one. slay, periodt. πŸ’…πŸŒΈβœ¨

πŸ“¦ where this page comes from