From 7bda155b251ed51ae12efffa40d0aaa85380fa90 Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sat, 14 Oct 2017 02:25:52 +1300 Subject: Update README.markdown --- README.markdown | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.markdown b/README.markdown index 269b19a..305e924 100644 --- a/README.markdown +++ b/README.markdown @@ -14,11 +14,11 @@ error content, it is mailed (each stream separately) to a specified recipient address. The idea is to allow you to view the output of automated commands while having -the content encrypted as it passes through to your mailserver, and have some -assurance that the content was actually generated by the server concerned. -`cron(8)` scripts are the ideal use case, but this would also with `at(1)` or -anything else that might non-interactively run jobs for which output is -significant. +the content encrypted as it passes through to your mailserver, and (optionally) +have some assurance that the content was actually generated by the server +concerned. `cron(8)` scripts are the ideal use case, but this would also work +with `at(1)` or anything else that might non-interactively run jobs for which +output is significant. You probably want to call this with the `runcrypt(1)` program installed by this distribution, which provides a means to set the properties for the module @@ -28,7 +28,7 @@ via environment variables or command-line options. my $mrc = Mail::Run::Crypt->new( keyid => 0x1234DEAD, - passphrase => 'extremely_insecure', + passphrase => 'able was i ere i saw elba', mailto => 'you@example.net', ); $mrc->run(qw(rsync -a /mnt/a/ remote:mnt/b)); @@ -78,9 +78,22 @@ has been successfully run. # DIAGNOSTICS -- %s required +- mailto required - One of the required properties was not passed to the constructor. + The required `mailto` property was not passed in the constructor. + +- keyid required for signing + + Signing was specified, but no `keyid` attribute was passed in the constructor. + +- passphrase required for signing + + Signing was specified, but no `passphrase` attribute was passed in the constructor. + +- command failed: %s + + The command did not merely fail, it could not even be started, with the given + error string. This is typically due to problems finding the executable. # CONFIGURATION AND ENVIRONMENT -- cgit v1.2.3