Gemini Wiki Control

This script helps you maintain your Gemini Wiki installation.

Options

--wiki_dir=./wiki

This the wiki data directory to use; the default is either the value of the GEMINI_WIKI_DATA_DIR environment variable, or the ./wiki subdirectory. Use it to specify a space, too.

--log=4

This is the log level to use. 1 only prints errors; 2 also prints warnings (this is the default); 3 prints any kind of information; 4 prints all sorts of info the developer wanted to see as they were fixing bugs.

Commands

help

This is what you're reading right now.

update-changes

This command looks at all the pages in the page directory and generates new entries for your changes log into changes.log.

erase-page

This command removes pages from the page directory, removes all the kept revisions in the keep directory, and all the mentions in the change.log. Use this if spammers and vandals created page names you want to eliminate.

html-export [--source=subdirectory ...] [--target=directory] [--no-extension]

This command converts all the pages in the subdirectories provided to HTML and writes the HTML files into the target directory. The subdirectories must exist inside your wiki data directory. The default wiki data directory is wiki and the default source subdirectory is undefined, so the actual files to be processed are wiki/page/*.gmi; if you're using virtual hosting, the subdirectory might be your host name; if you're using spaces, those need to be appended as well.

Example:

phoebe-ctl html-export --wiki_dir=/home/alex/phoebe \
  --source=transjovian.org \
  --source=transjovian.org/phoebe \
  --source=transjovian.org/gemini \
  --source=transjovian.org/titan \
  --target=/home/alex/transjovian.org

This will create HTML files in /home/alex/transjovian.org, /home/alex/transjovian.org/phoebe, /home/alex/transjovian.org/gemini, and /home/alex/transjovian.org/titan.

Note that the links in these HTML do not include the .html extension, so this relies on your web server doing the right thing: if you request /foo it must serve foo.html in the document root. If that doesn't work, perhaps using --no-extension is your best bet: the HTML files will be written without the .html extension.