updated pod

2025-12-17 03:50:57 +01:00 · 2014-02-07 11:55:44 +01:00
parent 181c5ddac4
commit 7f4bccfaff
9 changed files with 265 additions and 20 deletions
--- a/man/details.pod
+++ b/man/details.pod
@@ -1,4 +1,3 @@
-# -*-perl-*-

 =head1 PCP1 KEYS

@@ -153,11 +152,84 @@ encrypted file without a signature, decryption will fail as well.>

 Note: this behavior might change in the future.

-=head1 VULNERABILITIES
+=head1 ALTERNATIVE COMMANDLINES

-Currently there are a couple of problems which are not
-addressed. These are usually protocol problems, which are
-not caused by pcp1.
+You can save typing if you supply additional arguments to
+pcp after commandline options. Such arguments are treated
+as filenames or recipients, depending what options you already
+specified.
+
+Here is a list of commandlines and their possible alternatives:
+
+ ORIGINAL                    ALTERNATIVE               DESCRIPTION
+
+ pcp -e -I message -r Bob    pcp -e -r Bob message     use 'message' as inputfile.
+                             pcp -e -I message Bob     use 'Bob' as recipient,
+                                                       multiple recipients supported.
+
+ pcp -d -I crypted           pcp -d crypted            use 'crypted' as inputfile.
+
+ pcp -g -I message           pcp -g message            use 'message' as inputfile.
+
+ pcp -g -I msg -O sig        pcp -g -I msg sig         use 'sig' as outputfile.
+
+ pcp -p -O key.pcp           pcp -p key.pcp            use 'key.pcp' as outputfile.
+
+ pcp -p -O key.pcp -r Bob    pcp -p -O key.pcp Bob     use 'Bob' as recipient.
+
+ pcp -s -O key.pcp           pcp -s key.pcp            use 'key.pcp' as outputfile.
+
+ pcp -s -O key.pcp -r Bob    pcp -s -O key.pcp Bob     use 'Bob' as recipient.
+
+ pcp -P -I alice.pcp         pcp -P alice.pcp          use 'alice.pcp' as inputfile.
+
+ pcp -S -I alice.pcp         pcp -S alice.pcp          use 'alice.pcp' as inputfile.
+
+
+=head1 ENVIRONMENT VARIABLES
+
+pcp respects the following environment variables:
+
+=over
+
+=item B<PCP_VAULT>
+
+Use an alternative vaultfile. The default is B<~/.pcpvault> and
+can be overridden with the B<-V> commandline option. If PCP_VAULT
+is set, this one will be used instead.
+
+=item B<PCP_DEBUG>
+
+Enable debugging output, where supported. Same as B<-D>.
+
+=back
+
+=head1 EXIT STATUS
+
+Pcp may return one of several error codes if it encounters problems.
+
+=over
+
+=item 0   No problems occurred.
+
+=item 1   Generic error code.
+
+=back
+
+=head1 FILES
+
+=over
+
+=item B<~/.pcpvault>
+
+Default vault file where all keys are stored.
+
+=back
+
+=head1 EXPERIMENTAL STATUS
+
+Currently there are a couple of problems which are currently
+unsolved or in the process to be solved.

 =over

