]>
Commit | Line | Data |
---|---|---|
2f9e679a MG |
1 | #!/usr/bin/perl -w |
2 | use v5.14; | |
3 | use App::EdwardNG; | |
4 | ||
5 | App::EdwardNG->run; | |
6 | ||
7 | __END__ | |
8 | ||
9 | =encoding utf-8 | |
10 | ||
11 | =head1 NAME | |
12 | ||
13 | edwardng - GnuPG email sign/encrypt testing bot | |
14 | ||
15 | =head1 SYNOPSIS | |
16 | ||
b65d8486 | 17 | Manually: |
2f9e679a | 18 | |
b65d8486 MG |
19 | edwardng --from=edwardng@example.org --key=12345678 < mail.eml |
20 | ||
21 | In F</etc/aliases>: | |
22 | ||
8cf8d328 | 23 | edwardng: |edwardng --from=edwardng@example.org --key=12345678 --keydir=/srv/edwardng-keydir --debug --logfile=/var/log/edwardng |
2f9e679a MG |
24 | |
25 | =head1 DESCRIPTION | |
26 | ||
27 | EdwardNG is a reimplementation of the Edward reply bot referenced in L<https://emailselfdefense.fsf.org/>. | |
28 | ||
b65d8486 | 29 | It reads an email from STDIN, checks it for PGP signatures and encryption, then replies appropriately. |
2f9e679a MG |
30 | |
31 | =head1 OPTIONS | |
32 | ||
33 | =over | |
34 | ||
35 | =item B<--always-trust>, B<--no-always-trust> | |
36 | ||
37 | If B<--always-trust>, skip key validation and assume that used keys are always fully trusted. See the gpg(1) manpage, option C<--trust-model always> for more information. Defaults to B<--no-always-trust>. | |
38 | ||
39 | =item B<--debug>, B<--no-debug> | |
40 | ||
41 | If B<--debug>, output some debugging information on STDERR. Defaults to B<--no-debug> | |
42 | ||
43 | =item B<--from>=I<address> | |
44 | ||
45 | Mail address to send messages from. | |
46 | ||
47 | =item B<--key>=I<keyid> | |
48 | ||
49 | ID of key used for encrypting replies. | |
50 | ||
51 | =item B<--keydir>=I</path/to/keydir> | |
52 | ||
53 | Path to GnuPG homedir. | |
54 | ||
8cf8d328 MG |
55 | =item B<--logfile>=I</path/to/logfile> |
56 | ||
57 | If B<--debug>, append debug information to this file. Ignored if B<--no-debug>. | |
58 | ||
2f9e679a MG |
59 | =item B<--passphrase>=I<passphrase> |
60 | ||
61 | Private key passphrase. | |
62 | ||
b2664811 MG |
63 | =item B<--tmpl-path>=I<path> |
64 | ||
65 | Path to the template directory. Users of the default templates can select the language with this argument. Available languages: en. Defaults to B<--tmpl-path=en>. | |
66 | ||
2f9e679a MG |
67 | =item B<--use-agent>, B<--no-use-agent> |
68 | ||
69 | If B<--use-agent>, use L<gpg-agent(1)>. Defaults to B<--no-gpg-agent>. | |
70 | ||
71 | =back | |
72 | ||
73 | =head1 ENVIRONMENT | |
74 | ||
75 | Configuration can also be done via the environment. Use 1 for true and 0 for false. Command-line options override environment variables. | |
76 | ||
77 | =over | |
78 | ||
79 | =item EDWARDNG_ALWAYS_TRUST | |
80 | ||
81 | Corresponds to B<--always-trust> (if true) and B<--no-always-trust> (if false). | |
82 | ||
83 | =item EDWARDNG_DEBUG | |
84 | ||
85 | Corresponds to B<--debug> (if true) and B<--no-debug> (if false). | |
86 | ||
87 | =item EDWARDNG_FROM | |
88 | ||
89 | Corresponds to B<--from>. | |
90 | ||
91 | =item EDWARDNG_KEY | |
92 | ||
93 | Corresponds to B<--key>. | |
94 | ||
95 | =item EDWARDNG_KEYDIR | |
96 | ||
97 | Corresponds to B<--keydir>. | |
98 | ||
8cf8d328 MG |
99 | =item EDWARDNG_LOGFILE |
100 | ||
101 | Corresponds to B<--logfile>. | |
102 | ||
2f9e679a MG |
103 | =item EDWARDNG_PASSPHRASE |
104 | ||
105 | Corresponds to B<--passphrase>. | |
106 | ||
b2664811 MG |
107 | =item EDWARDNG_TMPL_PATH |
108 | ||
109 | Corresponds to B<--tmpl-path>. | |
110 | ||
2f9e679a MG |
111 | =item EDWARDNG_USE_AGENT |
112 | ||
113 | Corresponds to B<--use-agent> (if true) and B<--no-use-agent> (if false). | |
114 | ||
115 | =back | |
116 | ||
117 | =head1 SEE ALSO | |
118 | ||
119 | L<App::EdwardNG> | |
120 | ||
121 | =head1 AUTHOR | |
122 | ||
123 | Marius Gavrilescu, E<lt>marius@ieval.roE<gt> | |
124 | ||
125 | =head1 COPYRIGHT AND LICENSE | |
126 | ||
1f08c352 | 127 | Copyright (C) 2014 by Fundația Ceata |
2f9e679a MG |
128 | |
129 | This library is free software; you can redistribute it and/or modify | |
130 | it under the same terms as Perl itself, either Perl version 5.18.2 or, | |
131 | at your option, any later version of Perl 5 you may have available. | |
132 | ||
133 | ||
134 | =cut |