plan9port/man/man1/pem.1
Russ Cox 977b25a76a tmac: introduce real manual reference macro instead of overloading IR
The overloading of IR emits magic \X'...' sequences that turn into HTML manual links.
But not all such IR invocations should be manual links;
those had to be written to avoid the IR macro before.
Worse, the \X'...' ending the IR causes troff to emit only a single space after a period.

Defining a new IM macro for manual references fixes both problems.

Fixes #441.
2020-08-13 23:43:43 -04:00

65 lines
1.2 KiB
Groff

.TH PEM 1
.SH NAME
pemdecode, pemencode \- encode files in Privacy Enhanced Mail (PEM) format
.SH SYNOPSIS
.PP
.B auth/pemdecode
.I section
[
.I file
]
.PP
.B auth/pemencode
.I section
[
.I file
]
.SH DESCRIPTION
PEM is a textual encoding for binary data originally used by the
Privacy Enhanced Mail program but now commonly used for
other applications, notably TLS.
PEM encodes data in base 64
(see
.IM encode (3) )
between lines of the form:
.IP
.EX
-----BEGIN SECTION-----
-----END SECTION-----
.EE
.LP
where
.B SECTION
may be any string describing the encoded data.
The most common use of PEM format on Plan 9 is for encoding
X.509 certificates; see
.IM rsa (1) .
.PP
.I Pemdecode
extracts the named
.I section
and writes the decoded data to standard output.
.PP
.I Pemencode
encodes its standard input, labels it as a
.IR section ,
and writes it to standard output.
.SH EXAMPLES
Encode and decode a simple greeting:
.IP
.EX
% echo hello world |
auth/pemencode GREETING
-----BEGIN GREETING-----
aGVsbG8gd29ybGQK
-----END GREETING-----
% echo hello world |
auth/pemencode GREETING |
auth/pemdecode GREETING
hello world
%
.EE
.SH SOURCE
.B \*9/src/cmd/auth
.SH "SEE ALSO
.IM rsa (1)