Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update man pages #401

Merged
merged 1 commit into from
Aug 1, 2024
Merged

docs: Update man pages #401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/man/man1/rscrypt-dec.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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

Expand Down Expand Up @@ -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*::

Expand Down
13 changes: 9 additions & 4 deletions docs/man/man1/rscrypt-enc.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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

Expand Down Expand Up @@ -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*::

Expand All @@ -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_::

Expand Down
29 changes: 26 additions & 3 deletions docs/man/man1/rscrypt-info.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

Expand Down
Loading