Files
plan9port/man/man1/pem.1
Dmitri Vereshchagin 10564b1175 tmac/tmac.an: define .MR in a groff compatible way
groff 1.23.0 added .MR to its -man macro package.  The NEWS file states
that the inclusion of the macro "was prompted by its introduction to
Plan 9 from User Space's troff in August 2020."  From d32deab it seems
that the name for Plan 9 from User Space's implementation was suggested
by groff maintainer G. Brandon Robinson.

Not sure if the intention was to make these definitions compatible, but
it would be nice if they were.

Currently, Plan 9 from User Space's .MR expects its second argument to
be parenthesized.  groff's .MR does not.  This results in extra
parentheses appearing in manual references when viewing Plan 9 from User
Space's manual pages on a system using groff.
2025-07-27 09:58:50 -04:00

66 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
.MR 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
.MR 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
.MR rsa 1