NFORENUM(1)

💖 NFORENUM(1) 💖

okay bestie, sit down, hydrate, because today we're talking about NFORenum — the little tool that checks your NFO code for errors and beautifies it. yes. both. it's giving glow-up AND proofreading, we love a multitasking icon ✨

🌸 SYNOPSIS 🌸

nforenum [options] [file [file2 [file3 [...]]]]

like, you can hand it one file, or three files, or honestly as many as your little heart desires 🫶

✨ OPTIONS ✨

• --auto-correct, -a — does some rudimentary automatic correction of incorrect pseudo sprites. and listen — you can specify this twice to unlock the corrections that are more likely to be incorrect. the README has the full tea on how the auto-correcter actually works, so go read it, i'm not gonna lie to you 💅
• --comments=type, -c type — type is one single character: either /, ;, or #. it tells NFORenum which comment style to use. but it will NOT change the header, because grfcodec requires the header to be commented in C++-style. that's just the rules, periodt 🔒
• --data[=dir], -D[dir] — if dir is specified, it looks for the .nforenum directory inside dir, and creates it if it's not found.

if dir is not specified, it reports the location of the .nforenum directory.

either way, it eliminates the 5-second wait that exists so that people not running NFORenum from a command line can actually see the directory-created message 👀

Default: look for the .nforenum directory in the current directory, and then in the environment variable HOME, if defined. if not found, attempt to create in HOME, then in ..

• --force, -f — forces processing of files that don't look like NFO files. the default behaviour is to treat those suspicious little files as if they specified a too-high info version 📈
• --help, -h — displays the help message. your bestie when you're lost 🧭
• --lock — locks the current comment command state. commands will continue to be parsed as normal (so NOPRESERVE will be honored, @@DIFF will be removed, &c.) but their changes (like turning on the diff-assister) will not be honored. it's the "i see you but i'm not listening" option 🙈
• --no-replace, --keep-old, -k — do not replace the old NFO file; write the new file to file.new.nfo.

Default: use file[.nfo].new as temporary, then rename it to file[.nfo] when done.

• --silent, -s — silences the progress output in interactive mode. quiet queen behaviour 🤫
• --version, -v — displays the version.
• --write-data — refreshes all data files, unless they are newer. if it's already fresh, we leave it alone 💅

the following options make NFORenum behave as if all files started with the associated command. the readme has the full details on the comment commands. options associated with comment commands that require additional information take that information as an argument. with the exception of -L/--let, the options to the command line versions are case insensitive. "ON" and "OFF" may be specified with + and -, respectively 👑

• --beautify, -b — @@BEAUTIFY
• --diff, -d — @@DIFF
• --let, -L — @@LET
• --lint, -l — @@LINT
• --preserve-messages, -p — @@PRESERVEMESSAGES
• --real-sprites, -r — @@REALSPRITES
• --use-old-nums, -o — @@USEOLDSPRITENUMS
• --warning-disable, -w — @@WARNING DISABLE
• --warning-enable, -W — @@WARNING ENABLE

also!! -w and -W (and their long counterparts) accept a comma-separated list of messages, and all of them will be ENABLEd or DISABLEd accordingly. bulk vibes only 🍓

🔍 SEE ALSO 🔍

the documentation in /usr/share/doc/nforenum/ — go read it, it's right there, i believe in you 📚

👑 AUTHOR 👑

nforenum was written by Dale McCoy, with portions by Dan Masek, Thijs Marinussen, Remko Bijker and Christoph Elsenhans.

this manual page was written by Remko Bijker.

and that's the whole page bestie!! August 05, 2010, and it's the NFORENUM(1) manual page 💖 thanks for reading, now go beautify some NFO files, mwah 🎀🦋