stl Manual


stl is a command line word count tool for projects. wc-track provides a more consistent interface for this word count functionality, and wraps the operation of stl. Use the stl module as a starting point for adding additional data collection modules to the stl system.


--help, -h

Returns a brief help message regarding available options and output.

--target <daemon>, -t <daemon>

For users that run multiple named emacs daemon instances, this option allows you to send the Sauron notification to a specific named instances. Chosen from a list of daemons defined in sauron.

If you do not modify the value of the emacs_daemon, stl will assume that your system only has one emacs instance running.

--project <name>, -p <name>

A simple, human digestible name for the project, used in notifiaction and logging output.

--directory <directory>, -d <directory>

The top-level path of the project. Used for word counting purposes.

--extension <extension>, -e <extension>

The extension of the project files. stl ignores all files with a different extension in the --directory. The default value is txt unless otherwise specified.

--quiet, -q

Suppress output on the command line. Disabled by default.

--force, -f

By default stl caches a copy of the word count for each project in the /tmp/stl/ directory. If you pass --force, stl will log and notify on all word-count events even if the value has not changed since the last time stl ran.

--logfile <path>, -l <path>

A path to the logfile. By default there is no logfile.


On the command line, an invocation of stl might resemble the following:

stl --project rhizome --directory ~/wikish/rhizome/ --extension mdwn --logfile ~/stl.log

Consider the following section from wc-track, that wraps stl:

import stl

stl.generate_events( project='rhizome',
                     extension='mdwn' )