Available programs and scripts
sc-input-usfm
Program sc-input-usfm nearly always forms the beginning of a checking
session. It reads one or more USFM files to be checked, and it pipes its
output to the actal checking script. For example:
sc-input-usfm Genesis.usfm | <here follows another checking program>
For more information run the program without arguments.
sc-check-usfm
sc-check-usfm reads the USFM file given as an argument on the commandline.
It performs checks related to the USFM standard, that are not done
elsewhere, due to sc-input-usfm that hides certain USFM specific
information.
For more information, run: sc-check-usfm --help
sc-versification
sc-versification provides versification information on stdout.
For more information run the program without arguments.
sc-chapters-verses
sc-chapters-verses reads checking units from stdin, checks whether the
chapters and the verses are correct, and outputs its report on stdout.
For more information run the program without arguments.
Example: To check chapters and verses in file John.usfm, execute this command:
sc-input-usfm John.usfm | sc-chapters-verses --versification English
sc-count-usfm
Counts USFMs in all the files given on the commandline, and gives a
report in XML format. Sorting is possible. Run the program without
arguments for more information.
sc-compare-usfm
Compare the USFMs in the two input files given, and reports any
differences found. For full information about the usage of this check,
run it without arguments.
sc-message
Gives the message on the commandline as XML output. For full information run it without arguments.
sc-count-characters
Count the number of characters in the data it receives. For more information run the program without arguments.
Example: To count characters in Matthew.usfm and John.usfm, execute this command:
sc-input-usfm Matthew.usfm John.usfm | sc-count-characters
sc-capitalization
Checks capitalization of words in the text. For more information run the program without arguments.
sc-repetition
Checks repeating contiguous words in the text. For more information run sc-repetition --help.
sc-matching-pairs
Checks pairs of punctuation, like < and >, and [ and ], are matched. For more information run sc-matching-pairs --help.
sc-unwanted-patterns
Checks for unwanted sequences of characters. For more information run sc-unwanted-patterns without arguments.
sc-unwanted-words
Checks for unwanted words. For more information run sc-unwanted-patterns without arguments.
sc-xml2asc
Converts from UTF8 (with or without &#-escapes) to ASCII, inserting
&#-escapes for all non-ASCII characters. Usage: xml2asc < infile
> outfile
sc-mapping
sc-mapping provides verse mapping information on stdout.
For more information run the program without arguments.