third-party-mirrors/tzpfms
1
0
Fork 0
mirror of https://git.sr.ht/~nabijaczleweli/tzpfms synced 2025-04-21 09:47:35 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Manpage update by job 897492

Browse Source
This commit is contained in:
наб autouploader 2022-12-04 01:52:41 +00:00
parent 0701d4c88e
commit 96fe4f0cf5
16 changed files with 602 additions and 614 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
tzpfms.pdf
View File

Binary file not shown.

1127
tzpfms.ps
View File

File diff suppressed because it is too large Load Diff

8
zfs-tpm-list.8
View File

@ -3,7 +3,7 @@
.Dd December 4, 2022
.ds doc-volume-operating-system
.Dt ZFS-TPM-LIST 8
.Os tzpfms 0.3.1-9-gd2dcf95
.Os tzpfms 0.3.1-10-gf403ffe
.
.Sh NAME
.Nm zfs-tpm-list
@ -18,7 +18,7 @@
.
.Sh DESCRIPTION
Lists the following properties on encryption roots:
.Bl -tag -compact -offset Ds -width "keystatus"
.Bl -tag -compact -offset 4n -width ".Li keystatus"
.It Li name
.It Li back-end
the
@ -56,7 +56,7 @@ If no datasets are specified, all matching encryption roots are listed \(em by d
.Nm tzpfms .
.
.Sh OPTIONS
.Bl -tag -compact -width "-b back-end"
.Bl -tag -compact -width ".Fl b Ar back-end"
.It Fl H
Scripting mode \(em remove headers and separate fields by a single tab instead of columnating them with spaces.
.Pp
@ -117,7 +117,7 @@ tarta-zoot/vm - available yes
.
.Sh SPECIAL THANKS
To all who support further development, in particular:
.Bl -bullet -offset 4n -compact -width 0
.Bl -bullet -offset 4n -compact -width "@"
.It
ThePhD
.It

2
zfs-tpm-list.8.html
View File

@ -165,7 +165,7 @@ tarta-zoot/vm - available yes</div>
<table class="foot">
<tr>
<td class="foot-date">December 4, 2022</td>
<td class="foot-os">tzpfms 0.3.1-9-gd2dcf95</td>
<td class="foot-os">tzpfms 0.3.1-10-gf403ffe</td>
</tr>
</table>
</body>

10
zfs-tpm1x-change-key.8
View File

@ -3,7 +3,7 @@
.Dd December 4, 2022
.ds doc-volume-operating-system
.Dt ZFS-TPM1X-CHANGE-KEY 8
.Os tzpfms 0.3.1-9-gd2dcf95
.Os tzpfms 0.3.1-10-gf403ffe
.
.Sh NAME
.Nm zfs-tpm1x-change-key
@ -90,7 +90,7 @@ and you are hereby asked to report a bug, please.
can be used to clear the properties and go back to using a passphrase.
.
.Sh OPTIONS
.Bl -tag -compact -width "-b backup-file"
.Bl -tag -compact -width ".Fl b Ar backup-file"
.It Fl b Ar backup-file
Save a back-up of the key to
.Ar backup-file ,
@ -114,7 +114,7 @@ For most, this is also the maximum.
.\" SPDX-License-Identifier: MIT
.
.Sh ENVIRONMENT VARIABLES
.Bl -tag -compact -width "TZPFMS"
.Bl -tag -compact -width 4n
.It Ev TZPFMS_PASSPHRASE_HELPER
By default, passphrases are prompted for and read in on the standard output and input streams.
If
@ -125,7 +125,7 @@ to provide each passphrase, instead.
.Pp
The standard output stream of the helper is tied to an anonymous file and used in its entirety as the passphrase, except for a trailing new-line, if any.
The arguments are:
.Bl -tag -compact -offset "@@" -width "@@"
.Bl -tag -compact -offset 2n -width ".Li $1"
.It Li $1
Pre-formatted noun phrase with all the information below, for use as a prompt
.\" Passphrase for tarta-zoot
@ -184,7 +184,7 @@ The TPM 1.2 main specification index at
.
.Sh SPECIAL THANKS
To all who support further development, in particular:
.Bl -bullet -offset 4n -compact -width 0
.Bl -bullet -offset 4n -compact -width "@"
.It
ThePhD
.It

2
zfs-tpm1x-change-key.8.html
View File

@ -218,7 +218,7 @@
<table class="foot">
<tr>
<td class="foot-date">December 4, 2022</td>
<td class="foot-os">tzpfms 0.3.1-9-gd2dcf95</td>
<td class="foot-os">tzpfms 0.3.1-10-gf403ffe</td>
</tr>
</table>
</body>

6
zfs-tpm1x-clear-key.8
View File

@ -3,7 +3,7 @@
.Dd December 4, 2022
.ds doc-volume-operating-system
.Dt ZFS-TPM1X-CLEAR-KEY 8
.Os tzpfms 0.3.1-9-gd2dcf95
.Os tzpfms 0.3.1-10-gf403ffe
.
.Sh NAME
.Nm zfs-tpm1x-clear-key
@ -19,7 +19,7 @@ was encrypted with
.Nm tzpfms
backend
.Sy TPM1.X :
.Bl -enum -compact -offset 4n -width ""
.Bl -enum -compact -offset 2n -width 2n
.It
performs the equivalent of
.Nm zfs Cm change-key Fl o Li keylocation=prompt Fl o Li keyformat=passphrase Ar dataset ,
@ -70,7 +70,7 @@ The TPM 1.2 main specification index at
.
.Sh SPECIAL THANKS
To all who support further development, in particular:
.Bl -bullet -offset 4n -compact -width 0
.Bl -bullet -offset 4n -compact -width "@"
.It
ThePhD
.It

2
zfs-tpm1x-clear-key.8.html
View File

@ -102,7 +102,7 @@
<table class="foot">
<tr>
<td class="foot-date">December 4, 2022</td>
<td class="foot-os">tzpfms 0.3.1-9-gd2dcf95</td>
<td class="foot-os">tzpfms 0.3.1-10-gf403ffe</td>
</tr>
</table>
</body>

10
zfs-tpm1x-load-key.8
View File

@ -3,7 +3,7 @@
.Dd December 4, 2022
.ds doc-volume-operating-system
.Dt ZFS-TPM1X-LOAD-KEY 8
.Os tzpfms 0.3.1-9-gd2dcf95
.Os tzpfms 0.3.1-10-gf403ffe
.
.Sh NAME
.Nm zfs-tpm1x-load-key
@ -31,7 +31,7 @@ See
for a detailed description.
.
.Sh OPTIONS
.Bl -tag -compact -width "-n"
.Bl -tag -compact -width ".Fl n"
.It Fl n
Do a no-op/dry run, can be used even if the key is already loaded.
Equivalent to
@ -43,7 +43,7 @@ option.
.\" SPDX-License-Identifier: MIT
.
.Sh ENVIRONMENT VARIABLES
.Bl -tag -compact -width "TZPFMS"
.Bl -tag -compact -width 4n
.It Ev TZPFMS_PASSPHRASE_HELPER
By default, passphrases are prompted for and read in on the standard output and input streams.
If
@ -54,7 +54,7 @@ to provide each passphrase, instead.
.Pp
The standard output stream of the helper is tied to an anonymous file and used in its entirety as the passphrase, except for a trailing new-line, if any.
The arguments are:
.Bl -tag -compact -offset "@@" -width "@@"
.Bl -tag -compact -offset 2n -width ".Li $1"
.It Li $1
Pre-formatted noun phrase with all the information below, for use as a prompt
.\" Passphrase for tarta-zoot
@ -113,7 +113,7 @@ The TPM 1.2 main specification index at
.
.Sh SPECIAL THANKS
To all who support further development, in particular:
.Bl -bullet -offset 4n -compact -width 0
.Bl -bullet -offset 4n -compact -width "@"
.It
ThePhD
.It

2
zfs-tpm1x-load-key.8.html
View File

@ -138,7 +138,7 @@
<table class="foot">
<tr>
<td class="foot-date">December 4, 2022</td>
<td class="foot-os">tzpfms 0.3.1-9-gd2dcf95</td>
<td class="foot-os">tzpfms 0.3.1-10-gf403ffe</td>
</tr>
</table>
</body>

16
zfs-tpm2-change-key.8
View File

@ -3,7 +3,7 @@
.Dd December 4, 2022
.ds doc-volume-operating-system
.Dt ZFS-TPM2-CHANGE-KEY 8
.Os tzpfms 0.3.1-9-gd2dcf95
.Os tzpfms 0.3.1-10-gf403ffe
.
.Sh NAME
.Nm zfs-tpm2-change-key
@ -12,7 +12,7 @@
.Nm
.Op Fl b Ar backup-file
.Oo
.Fl P Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Ns Oo Cm + Ns Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Oc Ns …
.Fl P Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Ns \: Ns Oo Cm + Ns Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Oc Ns …
.Op Fl A
.Oc
.Ar dataset
@ -54,7 +54,7 @@ The following properties are set on
.It
.Li xyz.nabijaczleweli:tzpfms.backend Ns = Ns Sy TPM2
.It
.Li xyz.nabijaczleweli:tzpfms.key Ns = Ns Ar persistent-object-ID Ns Op Cm ;\& Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Ns Oo Cm + Ns Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Oc Ns …
.Li xyz.nabijaczleweli:tzpfms.key Ns = Ns Ar persistent-object-ID Ns \: Ns Op Cm ;\& Ns Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Ns Oo Cm + Ns Ar algorithm Ns Cm \&: Ns Ar PCR Ns Oo Ns Cm \&, Ns Ar PCR Oc Ns … Oc Ns …
.El
.Pp
.Li tzpfms.backend
@ -97,7 +97,7 @@ and you are hereby asked to report a bug, please.
can be used to free the TPM persistent object and go back to using a passphrase.
.
.Sh OPTIONS
.Bl -tag -compact -width "-b backup-file"
.Bl -tag -compact -width ".Fl b Ar backup-file"
.It Fl b Ar backup-file
Save a back-up of the key to
.Ar backup-file ,
@ -154,7 +154,7 @@ with the passphrase, and this is usually not the intent.
.\" SPDX-License-Identifier: MIT
.
.Sh ENVIRONMENT VARIABLES
.Bl -tag -compact -width "TZPFMS"
.Bl -tag -compact -width 4n
.It Ev TZPFMS_PASSPHRASE_HELPER
By default, passphrases are prompted for and read in on the standard output and input streams.
If
@ -165,7 +165,7 @@ to provide each passphrase, instead.
.Pp
The standard output stream of the helper is tied to an anonymous file and used in its entirety as the passphrase, except for a trailing new-line, if any.
The arguments are:
.Bl -tag -compact -offset "@@" -width "@@"
.Bl -tag -compact -offset 2n -width ".Li $1"
.It Li $1
Pre-formatted noun phrase with all the information below, for use as a prompt
.\" Passphrase for tarta-zoot
@ -192,7 +192,7 @@ If it fails for any other reason, the prompting is aborted.
.
.Sh TPM2 back-end configuration
.Ss Environment variables
.Bl -tag -compact -width "TSS2_LOG"
.Bl -tag -compact -width ".Ev TSS2_LOG"
.It Ev TSS2_LOG
Any of:
.Sy NONE , ERROR , WARNING , INFO , DEBUG , TRACE .
@ -229,7 +229,7 @@ and related pages.
.
.Sh SPECIAL THANKS
To all who support further development, in particular:
.Bl -bullet -offset 4n -compact -width 0
.Bl -bullet -offset 4n -compact -width "@"
.It
ThePhD
.It

5
zfs-tpm2-change-key.8.html
View File

@ -61,8 +61,7 @@
<var class="Ar">dataset</var>:</p>
<ul class="Bl-bullet Bd-indent Bl-compact">
<li id="xyz.nabijaczleweli:tzpfms.backend"><a class="permalink" href="#xyz.nabijaczleweli:tzpfms.backend"><code class="Li">xyz.nabijaczleweli:tzpfms.backend</code></a>=<b class="Sy">TPM2</b></li>
<li id="xyz.nabijaczleweli:tzpfms.key"><a class="permalink" href="#xyz.nabijaczleweli:tzpfms.key"><code class="Li">xyz.nabijaczleweli:tzpfms.key</code></a>=<var class="Ar">persistent-object-ID</var>[<code class="Cm">;</code>
<var class="Ar">algorithm</var><code class="Cm">:</code><var class="Ar">PCR</var>[<code class="Cm">,</code><var class="Ar">PCR</var>]&#x2026;[<code class="Cm">+</code><var class="Ar">algorithm</var><code class="Cm">:</code><var class="Ar">PCR</var>[<code class="Cm">,</code><var class="Ar">PCR</var>]&#x2026;]&#x2026;]</li>
<li id="xyz.nabijaczleweli:tzpfms.key"><a class="permalink" href="#xyz.nabijaczleweli:tzpfms.key"><code class="Li">xyz.nabijaczleweli:tzpfms.key</code></a>=<var class="Ar">persistent-object-ID</var>[<code class="Cm">;</code><var class="Ar">algorithm</var><code class="Cm">:</code><var class="Ar">PCR</var>[<code class="Cm">,</code><var class="Ar">PCR</var>]&#x2026;[<code class="Cm">+</code><var class="Ar">algorithm</var><code class="Cm">:</code><var class="Ar">PCR</var>[<code class="Cm">,</code><var class="Ar">PCR</var>]&#x2026;]&#x2026;]</li>
</ul>
<p class="Pp"><code class="Li">tzpfms.backend</code> identifies this dataset for
work with <b class="Sy">TPM2</b>-back-ended <code class="Nm">tzpfms</code>
@ -265,7 +264,7 @@
<table class="foot">
<tr>
<td class="foot-date">December 4, 2022</td>
<td class="foot-os">tzpfms 0.3.1-9-gd2dcf95</td>
<td class="foot-os">tzpfms 0.3.1-10-gf403ffe</td>
</tr>
</table>
</body>

12
zfs-tpm2-clear-key.8
View File

@ -3,7 +3,7 @@
.Dd December 4, 2022
.ds doc-volume-operating-system
.Dt ZFS-TPM2-CLEAR-KEY 8
.Os tzpfms 0.3.1-9-gd2dcf95
.Os tzpfms 0.3.1-10-gf403ffe
.
.Sh NAME
.Nm zfs-tpm2-clear-key
@ -19,7 +19,7 @@ was encrypted with
.Nm tzpfms
backend
.Sy TPM2 :
.Bl -enum -compact -offset 4n -width ""
.Bl -enum -compact -offset 2n -width 2n
.It
performs the equivalent of
.Nm zfs Cm change-key Fl o Li keylocation=prompt Fl o Li keyformat=passphrase Ar dataset ,
@ -40,7 +40,7 @@ for a detailed description.
.\" SPDX-License-Identifier: MIT
.
.Sh ENVIRONMENT VARIABLES
.Bl -tag -compact -width "TZPFMS"
.Bl -tag -compact -width 4n
.It Ev TZPFMS_PASSPHRASE_HELPER
By default, passphrases are prompted for and read in on the standard output and input streams.
If
@ -51,7 +51,7 @@ to provide each passphrase, instead.
.Pp
The standard output stream of the helper is tied to an anonymous file and used in its entirety as the passphrase, except for a trailing new-line, if any.
The arguments are:
.Bl -tag -compact -offset "@@" -width "@@"
.Bl -tag -compact -offset 2n -width ".Li $1"
.It Li $1
Pre-formatted noun phrase with all the information below, for use as a prompt
.\" Passphrase for tarta-zoot
@ -78,7 +78,7 @@ If it fails for any other reason, the prompting is aborted.
.
.Sh TPM2 back-end configuration
.Ss Environment variables
.Bl -tag -compact -width "TSS2_LOG"
.Bl -tag -compact -width ".Ev TSS2_LOG"
.It Ev TSS2_LOG
Any of:
.Sy NONE , ERROR , WARNING , INFO , DEBUG , TRACE .
@ -115,7 +115,7 @@ and related pages.
.
.Sh SPECIAL THANKS
To all who support further development, in particular:
.Bl -bullet -offset 4n -compact -width 0
.Bl -bullet -offset 4n -compact -width "@"
.It
ThePhD
.It

2
zfs-tpm2-clear-key.8.html
View File

@ -153,7 +153,7 @@
<table class="foot">
<tr>
<td class="foot-date">December 4, 2022</td>
<td class="foot-os">tzpfms 0.3.1-9-gd2dcf95</td>
<td class="foot-os">tzpfms 0.3.1-10-gf403ffe</td>
</tr>
</table>
</body>

10
zfs-tpm2-load-key.8
View File

@ -3,7 +3,7 @@
.Dd December 4, 2022
.ds doc-volume-operating-system
.Dt ZFS-TPM2-LOAD-KEY 8
.Os tzpfms 0.3.1-9-gd2dcf95
.Os tzpfms 0.3.1-10-gf403ffe
.
.Sh NAME
.Nm zfs-tpm2-load-key
@ -30,7 +30,7 @@ See
for a detailed description.
.
.Sh OPTIONS
.Bl -tag -compact -width "-n"
.Bl -tag -compact -width ".Fl n"
.It Fl n
Do a no-op/dry run, can be used even if the key is already loaded.
Equivalent to
@ -42,7 +42,7 @@ option.
.\" SPDX-License-Identifier: MIT
.
.Sh ENVIRONMENT VARIABLES
.Bl -tag -compact -width "TZPFMS"
.Bl -tag -compact -width 4n
.It Ev TZPFMS_PASSPHRASE_HELPER
By default, passphrases are prompted for and read in on the standard output and input streams.
If
@ -53,7 +53,7 @@ to provide each passphrase, instead.
.Pp
The standard output stream of the helper is tied to an anonymous file and used in its entirety as the passphrase, except for a trailing new-line, if any.
The arguments are:
.Bl -tag -compact -offset "@@" -width "@@"
.Bl -tag -compact -offset 2n -width ".Li $1"
.It Li $1
Pre-formatted noun phrase with all the information below, for use as a prompt
.\" Passphrase for tarta-zoot
@ -112,7 +112,7 @@ The TPM 1.2 main specification index at
.
.Sh SPECIAL THANKS
To all who support further development, in particular:
.Bl -bullet -offset 4n -compact -width 0
.Bl -bullet -offset 4n -compact -width "@"
.It
ThePhD
.It

2
zfs-tpm2-load-key.8.html
View File

@ -137,7 +137,7 @@
<table class="foot">
<tr>
<td class="foot-date">December 4, 2022</td>
<td class="foot-os">tzpfms 0.3.1-9-gd2dcf95</td>
<td class="foot-os">tzpfms 0.3.1-10-gf403ffe</td>
</tr>
</table>
</body>