WORDGRINDER(1)

✨ WORDGRINDER(1) ✨

okay so bestie, welcome to wordgrinder — the manual page for the console-based word processor, aka the whole entire point of this doc 💖

🌸 NAME 🌸

wordgrinder — a console-based word processor, and yes she is exactly as iconic as she sounds 💅

🎀 SYNOPSIS 🎀

wordgrinder [options] [filename]

🦋 DESCRIPTION 🦋

okay so wordgrinder is a simple character cell word processor that runs on the console. she is primarily designed for text entry. the whole vibe is that she's designed to get the hell out of your way and let you write — she does very little, but what she does, she does well. periodt. 💅

she supports Unicode, basic paragraph styles, basic character styles, basic screen markup, a menu interface that means you don't have to remember complex key sequences (thank god honestly), HTML import and export, and some other useful features. lowkey stacked for something so chill 🫶

when running, pressing ESC (or ALT + the menu shortcut key) will open the menu. no cap, that's the whole thing ✨

💖 OPTIONS 💖

these options follow the usual GNU command line syntax, with long options starting with two dashes (-). iykyk 🌈

• -h, --help — shows a summary of options. the "bestie just tell me what to do" button 🫶
• --lua filename — loads and executes a Lua file instead of starting normally. main character energy, she's doing something else instead 🧚
• --convert srcfile destfile — converts from srcfile to destfile and then exits. 💫

the type of the file is autodetected from the extension of the filename. the source file may have a document name suffixed with a : for use when importing or exporting WordGrinder files. 👑

• --config file.lua — sets the name of the user config file. your lil custom setup, obsessed 🎀

⭐ CONFIGURATION ⭐

the user config file is a Lua file which is loaded and executed before the program starts up. it defaults to:

~/.wordgrinder/startup.lua

👑 AUTHOR 👑

wordgrinder was written by David Given. http://cowlark.com/wordgrinder

and that's the whole page bestie, version 0.8 of the WORDGRINDER(1) manual, dated however long ago this dropped — go forth and write your first draft, you absolute icon 🌸✨💖