rmsgen

Synopsis

This is a set of scripts useful for the generation of political notes.

Usage

Setup Config File

Create the default directory structure:

mkdir ~/.rmsgen
touch ~/.rmsgen/config.yml

The configuration file will take multiple options. The following options are available for use.

Config Options

Local Storage

Use email_dir to set the local directory that RMS emails are sent to.

Note: Do not use email_dir if you are reading polnotes from an IMAP server.

 # example
 email_dir:  /home/uname/mail/rms

IMAP

Use the following IMAP options for logging into an IMAP server:

• imap_server - the address of an IMAP server
• imap_login - the login for an IMAP server

• imap_password - the password for an IMAP server

  # example
  imap_server: mail.example.com
  imap_login: abc123
  imap_password: rainbowsandunicorns
  

Output File

Use output_file to set the file that the polnote html source is written to.

Note: path must be absolute.

# example
output_file: /home/uname/polnotes.html

Run rmsgen to iterate all messages in inbox

$ rmsgen

For each note, rmsgen will promp you for different types of input.