~nabijaczleweli/tzpfms

63d575615fed82f7bc1718a9a3debc8cf280e0bb — наб autouploader 25 days ago 4bf1b95
Manpage update by job 332079
4 files changed, 60 insertions(+), 12 deletions(-)

M zfs-tpm-list.8
M zfs-tpm-list.8.html
M zfs-tpm-list.8.html_fragment
M zfs-tpm-list.md
M zfs-tpm-list.8 => zfs-tpm-list.8 +16 -3
@@ 4,7 4,7 @@
.SH "NAME"
\fBzfs\-tpm\-list\fR \- print dataset tzpfms metadata
.SH "SYNOPSIS"
\fBzfs\-tpm\-list\fR [\-H] [\-r|\-d \fIdepth\fR] [\-a|\-b \fIback\-end\fR] [\fIfilesystem\fR|\fIvolume\fR]…
\fBzfs\-tpm\-list\fR [\-H] [\-r|\-d \fIdepth\fR] [\-a|\-b \fIback\-end\fR] [\-u|\-l] [\fIfilesystem\fR|\fIvolume\fR]…
.SH "DESCRIPTION"
zfs\-tpm\-list(8) lists the following properties on encryption roots:
.IP "\[ci]" 4


@@ 17,9 17,9 @@ zfs\-tpm\-list(8) lists the following properties on encryption roots:
\fBcoherent\fR: "yes" if either both \fBxyz\.nabijaczleweli:tzpfms\.backend\fR and \fBxyz\.nabijaczleweli:tzpfms\.key\fR are present or missing, "no" otherwise\.
.IP "" 0
.P
Incoherent datasets require immediate operator attention, with either the appropriate zfs\-tpm*\-clear\-key program or zfs(8) change\-key \(em if the key becomes unloaded, they will require restoration from back\-up\. However, they should never occur, unless something went terribly wrong with the dataset properties\.
Incoherent datasets require immediate operator attention, with either the appropriate zfs\-tpm*\-clear\-key program or zfs(8) change\-key and zfs(8) inherit \(em if the key becomes unloaded, they will require restoration from back\-up\. However, they should never occur, unless something went terribly wrong with the dataset properties\.
.P
If no datasets are specified, lists all matching encryption roots\. The default filter is to list all roots managed by tzpfms\. The \fB\-a\fR and \fB\-b\fR OPTIONS \fI\fR can be used to list all roots or only ones backed by a particular end\.
If no datasets are specified, lists all matching encryption roots\. The default filter is to list all roots managed by tzpfms\. The \fB\-a\fR and \fB\-b\fR OPTIONS \fI\fR can be used to either list all roots or only ones backed by a particular end, respectively\.
.SH "OPTIONS"
.TP
\fB\-H\fR


@@ 36,6 36,12 @@ List all encryption roots, even ones not managed by tzpfms\.
.TP
\fB\-b\fR \fIback\-end\fR
List only encryption roots with tzpfms back\-end \fIback\-end\fR\.
.TP
\fB\-l\fR
List only encryption roots whose keys are available\.
.TP
\fB\-u\fR
List only encryption roots whose keys are unavailable\.
.SH "EXAMPLES"
.nf
$ zfs\-tpm\-list


@@ 57,6 63,13 @@ owo/venc  TPM2      unavailable  yes
owo/vtnc  \-         available    yes
owo/v nc  \-         available    yes
owo/enc   TPM1\.X    available    yes

$ zfs\-tpm\-list \-al
NAME      BACK\-END  KEYSTATUS  COHERENT
awa       \-         available  yes
owo/vtnc  \-         available  yes
owo/v nc  \-         available  yes
owo/enc   TPM1\.X    available  yes
.fi
.SH "AUTHOR"
Written by наб <\fInabijaczleweli@nabijaczleweli\.xyz\fR>

M zfs-tpm-list.8.html => zfs-tpm-list.8.html +14 -3
@@ 78,7 78,7 @@
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p><code>zfs-tpm-list</code> [-H] [-r|-d <em>depth</em>] [-a|-b <em>back-end</em>] [<em>filesystem</em>|<em>volume</em>]…</p>
<p><code>zfs-tpm-list</code> [-H] [-r|-d <em>depth</em>] [-a|-b <em>back-end</em>] [-u|-l] [<em>filesystem</em>|<em>volume</em>]…</p>

<h2 id="DESCRIPTION">DESCRIPTION</h2>



@@ 96,13 96,13 @@
<code>coherent</code>: "yes" if either both <code>xyz.nabijaczleweli:tzpfms.backend</code> and <code>xyz.nabijaczleweli:tzpfms.key</code> are present or missing, "no" otherwise.</li>
</ul>

<p>Incoherent datasets require immediate operator attention, with either the appropriate zfs-tpm*-clear-key program or <a class="man-ref" href="https://manpages.debian.org/bullseye/zfsutils-linux/zfs.8.en.html">zfs<span class="s">(8)</span></a> change-key —
<p>Incoherent datasets require immediate operator attention, with either the appropriate zfs-tpm*-clear-key program or <a class="man-ref" href="https://manpages.debian.org/bullseye/zfsutils-linux/zfs.8.en.html">zfs<span class="s">(8)</span></a> change-key and <a class="man-ref" href="https://manpages.debian.org/bullseye/zfsutils-linux/zfs.8.en.html">zfs<span class="s">(8)</span></a> inherit —
if the key becomes unloaded, they will require restoration from back-up.
However, they should never occur, unless something went terribly wrong with the dataset properties.</p>

<p>If no datasets are specified, lists all matching encryption roots.
The default filter is to list all roots managed by tzpfms.
The <code>-a</code> and <code>-b</code> <a href="">OPTIONS</a> can be used to list all roots or only ones backed by a particular end.</p>
The <code>-a</code> and <code>-b</code> <a href="">OPTIONS</a> can be used to either list all roots or only ones backed by a particular end, respectively.</p>

<h2 id="OPTIONS">OPTIONS</h2>



@@ 121,6 121,10 @@ The <code>-a</code> and <code>-b</code> <a href="">OPTIONS</a> can be used to li
<code>-b</code> <em>back-end</em>
</dt>
<dd>List only encryption roots with tzpfms back-end <em>back-end</em>.</dd>
<dt><code>-l</code></dt>
<dd>List only encryption roots whose keys are available.</dd>
<dt><code>-u</code></dt>
<dd>List only encryption roots whose keys are unavailable.</dd>
</dl>

<h2 id="EXAMPLES">EXAMPLES</h2>


@@ 144,6 148,13 @@ owo/venc  TPM2      unavailable  yes
owo/vtnc  -         available    yes
owo/v nc  -         available    yes
owo/enc   TPM1.X    available    yes

$ zfs-tpm-list -al
NAME      BACK-END  KEYSTATUS  COHERENT
awa       -         available  yes
owo/vtnc  -         available  yes
owo/v nc  -         available  yes
owo/enc   TPM1.X    available  yes
</code></pre>

<h2 id="AUTHOR">AUTHOR</h2>

M zfs-tpm-list.8.html_fragment => zfs-tpm-list.8.html_fragment +14 -3
@@ 6,7 6,7 @@
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p><code>zfs-tpm-list</code> [-H] [-r|-d <em>depth</em>] [-a|-b <em>back-end</em>] [<em>filesystem</em>|<em>volume</em>]…</p>
<p><code>zfs-tpm-list</code> [-H] [-r|-d <em>depth</em>] [-a|-b <em>back-end</em>] [-u|-l] [<em>filesystem</em>|<em>volume</em>]…</p>

<h2 id="DESCRIPTION">DESCRIPTION</h2>



@@ 24,13 24,13 @@
<code>coherent</code>: "yes" if either both <code>xyz.nabijaczleweli:tzpfms.backend</code> and <code>xyz.nabijaczleweli:tzpfms.key</code> are present or missing, "no" otherwise.</li>
</ul>

<p>Incoherent datasets require immediate operator attention, with either the appropriate zfs-tpm*-clear-key program or <a class="man-ref" href="https://manpages.debian.org/bullseye/zfsutils-linux/zfs.8.en.html">zfs<span class="s">(8)</span></a> change-key —
<p>Incoherent datasets require immediate operator attention, with either the appropriate zfs-tpm*-clear-key program or <a class="man-ref" href="https://manpages.debian.org/bullseye/zfsutils-linux/zfs.8.en.html">zfs<span class="s">(8)</span></a> change-key and <a class="man-ref" href="https://manpages.debian.org/bullseye/zfsutils-linux/zfs.8.en.html">zfs<span class="s">(8)</span></a> inherit —
if the key becomes unloaded, they will require restoration from back-up.
However, they should never occur, unless something went terribly wrong with the dataset properties.</p>

<p>If no datasets are specified, lists all matching encryption roots.
The default filter is to list all roots managed by tzpfms.
The <code>-a</code> and <code>-b</code> <a href="">OPTIONS</a> can be used to list all roots or only ones backed by a particular end.</p>
The <code>-a</code> and <code>-b</code> <a href="">OPTIONS</a> can be used to either list all roots or only ones backed by a particular end, respectively.</p>

<h2 id="OPTIONS">OPTIONS</h2>



@@ 49,6 49,10 @@ The <code>-a</code> and <code>-b</code> <a href="">OPTIONS</a> can be used to li
<code>-b</code> <em>back-end</em>
</dt>
<dd>List only encryption roots with tzpfms back-end <em>back-end</em>.</dd>
<dt><code>-l</code></dt>
<dd>List only encryption roots whose keys are available.</dd>
<dt><code>-u</code></dt>
<dd>List only encryption roots whose keys are unavailable.</dd>
</dl>

<h2 id="EXAMPLES">EXAMPLES</h2>


@@ 72,6 76,13 @@ owo/venc  TPM2      unavailable  yes
owo/vtnc  -         available    yes
owo/v nc  -         available    yes
owo/enc   TPM1.X    available    yes

$ zfs-tpm-list -al
NAME      BACK-END  KEYSTATUS  COHERENT
awa       -         available  yes
owo/vtnc  -         available  yes
owo/v nc  -         available  yes
owo/enc   TPM1.X    available  yes
</code></pre>

<h2 id="AUTHOR">AUTHOR</h2>

M zfs-tpm-list.md => zfs-tpm-list.md +16 -3
@@ 3,7 3,7 @@ zfs-tpm-list(8) -- print dataset tzpfms metadata

## SYNOPSIS

`zfs-tpm-list` [-H] [-r\|-d *depth*] [-a\|-b *back-end*] [*filesystem*\|*volume*]…
`zfs-tpm-list` [-H] [-r\|-d *depth*] [-a\|-b *back-end*] [-u\|-l] [*filesystem*\|*volume*]…

## DESCRIPTION



@@ 15,13 15,13 @@ zfs-tpm-list(8) lists the following properties on encryption roots:
  * `keystatus`: "available" or "unavailable",
  * `coherent`: "yes" if either both `xyz.nabijaczleweli:tzpfms.backend` and `xyz.nabijaczleweli:tzpfms.key` are present or missing, "no" otherwise.

Incoherent datasets require immediate operator attention, with either the appropriate zfs-tpm\*-clear-key program or zfs(8) change-key —
Incoherent datasets require immediate operator attention, with either the appropriate zfs-tpm\*-clear-key program or zfs(8) change-key and zfs(8) inherit —
if the key becomes unloaded, they will require restoration from back-up.
However, they should never occur, unless something went terribly wrong with the dataset properties.

If no datasets are specified, lists all matching encryption roots.
The default filter is to list all roots managed by tzpfms.
The `-a` and `-b` [OPTIONS]() can be used to list all roots or only ones backed by a particular end.
The `-a` and `-b` [OPTIONS]() can be used to either list all roots or only ones backed by a particular end, respectively.

## OPTIONS



@@ 38,6 38,11 @@ The `-a` and `-b` [OPTIONS]() can be used to list all roots or only ones backed 
  * `-b` *back-end*:
    List only encryption roots with tzpfms back-end *back-end*.

  * `-l`:
    List only encryption roots whose keys are available.
  * `-u`:
    List only encryption roots whose keys are unavailable.

## EXAMPLES

    $ zfs-tpm-list


@@ 60,6 65,14 @@ The `-a` and `-b` [OPTIONS]() can be used to list all roots or only ones backed 
    owo/v nc  -         available    yes
    owo/enc   TPM1.X    available    yes

    $ zfs-tpm-list -al
    NAME      BACK-END  KEYSTATUS  COHERENT
    awa       -         available  yes
    owo/vtnc  -         available  yes
    owo/v nc  -         available  yes
    owo/enc   TPM1.X    available  yes


## AUTHOR

Written by наб &lt;<nabijaczleweli@nabijaczleweli.xyz>&gt;