nbdkit/0003-docs-Document-how-to-probe-for-server-command-line-o.patch
Richard W.M. Jones 419ab843ca Rebase to nbdkit 1.45.7
resolves: RHEL-111242
2025-08-29 15:14:08 +01:00

48 lines
1.3 KiB
Diff

From 8788b177b342e9f713ed87864e8fed333c8252e6 Mon Sep 17 00:00:00 2001
From: "Richard W.M. Jones" <rjones@redhat.com>
Date: Tue, 26 Aug 2025 21:45:09 +0100
Subject: [PATCH] docs: Document how to probe for server command line options
Virt-v2v has started to use this method to probe for the new --name
option, so we should document the method.
---
docs/nbdkit-probing.pod | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/docs/nbdkit-probing.pod b/docs/nbdkit-probing.pod
index 070a793b..8ce506e0 100644
--- a/docs/nbdkit-probing.pod
+++ b/docs/nbdkit-probing.pod
@@ -10,6 +10,12 @@ nbdkit-probing - how to probe for nbdkit configuration and plugins
nbdkit --dump-config
+=for paragraph
+
+ nbdkit --short-options
+
+ nbdkit --long-options
+
=for paragraph
nbdkit PLUGIN --dump-plugin
@@ -76,6 +82,15 @@ earlier versions.
You can also probe the minimum version using L<pkg-config(1)>. See
L<nbdkit-plugin(3)/PKG-CONFIG/PKGCONF>.
+=head2 Find out if nbdkit implements a command line option
+
+To test if a specific single letter option (like I<-D>) or long option
+(like I<--name>) is supported by nbdkit, use:
+
+ nbdkit --short-options | grep -sq '^-D$'
+
+ nbdkit --long-options | grep -sq '^--name$'
+
=head2 Query information about a particular plugin
nbdkit pluginname --dump-plugin
--
2.47.1