@@ -523,4 +595,5 @@ outlined above into account>.
 PCP tries to be fully compatible with PBP (https://github.com/stef/pbp). Encrypted
 files and signatures - at least their binary versions - should be exchangable. However,
 this is a work in progress and might not work under all circumstances. Also there's currently
-no shared key format between pbp and pcp.
+no shared key format between pbp and pcp. However, it is possible to export and
+import pbp keys from/to pcp.
--- a/man/footer.pod
+++ b/man/footer.pod
@@ -1,7 +1,7 @@

 =head1 COPYRIGHT

-Copyright (c) 2013 by T.Linden <tom AT cpan DOT org>
+Copyright (c) 2013-2014 by T.v.Dein <tom AT vondein DOT org>

 =head1 ADDITIONAL COPYRIGHTS

@@ -40,7 +40,7 @@ under the B<GPL> as well.

 =head1 AUTHORS

-I<T.Linden <tom AT cpan DOT org>>
+I<T.v.Dein <tom AT vondein DOT org>>

 =head1 LICENSE

--- a/man/pcp1.pod
+++ b/man/pcp1.pod
@@ -11,6 +11,7 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography.
              [ --export-public | --export-secret | --import-public | --import-secret ]
              [ --encrypt       | --decrypt ]
              [ --sign          | --check-signature ]
+              [ arguments ]
  
  General Options:
  -h --help                 Print this help message.
@@ -47,6 +48,11 @@ Pretty Curved Privacy - File encryption using eliptic curve cryptography.
  
  Encoding Options:
  -z --z85-encode           Armor with Z85 encoding.
+  
+  Arguments:
+  Extra arguments after options are treated as filenames or
+  recipients, depending on operation mode.
+  
 =head1 OPTIONS
 
 Usage: pcp1 [options]
@@ -235,7 +241,6 @@ Oh - and if you're wondering why I named them Alicia and Bobby:
 I was just sick of Alice and Bob. We're running NSA-free, so we're
 using other sample names as well.

-# -*-perl-*-

 =head1 PCP1 KEYS

@@ -390,11 +395,84 @@ encrypted file without a signature, decryption will fail as well.>

 Note: this behavior might change in the future.

-=head1 VULNERABILITIES
+=head1 ALTERNATIVE COMMANDLINES

-Currently there are a couple of problems which are not
-addressed. These are usually protocol problems, which are
-not caused by pcp1.
+You can save typing if you supply additional arguments to
+pcp after commandline options. Such arguments are treated
+as filenames or recipients, depending what options you already
+specified.
+
+Here is a list of commandlines and their possible alternatives:
+
+ ORIGINAL                    ALTERNATIVE               DESCRIPTION
+
+ pcp -e -I message -r Bob    pcp -e -r Bob message     use 'message' as inputfile.
+                             pcp -e -I message Bob     use 'Bob' as recipient,
+                                                       multiple recipients supported.
+
+ pcp -d -I crypted           pcp -d crypted            use 'crypted' as inputfile.
+
+ pcp -g -I message           pcp -g message            use 'message' as inputfile.
+
+ pcp -g -I msg -O sig        pcp -g -I msg sig         use 'sig' as outputfile.
+
+ pcp -p -O key.pcp           pcp -p key.pcp            use 'key.pcp' as outputfile.
+
+ pcp -p -O key.pcp -r Bob    pcp -p -O key.pcp Bob     use 'Bob' as recipient.
+
+ pcp -s -O key.pcp           pcp -s key.pcp            use 'key.pcp' as outputfile.
+
+ pcp -s -O key.pcp -r Bob    pcp -s -O key.pcp Bob     use 'Bob' as recipient.
+
+ pcp -P -I alice.pcp         pcp -P alice.pcp          use 'alice.pcp' as inputfile.
+
+ pcp -S -I alice.pcp         pcp -S alice.pcp          use 'alice.pcp' as inputfile.
+
+
+=head1 ENVIRONMENT VARIABLES
+
+pcp respects the following environment variables:
+
+=over
+
+=item B<PCP_VAULT>
+
+Use an alternative vaultfile. The default is B<~/.pcpvault> and
+can be overridden with the B<-V> commandline option. If PCP_VAULT
+is set, this one will be used instead.
+
+=item B<PCP_DEBUG>
+
+Enable debugging output, where supported. Same as B<-D>.
+
+=back
+
+=head1 EXIT STATUS
+
+Pcp may return one of several error codes if it encounters problems.
+
+=over
+
+=item 0   No problems occurred.
+
+=item 1   Generic error code.
+
+=back
+
+=head1 FILES
+
+=over
+
+=item B<~/.pcpvault>
+
+Default vault file where all keys are stored.
+
+=back
+
+=head1 EXPERIMENTAL STATUS
+
+Currently there are a couple of problems which are currently
+unsolved or in the process to be solved.

 =over

@@ -760,11 +838,12 @@ outlined above into account>.
 PCP tries to be fully compatible with PBP (https://github.com/stef/pbp). Encrypted
 files and signatures - at least their binary versions - should be exchangable. However,
 this is a work in progress and might not work under all circumstances. Also there's currently
-no shared key format between pbp and pcp.
+no shared key format between pbp and pcp. However, it is possible to export and
+import pbp keys from/to pcp.

 =head1 COPYRIGHT

-Copyright (c) 2013 by T.Linden <tom AT cpan DOT org>
+Copyright (c) 2013-2014 by T.v.Dein <tom AT vondein DOT org>

 =head1 ADDITIONAL COPYRIGHTS

@@ -803,7 +882,7 @@ under the B<GPL> as well.

 =head1 AUTHORS

-I<T.Linden <tom AT cpan DOT org>>
+I<T.v.Dein <tom AT vondein DOT org>>

 =head1 LICENSE