diff options
Diffstat (limited to 'key2root-crypt.8')
-rw-r--r-- | key2root-crypt.8 | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/key2root-crypt.8 b/key2root-crypt.8 new file mode 100644 index 0000000..7e0bf33 --- /dev/null +++ b/key2root-crypt.8 @@ -0,0 +1,109 @@ +.TH KEY2ROOT 8 key2root-crypt + +.SH NAME +key2root-crypt - generate key hash for key2root + +.SH SYNOPSIS +.B key2root-crypt +.RI [ crypt-parameters ] + +.SH DESCRIPTION +The +.B key2root-crypt +utility takes a keyfile from the standard input and computes +its cryptographic as stored by the +.BR key2root-addkey (8) +utility. + +.SH OPTIONS +The +.B key2root-crypt +utility conforms to the Base Definitions volume of POSIX.1-2017, +.IR "Section 12.2" , +.IR "Utility Syntax Guidelines" . +.PP +No options are supported. + +.SH OPERANDS +The following operands are supported: +.TP +.I crypt-parameters +.BR libar2simplified_crypt (3) +parameters that the keyfile shall be hashed with. + +.SH STDIN +The +.B key2root-crypt +utility reads the keyfile to add from standard input. + +.SH INPUT FILES +None. + +.SH ENVIRONMENT VARIABLES +No environment variable affect the execution of +.BR key2root-crypt . + +.SH ASYNCHRONOUS EVENTS +Default. + +.SH STDOUT +The +.B key2root-crypt +utility prints the hash of the key files to the standard output, in the following format: +.RS +.nf + +\fB\(dq%s\en\(dq, \fP<\fIkey-hash\fP> +.fi +.RE + +.SH STDERR +The standard error is used for diagnostic messages. + +.SH OUTPUT FILES +None. + +.SH EXTENDED DESCRIPTION +None. + +.SH EXIT STATUS +If the +.B key2root-crypt +utility fails it will exit with one of the following statuses: +.TP +0 +Successful completion. +.TP +1 +A error occurred. + +.SH CONSEQUENCES OF ERRORS +Default. + +.SH APPLICATION USAGE +None. + +.SH EXAMPLES +None. + +.SH RATIONALE +None. + +.SH NOTES +None. + +.SH BUGS +None. + +.SH FUTURE DIRECTIONS +None. + +.SH SEE ALSO +.BR key2root (8), +.BR key2root-addkey (8), +.BR key2root-lskeys (8), +.BR key2root-rmkey (8) + +.SH AUTHORS +Mattias Andrée +.RI < maandree@kth.se > |