Skip to content
Snippets Groups Projects
Commit 00d3d386 authored by Richard W.M. Jones's avatar Richard W.M. Jones
Browse files

docs: Fix references to nbdkit-sh-plugin(3)

This is in section 3 of the manual, not section 1.
parent 7ec55298
No related branches found
No related tags found
No related merge requests found
Pipeline #1272204598 failed
......@@ -41,12 +41,12 @@ L<nbdkit-cow-filter(1)>: Use a fully parallel thread model.
=item *
L<nbdkit-sh-plugin(1)>: Inline scripts:
L<nbdkit-sh-plugin(3)>: Inline scripts:
L<https://rwmj.wordpress.com/2018/12/15/nbdkit-inline-scripts/>
=item *
L<nbdkit-sh-plugin(1)>: Full API version 2 is now supported.
L<nbdkit-sh-plugin(3)>: Full API version 2 is now supported.
=item *
......
......@@ -81,7 +81,7 @@ control transport compression.
L<nbdkit-vddk-plugin(1)> is no longer compiled on non-x86 platforms
since VMware has only ever shipped VDDK on x86.
L<nbdkit-sh-plugin(1)> scripts can now see the client exportname and
L<nbdkit-sh-plugin(3)> scripts can now see the client exportname and
can use the C<magic_config_key> feature.
=head2 Filters
......
......@@ -95,7 +95,7 @@ Fixed a rare hang when closing a connection in L<nbdkit-nbd-plugin(1)>
Fix compilation on certain platforms with clang (Khem Raj).
Don’t leak C<$tmpdir> from L<nbdkit-sh-plugin(1)> into the I<--run>
Don’t leak C<$tmpdir> from L<nbdkit-sh-plugin(3)> into the I<--run>
subcommand.
nbdkit now correctly sets C<FD_CLOEXEC> when using systemd socket
......
......@@ -15,7 +15,7 @@ nbdkit 1.8.0 was released on 12th November 2018.
=item *
New plugin: L<nbdkit-sh-plugin(1)> for running shell scripts and other
New plugin: L<nbdkit-sh-plugin(3)> for running shell scripts and other
external programs. See:
L<https://rwmj.wordpress.com/2018/09/09/write-nbdkit-plugins-in-shell-script/>
......
......@@ -12,9 +12,9 @@ C<nbdkit-eval-plugin> is an L<nbdkit(1)> plugin which allows you to
write custom plugins as shell scripts snippets ‘eval’d on the command
line.
A common alternative to this plugin is L<nbdkit-sh-plugin(1)>. Both
A common alternative to this plugin is L<nbdkit-sh-plugin(3)>. Both
plugins share the same source code and work in almost the same way.
You should read L<nbdkit-sh-plugin(1)> first. It is easier to
You should read L<nbdkit-sh-plugin(3)> first. It is easier to
describe the differences between the two plugins and look at the
examples below.
......@@ -22,13 +22,13 @@ examples below.
=item *
L<nbdkit-sh-plugin(1)> plugins are written as a single script in a
L<nbdkit-sh-plugin(3)> plugins are written as a single script in a
separate file. Eval plugins are shell script fragments written on the
nbdkit command line — there is no separate script file.
=item *
L<nbdkit-sh-plugin(1)> has no way to know if a method is missing or
L<nbdkit-sh-plugin(3)> has no way to know if a method is missing or
not and so each C<can_*> method (eg. C<can_write>) must be written
explicitly. In eval plugins you have the option of omitting C<can_*>
methods if the associated callback (eg. C<pwrite>) is defined. In
......@@ -37,7 +37,7 @@ this way eval plugins work more like regular nbdkit plugins.
=item *
Eval plugins can only use F</bin/sh> to run the script snippets, but
L<nbdkit-sh-plugin(1)> (in spite of the name) can run any executable.
L<nbdkit-sh-plugin(3)> (in spite of the name) can run any executable.
=item *
......@@ -143,7 +143,7 @@ quoting. Normally you will need to enclose C<SCRIPT> in C<'...'>
(single quotes) to prevent it from being modified by your shell.
The script fragment behaves the same way as the corresponding method
in L<nbdkit-sh-plugin(1)>. In particular, parameters are identical,
in L<nbdkit-sh-plugin(3)>. In particular, parameters are identical,
C<$tmpdir> is present and used in the same way, the exit code must be
one of the valid exit codes described in that manual page, and error
handling works the same way too. Likewise, B<nbdkit --dump-plugin
......@@ -200,7 +200,7 @@ C<nbdkit-eval-plugin> first appeared in nbdkit 1.18.
L<nbdkit(1)>,
L<nbdkit-plugin(3)>,
L<nbdkit-sh-plugin(1)>,
L<nbdkit-sh-plugin(3)>,
L<nbdkit-cc-plugin(1)>.
=head1 AUTHORS
......
......@@ -198,7 +198,7 @@ L<nbdkit-ip-filter(1)>,
L<nbdkit-limit-filter(1)>,
L<nbdkit-linuxdisk-plugin(1)>,
L<nbdkit-memory-plugin(1)>,
L<nbdkit-sh-plugin(1)>,
L<nbdkit-sh-plugin(3)>,
L<nbdkit-loop(1)>,
L<nbdkit-tls(1)>,
L<mkfs(8)>,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment