1NFORENUM(1) BSD General Commands Manual NFORENUM(1)
2
4 NFORenum — A tool for checking NFO code for errors, and for beautifying
5 that code
6
8 nforenum [options] [file [file2 [file3 [...]]]]
9
11 --auto-correct | -a
12 Perform some rudimentary automatic correction of incorrect
13 pseudo sprites. This may be specified twice to enable the
14 corrections that are more likely to be incorrect. See the
15 README for detailed information on the auto-correcter.
16 --comments=type | -c type
18 <type> is one character, either /, ;, or #, and specifies the
19 comment style that NFORenum will use. This will not change
20 the header, because grfcodec requires that the header be com‐
21 mented in C++-style.
22 --data[=dir] | -D[dir]
24 If <dir> is specified, look for the .nforenum directory in
25 <dir>, and create it if not found.
26 If <dir> is not specified, report the location of the
28 .nforenum directory. In either case, eliminate the 5-second
29 wait used to ensure that those not running NFORenum from a
30 command line can see the directory-created message.
31 Default: Look for the .nforenum directory in the current
33 directory, and then in the environment variable HOME, if
34 defined. If not found attempt to create in HOME, then in .
35 --force | -f
37 Forces processing of files that do not look like NFO files.
38 The default is to treat such files as if they specified a
39 too-high info version.
40 --help | -h
42 Display the help message.
43 --lock Locks the current comment command state. Commands will con‐
45 tinue to be parsed as normal (so NOPRESERVE will be honored,
46 @@DIFF will be removed, &c.) but their changes (such as turn‐
47 ing on the diff-assister) will not be honored.
48 --no-replace | --keep-old | -k
50 Do not replace the old NFO file; write new file to
51 file.new.nfo. Default: Use file[.nfo].new as temporary,
52 rename it to file[.nfo] when done.
53 --silent | -s
55 Silence the progress output in interactive mode.
56 --version | -v
58 Display the version.
59 --write-data
61 Refresh all data files, unless they are newer.
62 The following options cause NFORenum to behave as if all files started
63 with the associated command. The readme has full details on the comment
64 commands. Options associated with comment commands that require addi‐
65 tional information take that information as an argument. With the excep‐
66 tion of -L/--let, the options to the command line versions are case
67 insensitive. "ON" and "OFF" may be specified with "+" and "-", respec‐
68 tively.
69 --beautify | -b @@BEAUTIFY
71 --diff | -d @@DIFF
73 --let | -L @@LET
75 --lint | -l @@LINT
77 --preserve-messages | -p @@PRESERVEMESSAGES
79 --real-sprites | -r @@REALSPRITES
81 --use-old-nums | -o @@USEOLDSPRITENUMS
83 --warning-disable | -w @@WARNING DISABLE
85 --warning-enable | -W @@WARNING ENABLE
87 -w and -W (and their long counterparts) also accept a comma-separated
88 list of messages, all of which will be ENABLEd or DISABLEd.
89
91 The documentation in /usr/share/doc/nforenum/
92
94 nforenum was written by Dale McCoy, with portions by Dan Masek, Thijs
95 Marinussen, Remko Bijker and Christoph Elsenhans.
96 This manual page was written by Remko Bijker.
98 August 05, 2010