mirrors/age
1
0
Fork 0
mirror of https://github.com/FiloSottile/age.git synced 2026-01-04 11:23:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: regenerate groff and html man pages

Browse Source
This commit is contained in:
GitHub Actions
2021-09-04 16:08:15 +00:00
parent 57f6b8acae
commit 7756fbfe45
4 changed files with 36 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/age-keygen.1
View File

@@ -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

2
doc/age-keygen.1.html
View File

@@ -132,7 +132,7 @@ age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>June 2021</li>
<li class='tc'>September 2021</li>
<li class='tr'>age-keygen(1)</li>
</ol>

14
doc/age.1
View File

@@ -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:
.

22
doc/age.1.html
View File

@@ -58,6 +58,8 @@
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#RECIPIENTS-AND-IDENTITIES">RECIPIENTS AND IDENTITIES</a>
<a href="#EXIT-STATUS">EXIT STATUS</a>
<a href="#BACKWARDS-COMPATIBILITY">BACKWARDS COMPATIBILITY</a>
<a href="#EXAMPLES">EXAMPLES</a>
<a href="#SEE-ALSO">SEE ALSO</a>
<a href="#AUTHORS">AUTHORS</a>
@@ -243,6 +245,24 @@ or accessed via <span class="man-ref">ssh-agent<span class="s">(1)</span></span>
This is so that <code>age</code> can identify the correct SSH private key before
requesting its password, if any.</p>
<h2 id="EXIT-STATUS">EXIT STATUS</h2>
<p><code>age</code> will exit 0 if and only if encryption or decryption are succesful for the
full length of the input.</p>
<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.</p>
<h2 id="BACKWARDS-COMPATIBILITY">BACKWARDS COMPATIBILITY</h2>
<p>Files encrypted with a stable version (not alpha, beta, or release candidate) of
<code>age</code>, or with any v1.0.0 beta or release candidate, will decrypt with any later
version of the tool.</p>
<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.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<p>Generate a new identity, encrypt data, and decrypt:</p>
@@ -318,7 +338,7 @@ $ age -d -i ~/.ssh/id_ed25519 example.jpg.age &gt; example.jpg
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>June 2021</li>
<li class='tc'>September 2021</li>
<li class='tr'>age(1)</li>
</ol>