Minimalist Online Docmentation

The interpreter

Now that you've created your source directory and some source files, you're ready to use the mod2html program to convert them to HTML and install them at your destination.

Usage: mod2html source_directory

Especially when you're running mod2html on a new source tree, you'll probably want to add the "-v" option (before the source directory) to get some debug output, and verify that it's doing what you want.

The first time you run mod2html, it will need to set up some control files in your source directory. It will ask you a couple questions, and then it will create a .mod/ direcotory in your source directory that will be used to store information about that particular source tree. For the most part, you can just ignore this directory. If it gets deleted or corrupted, mod2html will recover as best as it can, and recreate it.

  dog_site/                 <-- source directory
    |
    +- .mod/                <-- created the first time you run mod2html
    |   +- config           <-- config file for this tree
    |   +- default.tmpl     <-- default template for this tree
    |   +- status/          <-- keeps track of what has been updated (ignore)
    |       ...
    |
    +- index.mod            <-- the source files you created
    +- breeds/                  ...
    |   |
    |   +- retriever.mod
   ...

Each time you run mod2html it will reread the config file, scan your source directory, and determine which files have changed since the last run. It will then update the destination files appropriately.

You can find more info on the mod2html command and its various options in the reference section.