options: Update documentation for --key SELECTOR.

Use the common/options/key-option.pod fragment to document the --key
option and selector instead of duplicating the same documentation
everywhere.
This commit is contained in:
Richard W.M. Jones
2019-11-26 12:50:16 +00:00
parent 152ff05ae0
commit 8ba0457e9e
25 changed files with 28 additions and 210 deletions

View File

@@ -188,6 +188,7 @@ stamp-virt-cat.pod: virt-cat.pod
$(PODWRAPPER) \
--man virt-cat.1 \
--html $(top_builddir)/website/virt-cat.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning safe \
$<
@@ -210,6 +211,7 @@ stamp-virt-log.pod: virt-log.pod
$(PODWRAPPER) \
--man virt-log.1 \
--html $(top_builddir)/website/virt-log.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning safe \
$<
@@ -221,6 +223,7 @@ stamp-virt-ls.pod: virt-ls.pod
$(PODWRAPPER) \
--man virt-ls.1 \
--html $(top_builddir)/website/virt-ls.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning safe \
$<
@@ -232,6 +235,7 @@ stamp-virt-tail.pod: virt-tail.pod
$(PODWRAPPER) \
--man virt-tail.1 \
--html $(top_builddir)/website/virt-tail.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning safe \
$<

View File

@@ -121,22 +121,7 @@ If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format. This avoids a possible
security problem with malicious guests (CVE-2010-3851).
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -105,22 +105,7 @@ If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format. This avoids a possible
security problem with malicious guests (CVE-2010-3851).
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -352,22 +352,7 @@ Display file sizes in human-readable format.
This option only has effect in I<-lR> output mode. See
L</RECURSIVE LONG LISTING> above.
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -123,22 +123,7 @@ If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format. This avoids a possible
security problem with malicious guests (CVE-2010-3851).
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

2
common

Submodule common updated: c10c8baedb...22d796efc6

View File

@@ -203,6 +203,7 @@ stamp-virt-customize.pod: virt-customize.pod $(top_srcdir)/common/mlcustomize/cu
$(PODWRAPPER) \
--man virt-customize.1 \
--html $(top_builddir)/website/virt-customize.1.html \
--path $(top_srcdir)/common/options \
--insert $(top_srcdir)/common/mlcustomize/customize-synopsis.pod:__CUSTOMIZE_SYNOPSIS__ \
--insert $(top_srcdir)/common/mlcustomize/customize-options.pod:__CUSTOMIZE_OPTIONS__ \
--license GPLv2+ \

View File

@@ -138,22 +138,7 @@ If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format. This avoids a possible
security problem with malicious guests (CVE-2010-3851).
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -64,6 +64,7 @@ stamp-virt-diff.pod: virt-diff.pod
$(PODWRAPPER) \
--man virt-diff.1 \
--html $(top_builddir)/website/virt-diff.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning safe \
$<

View File

@@ -166,22 +166,7 @@ security problem with malicious guests (CVE-2010-3851).
Display file sizes in human-readable format.
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -62,6 +62,7 @@ stamp-virt-edit.pod: virt-edit.pod
$(PODWRAPPER) \
--man virt-edit.1 \
--html $(top_builddir)/website/virt-edit.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning general \
$<

View File

@@ -153,22 +153,7 @@ If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format. This avoids a possible
security problem with malicious guests (CVE-2010-3851).
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -201,7 +201,7 @@ stamp-guestfish.pod: guestfish.pod guestfish-actions.pod guestfish-commands.pod
$(PODWRAPPER) \
--man guestfish.1 \
--html $(top_builddir)/website/guestfish.1.html \
--path $(srcdir) \
--path $(srcdir) --path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning ro-option \
$<

View File

@@ -280,22 +280,7 @@ Using this flag is mostly equivalent to using the C<inspect-os>
command and then using other commands to mount the filesystems that
were found.
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -101,6 +101,7 @@ stamp-guestmount.pod: guestmount.pod
$(PODWRAPPER) \
--man guestmount.1 \
--html $(top_builddir)/website/guestmount.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning ro-option \
$<

View File

@@ -246,22 +246,7 @@ Using L<virt-inspector(1)> code, inspect the disks looking for
an operating system and mount filesystems as they would be
mounted on the real virtual machine.
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -128,6 +128,7 @@ stamp-virt-get-kernel.pod: virt-get-kernel.pod
$(PODWRAPPER) \
--man virt-get-kernel.1 \
--html $(top_builddir)/website/virt-get-kernel.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning safe \
$<

View File

@@ -89,22 +89,7 @@ If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format. This avoids a possible
security problem with malicious guests (CVE-2010-3851).
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -82,6 +82,7 @@ stamp-virt-inspector.pod: virt-inspector.pod
$(PODWRAPPER) \
--man virt-inspector.1 \
--html $(top_builddir)/website/virt-inspector.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning safe \
$<

View File

@@ -114,22 +114,7 @@ parameter is ignored.
If working with untrusted raw-format guest disk images, you should
ensure the format is always specified.
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -10,6 +10,7 @@
../cat/virt-tail.pod
../common/mlcustomize/customize-options.pod
../common/mlcustomize/customize-synopsis.pod
../common/options/key-option.pod
../customize/virt-customize.pod
../daemon/guestfsd.pod
../df/virt-df.pod

View File

@@ -130,6 +130,7 @@ stamp-virt-sparsify.pod: virt-sparsify.pod
$(PODWRAPPER) \
--man virt-sparsify.1 \
--html $(top_builddir)/website/virt-sparsify.1.html \
--path $(top_srcdir)/common/options \
--license GPLv2+ \
--warning general \
$<

View File

@@ -230,22 +230,7 @@ You can give this option multiple times.
Do in-place sparsification instead of copying sparsification.
See L</IN-PLACE SPARSIFICATION> below.
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>

View File

@@ -192,6 +192,7 @@ stamp-virt-sysprep.pod: virt-sysprep.pod sysprep-extra-options.pod sysprep-opera
--man virt-sysprep.1 \
--insert sysprep-extra-options.pod:__EXTRA_OPTIONS__ \
--insert sysprep-operations.pod:__OPERATIONS__ \
--path $(top_srcdir)/common/options \
--html $(top_builddir)/website/virt-sysprep.1.html \
--license GPLv2+ \
--warning general \

View File

@@ -186,22 +186,7 @@ If you have untrusted raw-format guest disk images, you should use
this option to specify the disk format. This avoids a possible
security problem with malicious guests (CVE-2010-3851).
=item B<--key> SELECTOR
Specify a key for LUKS, to automatically open a LUKS device when using
the inspection. C<SELECTOR> can be in one of the following formats:
=over 4
=item B<--key> C<DEVICE>:key:KEY_STRING
Use the specified C<KEY_STRING> as passphrase.
=item B<--key> C<DEVICE>:file:FILENAME
Read the passphrase from F<FILENAME>.
=back
__INCLUDE:key-option.pod__
=item B<--keys-from-stdin>