From bc8141a17c4ef2b9dc413fcfd97967d7d7701e3f Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Fri, 2 Aug 2024 00:30:14 +0900 Subject: [PATCH] docs: Update man pages --- docs/man/man1/rscrypt-dec.1.adoc | 11 ++++++++--- docs/man/man1/rscrypt-enc.1.adoc | 13 +++++++++---- docs/man/man1/rscrypt-info.1.adoc | 29 ++++++++++++++++++++++++++--- 3 files changed, 43 insertions(+), 10 deletions(-) diff --git a/docs/man/man1/rscrypt-dec.1.adoc b/docs/man/man1/rscrypt-dec.1.adoc index ec6855a..d09d0f3 100644 --- a/docs/man/man1/rscrypt-dec.1.adoc +++ b/docs/man/man1/rscrypt-dec.1.adoc @@ -4,7 +4,7 @@ = rscrypt-dec(1) // Specify in UTC. -:docdate: 2024-04-15 +:docdate: 2024-08-01 :doctype: manpage ifdef::revnumber[:mansource: rscrypt {revnumber}] ifndef::revnumber[:mansource: rscrypt] @@ -21,7 +21,12 @@ rscrypt-dec - decrypt files == DESCRIPTION -This command decrypt files. +This command decrypts _INFILE_ to _OUTFILE_. If _INFILE_ is "-", data will be +read from stdin. If _OUTFILE_ is not specified, the result will be write to +stdout. + +The passphrase used for decryption can be read from either `/dev/tty`, stdin, +an environment variable, or a file. == POSITIONAL ARGUMENTS @@ -60,7 +65,7 @@ _OUTFILE_:: *--passphrase-from-tty*:: - Read the passphrase from /dev/tty. This is the default behavior. + Read the passphrase from `/dev/tty`. This is the default behavior. *--passphrase-from-stdin*:: diff --git a/docs/man/man1/rscrypt-enc.1.adoc b/docs/man/man1/rscrypt-enc.1.adoc index 38ea0a5..28b5460 100644 --- a/docs/man/man1/rscrypt-enc.1.adoc +++ b/docs/man/man1/rscrypt-enc.1.adoc @@ -4,7 +4,7 @@ = rscrypt-enc(1) // Specify in UTC. -:docdate: 2024-04-15 +:docdate: 2024-08-01 :doctype: manpage ifdef::revnumber[:mansource: rscrypt {revnumber}] ifndef::revnumber[:mansource: rscrypt] @@ -21,7 +21,12 @@ rscrypt-enc - encrypt files == DESCRIPTION -This command encrypt files. +This command encrypts _INFILE_ to _OUTFILE_. If _INFILE_ is "-", data will be +read from stdin. If _OUTFILE_ is not specified, the result will be write to +stdout. + +The passphrase used for encryption can be read from either `/dev/tty`, stdin, +an environment variable, or a file. == POSITIONAL ARGUMENTS @@ -75,7 +80,7 @@ _OUTFILE_:: *--passphrase-from-tty*:: - Read the passphrase from /dev/tty. This is the default behavior. + Read the passphrase from `/dev/tty`. This is the default behavior. *--passphrase-from-stdin*:: @@ -84,7 +89,7 @@ _OUTFILE_:: *--passphrase-from-tty-once*:: - Read the passphrase from /dev/tty only once. + Read the passphrase from `/dev/tty` only once. *--passphrase-from-env* _VAR_:: diff --git a/docs/man/man1/rscrypt-info.1.adoc b/docs/man/man1/rscrypt-info.1.adoc index 1e45ce6..d46c142 100644 --- a/docs/man/man1/rscrypt-info.1.adoc +++ b/docs/man/man1/rscrypt-info.1.adoc @@ -4,12 +4,15 @@ = rscrypt-info(1) // Specify in UTC. -:docdate: 2024-04-15 +:docdate: 2024-08-01 :doctype: manpage ifdef::revnumber[:mansource: rscrypt {revnumber}] ifndef::revnumber[:mansource: rscrypt] :manmanual: General Commands Manual ifndef::site-gen-antora[:includedir: ./include] +:ietf-datatracker: https://datatracker.ietf.org +:datatracker-html-doc: {ietf-datatracker}/doc/html +:rfc7914: {datatracker-html-doc}/rfc7914 == NAME @@ -21,8 +24,28 @@ rscrypt-info - provides information about the encryption parameters == DESCRIPTION -This command provides information about the encryption parameters. The result -will be write to stdout. +This command provides information about the encryption parameters from _FILE_. +The result will be write to stdout. If _FILE_ is "-", data will be read from +stdin. + +The encryption parameters outputs either a human-readable string or JSON. + +.List of the encryption parameters +|=== +|Parameter |Description + +|`N` (`costParameter`) +|The CPU/Memory cost parameter + +|`r` (`blockSize`) +|The block size + +|`p` (`parallelizationParameter`) +|The parallelization parameter +|=== + +The encryption parameters represents the same thing as the scrypt parameters as +defined in {rfc7914}[RFC 7914]. == POSITIONAL ARGUMENTS