add sample configs and manpage

1 files changed, 29 insertions, 84 deletions

diff --git a/README.pod b/README.pod
index 65625e3..6f7bc71 100644
--- a/README.pod
+++ b/README.pod
@@ -1,114 +1,59 @@
 =head1 NAME
 
-muttdelay - A muttdelay project
+muttdelay - A bash script to delay mails written via mutt
 
 =head1 WTF?
 
-You may use this project in order to build your own Debian package for your own project. This has been tested with Debian GNU/Linux Squeeze and Debian GNU/Linux Wheezy. 
+This is for scheduling the sending of mails for a specific future time. Unlinke postponing a mail which does not involve the scheduling.
 
-Feel free to modify any aspects. This project is just an empty example muttdelay.
+=head2 How it works
 
-Follow these steps:
+=head3 Configuring Vim
 
-=head2 Install required packages
+Do the following:
 
-Run the following:
+    cp /usr/share/muttdelay/muttdelay.vim ~/.vim/plugin/
+    echo 'map ,L :call MuttDelay()<CR>' >> ~/.vimrc
 
-    sudo aptitude install lintian devscripts dpkg-dev make perl
+=head3 Configuring CRON
 
-Todo: Ensure this are the correct packages. In order to test that I would have to setup a blank Debian system.
+And create an hourly cronjob such as:
 
-=head2 Compile the project
+    0 * * * * /usr/bin/muttdelay cron
 
-Go to the to level directory and run
+=head3 Configuring msmtp
 
-    make
+For example like this (change your configuration accordingly to fit your needs):
 
-To test run
+    cp /usr/share/muttdelay/msmtprc.example  ~/.msmtprc
+    vim ~/.msmtprc
 
-    ./bin/muttdelay
+And ensure that you can send mails like this:
 
-It should print out the version number of the project.
+    msmtp your@address.example.com <<< Hallo
 
-=head2 Create a Debian package
+If it works, you can go on
 
-Go to the to level directory and run
+=head3 Use it
 
-    make deb
+Open mutt, compose an email. Use Vim as your editor. After finishing writing your mail don't close Vim, but run
 
-It will create the files like:
+    ,L
 
-    ../muttdelay_0.0.0.0_all.deb
-    ../muttdelay_0.0.0.0.dsc
-    ../muttdelay_0.0.0.0_amd64.changes
-    ../muttdelay_0.0.0.0.tar.gz
+and the mail gets scheduled for sending for a later time. You can now leave vim without sending the mail via mutt directly.
 
-It should create a debian package in ../. Check and install it, e.g:
+The mail tself is saved to
 
-    lintian --pedantic ../muttdelay_0.0.0.0_all.deb 
-    sudo dpkg -i ../muttdelay_0.0.0.0_all.deb 
+    ~/.muttdelay/SENDTIMESTAMP.COMPOSETIMESTAMP
 
-Run 
+The cron job checks if there is any SENDTIMESTAMP lower than the current unix time stamp. And if so, all matching mails are sent.
 
-    dpkg -L muttdelay
+=head1 LICENSE
 
-to see whats in there. You can now run
+See package description or project website.
 
-    /usr/bin/muttdelay
+=head1 AUTHOR
 
-or for example
+Paul C. Buetow - <http://muttdelay.buetow.org>
 
-    man muttdelay
-
-=head2 Read the Makefile
-
-Read the Makefile in order to understand what's going on.
-
-=head1 Customize
-
-Now, since you understood everything feel free to customize everything the way you want it. E.g.: 
-
-    Don't use POD for documentation but LaTeX
-
-    Compile a C program
-
-    Include a ./lib dir, add it to the 'install' Makefile rule
-
-    etc etc.
-
-You should also consider the following:
-
-=head2 Manual page
-
-This muttdelay is using POD for creating manual pages. Edit ./docs/muttdelay.pod and run 
-
-    make documentation
-
-in order to build ./docs/muttdelay.1. The page will be included in the resulting debian package automatically. You can review the page with
-
-    man ./docs/muttdelay.1
-
-=head2 Renaming muttdelay into your project name 
-
-Rename all files which have *muttdelay* included into your own new package name. You can do that with:
-
-    PROJECTNAME=yourproject
-    find . -name \*muttdelay\* | 
-    while read muttdelay; do git mv $muttdelay ${muttdelay/muttdelay/$PROJECTNAME}; done
-
-Search all content and rename *muttdelay* into your own new package name. You can do that with:
-
-    grep -R muttdelay . | grep -v .git | 
-    cut -d: -f1 | uniq | xargs sed -i "s/muttdelay/$PROJECTNAME/g"  
-
-=head2 Updating ./debian
-
-Edit the following files accordingly to your new project (e.g. with vim):
-
-    vim ./debian/{control,copyright,README}
-
-=head2 Update changelog
-
-Go to the to level directory and run
-
-    dch -i
+=cut