aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-10-14 02:37:02 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-10-14 02:37:02 +1300
commit4f74ecbe12f6cdef30795374c3cba176cc29c595 (patch)
tree995cc99db80b0827301d6c8aea8efb39155317fc
parentPerl::Tidy run over bin/runcrypt (diff)
downloadMail-Run-Crypt-4f74ecbe12f6cdef30795374c3cba176cc29c595.tar.gz
Mail-Run-Crypt-4f74ecbe12f6cdef30795374c3cba176cc29c595.zip
Make SYNOPSIS more useful/complete
-rw-r--r--README.markdown10
-rw-r--r--lib/Mail/Run/Crypt.pm10
2 files changed, 18 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown
index 8d9187d..5327928 100644
--- a/README.markdown
+++ b/README.markdown
@@ -26,12 +26,20 @@ via environment variables or command-line options.
# SYNOPSIS
+ use Mail::Run::Crypt;
+ ...
my $mrc = Mail::Run::Crypt->new(
+ mailto => 'you@example.net',
+ );
+ $mrc->run($command, @args);
+ ...
+ my $mrc = Mail::Run::Crypt->new(
+ sign => 1,
keyid => 0x1234DEAD,
passphrase => 'able was i ere i saw elba',
mailto => 'you@example.net',
);
- $mrc->run(qw(rsync -a /mnt/a/ remote:mnt/b));
+ $mrc->run($command, @args);
# SUBROUTINES/METHODS
diff --git a/lib/Mail/Run/Crypt.pm b/lib/Mail/Run/Crypt.pm
index 5dc148a..5631acb 100644
--- a/lib/Mail/Run/Crypt.pm
+++ b/lib/Mail/Run/Crypt.pm
@@ -157,12 +157,20 @@ via environment variables or command-line options.
=head1 SYNOPSIS
+ use Mail::Run::Crypt;
+ ...
my $mrc = Mail::Run::Crypt->new(
+ mailto => 'you@example.net',
+ );
+ $mrc->run($command, @args);
+ ...
+ my $mrc = Mail::Run::Crypt->new(
+ sign => 1,
keyid => 0x1234DEAD,
passphrase => 'able was i ere i saw elba',
mailto => 'you@example.net',
);
- $mrc->run(qw(rsync -a /mnt/a/ remote:mnt/b));
+ $mrc->run($command, @args);
=head1 SUBROUTINES/METHODS