From 7756fbfe45180b55729d3d010ae9134394021a97 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Sat, 4 Sep 2021 16:08:15 +0000 Subject: [PATCH] doc: regenerate groff and html man pages --- doc/age-keygen.1 | 2 +- doc/age-keygen.1.html | 2 +- doc/age.1 | 14 +++++++++++++- doc/age.1.html | 22 +++++++++++++++++++++- 4 files changed, 36 insertions(+), 4 deletions(-) diff --git a/doc/age-keygen.1 b/doc/age-keygen.1 index 56d9c36..f749228 100644 --- a/doc/age-keygen.1 +++ b/doc/age-keygen.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "AGE\-KEYGEN" "1" "June 2021" "" "" +.TH "AGE\-KEYGEN" "1" "September 2021" "" "" . .SH "NAME" \fBage\-keygen\fR \- generate age(1) key pairs diff --git a/doc/age-keygen.1.html b/doc/age-keygen.1.html index 39fe29a..4b8eb29 100644 --- a/doc/age-keygen.1.html +++ b/doc/age-keygen.1.html @@ -132,7 +132,7 @@ age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p
  1. -
  2. June 2021
  3. +
  4. September 2021
  5. age-keygen(1)
diff --git a/doc/age.1 b/doc/age.1 index 07566a4..0df7dc8 100644 --- a/doc/age.1 +++ b/doc/age.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "AGE" "1" "June 2021" "" "" +.TH "AGE" "1" "September 2021" "" "" . .SH "NAME" \fBage\fR \- simple, modern, and secure file encryption @@ -183,6 +183,18 @@ An \fBIDENTITY\fR is an SSH private key \fIfile\fR passed individually to \fB\-i .P An encrypted file \fIcan\fR be linked to the SSH public key it was encrypted to\. This is so that \fBage\fR can identify the correct SSH private key before requesting its password, if any\. . +.SH "EXIT STATUS" +\fBage\fR will exit 0 if and only if encryption or decryption are succesful for the full length of the input\. +. +.P +If an error occurs during decryption, partial output might still be generated, but only if it was possible to securely authenticate it\. No unauthenticathed output is ever released\. +. +.SH "BACKWARDS COMPATIBILITY" +Files encrypted with a stable version (not alpha, beta, or release candidate) of \fBage\fR, or with any v1\.0\.0 beta or release candidate, will decrypt with any later version of the tool\. +. +.P +If decrypting older files poses a security risk, doing so might cause an error by default, and a flag will be provided to force the operation\. +. .SH "EXAMPLES" Generate a new identity, encrypt data, and decrypt: . diff --git a/doc/age.1.html b/doc/age.1.html index badf706..a2cfc7e 100644 --- a/doc/age.1.html +++ b/doc/age.1.html @@ -58,6 +58,8 @@ DESCRIPTION OPTIONS RECIPIENTS AND IDENTITIES + EXIT STATUS + BACKWARDS COMPATIBILITY EXAMPLES SEE ALSO AUTHORS @@ -243,6 +245,24 @@ or accessed via ssh-agent(1) This is so that age can identify the correct SSH private key before requesting its password, if any.

+

EXIT STATUS

+ +

age will exit 0 if and only if encryption or decryption are succesful for the +full length of the input.

+ +

If an error occurs during decryption, partial output might still be generated, +but only if it was possible to securely authenticate it. No unauthenticathed +output is ever released.

+ +

BACKWARDS COMPATIBILITY

+ +

Files encrypted with a stable version (not alpha, beta, or release candidate) of +age, or with any v1.0.0 beta or release candidate, will decrypt with any later +version of the tool.

+ +

If decrypting older files poses a security risk, doing so might cause an error +by default, and a flag will be provided to force the operation.

+

EXAMPLES

Generate a new identity, encrypt data, and decrypt:

@@ -318,7 +338,7 @@ $ age -d -i ~/.ssh/id_ed25519 example.jpg.age > example.jpg
  1. -
  2. June 2021
  3. +
  4. September 2021
  5. age(1)