The lexicon file is a text file that contains the words of your original language, one word on each line. You can include comments too. Comments are lines that will be ignored by the VSCA, so that you can include text in your lexicon files that will not be soundchanged. Comments start with a # An example lexicon file might look like this.
lector doctor focus jocus districtus civitatem adoptare opera secundus # Some Latin words # Original source: http://zompist.com/sounds.htm
In this example file, the last line is a comment. Obviously, comments can occur on any line, not just the last one.
Comments, spoken of which, can also be placed on lines that list a word. This is called an inline comment. You can use this to specify a definition for a word on the same line as the word itself. VSCA will not sound-change the comment and unless otherwise specified (see the command line switches, especially those dealing with the output template) they are sent to the output file too.
For example:
lector # school's boss doctor # person who heals opera # musical performance
Use the -l command line switch to specify your lexicon file.
Here lies the real power of VSCA, the ruleset file. In this file you define the soundchanges that you want to apply to your original words, as listed in the lexicon file. The idea is simple: one rule per line. Comments work the same in the lexicon file and in the ruleset file. An example ruleset file could look like this:
# Latin to Spanish # Variable declarations # Vowels V=aeiou # Consonants C=ptcqbdgmnlrhs # Front vowels F=ie # Back vowels B=ou # Voiceless sstops S=ptc # Voiced stops Z=bdg # And the changes s//_# m//_# e//Vr_# v//V_V u/o/_# [gn]/[nh]/_ S/Z/V_V c/i/F_t c/u/B_t p//V_t [ii]/i/_ e//C_rV # Original source: http://zompist.com/sounds.htm
You see how comments are throughout the entire ruleset file. This is useful to explain what you are doing in a language you prefer. VSCA's language is not very difficult, but it's (hopefully) not your first language, and just reading things in English might be easier for you as rulesets get more and more complext.
Use the -r command line switch to specify your ruleset file.
The output file is the file where VSCA will write the words after they have gone through all sound changes. It is not necessary to specify an output file - if you omit it, VSCA will write output to the terminal. The output file will look like this if you used the above examples:
leitor doutor fogo jogo distrito cidade adotar obra segundo # Some Latin words # Original source: http://zompist.com/sounds.htm
Use the -o command line switch to specify your ruleset file, and the -c switch if you wish to send output to both the file and the terminal.
VSCA - Anything. Anywhere. Anytime