pgp-words.1

.\"                                      Hey, EMACS: -*- nroff -*-
.\" This file is part of pgp-words.
.\" Copyright (c) 2020 Thibault Polge <thibault@thb.lt>.
.\"
.\" pgp-words is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" pgp-words is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.

.TH PGP-WORDS 1 "19 February 2020" "PGP-WORDS" "pgp-words Manual"

.SH NAME
pgp-words \- generate dictation-friendly hexadecimal equivalents

.SH SYNOPSIS
\fBpgp-words\fR [hexadecimal string]

.SH DESCRIPTION
\fBpgp-words\fR is an implementation of the \fIPGP Word List\fR. The
word list was designed to make it easy to convey sequences of bytes
using only voice, and is particularly suited for transmitting key
fingerprints and other similar sequences over the phone. Even in the
same physical place, it's easier to just read a bunch of words out
loud than to spell a sequence of hex digits (was that 3 times F or
3F?)

Each word represents exactly one byte. To avoid errors, there are
actually 512 words in the list (two per possible byte value) and words
are selected depending on the parity of the byte position. For
example, `0x9e` is `quiver` if the byte position in the sequence is an
even number, `onlooker` if it is odd.

.SH OPTIONS

.TP
.B \-\-no-echo
Don't echo back the input string on stdout.

.TP
\-\-passthrough
Echo back all input strings on stdout.

.TP
.B -w, \-\-words-per-line NUMBER
Number of words to output before emitting a line-break.  Default is 4.

.TP
.B -s, \-\-silent-errors
Silently ignore invalid inputs.  This is especially useful in
combination with --passthrough.

.TP
.B -p, \-\-prefix
Prefix to display before each line of words.

.SH REFERENCE
.TP
\fIhttps://en.wikipedia.org/wiki/PGP_word_list\fR

.SH COPYRIGHT
Copyright \(co 2020-2023 Thibault Polge <thibault@thb.lt>.

License GPLv3+ (<http://gnu.org/licenses/gpl.html>)

This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.