Libguestfs - Nov 2019 - [PATCH common] options: Describe --key SELECTOR in a single file.

This is a patch series against common and libguestfs which unifies all
the documentation about --key SELECTOR so it only appears in a single
file, but is included in all the other POD documentation.

The overall effect of the change should be completely neutral.

Rich.

Other man pages can include this file to document the --key option and
selector.
---
 options/key-option.pod | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/options/key-option.pod b/options/key-option.pod
new file mode 100644
index 0000000..cc188dc
--- /dev/null
+++ b/options/key-option.pod
@@ -0,0 +1,16 @@
+=item B<--key> SELECTOR
+
+Specify a key for LUKS, to automatically open a LUKS device when using
+the inspection.
+
+=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
-- 
2.23.0

On Tuesday, 26 November 2019 19:10:43 CET Richard W.M. Jones
wrote:
> This is a patch series against common and libguestfs which unifies all
> the documentation about --key SELECTOR so it only appears in a single
> file, but is included in all the other POD documentation.
LGTM.

Thanks,
-- 
Pino Toscano