scribo

Email-based phlog generator
git clone git://git.z3bra.org/scribo.git
Log | Files | Refs | README | LICENSE

README (1050B)


      1 scribo
      2 ======
      3 Email-based phlog generator.
      4 
      5 Publish gopher notes just by sending an email !
      6 
      7 scribo(1) is meant to be called by an SMTP daemon, preferably from an
      8 aliases(5), or forward(5) file. The emails are then passed to the
      9 program on STDIN, which will in turn write the log entry to the specified
     10 directory.
     11 
     12 The filename is derived from the "Subject" header, and timestamped at
     13 end of file, based on the "Date" header.
     14 
     15 Installation
     16 ------------
     17 Edit the `config.mk` file to match your setup, then run the following:
     18 
     19 	$ make
     20 	# make install
     21 
     22 Usage
     23 -----
     24 Refer to the scribo(1) and aliases(5) manpage for details and examples.
     25 The below commands are provided as a quick introduction.
     26 
     27 Add the following to you aliases(5) file:
     28 
     29 	note@domain.tld |/usr/local/bin/scribo -b /var/gopher
     30 
     31 Only process email sent from a specific address:
     32 
     33 	scribo -a author@domain.tld
     34 
     35 Pipe the body of your messages through a command before writing them:
     36 
     37 	scribo -x "fmt -s -w 72"
     38 
     39 License
     40 -------
     41 ISC License. See LICENSE file for copyright and license details.