diff options
| author | Lennart Poettering <lennart@poettering.net> | 2023-03-28 11:17:44 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2023-03-29 19:09:10 +0200 |
| commit | 6e4a324574d5f1b2296799324dbdb54326078233 (patch) | |
| tree | 604bba9357bab7a1ea3ccf16423732cb00d040cf /man/systemd-notify.xml | |
| parent | e829f28c1bc6e6865261bfb3bc26089f50e0c7bd (diff) | |
| download | systemd-6e4a324574d5f1b2296799324dbdb54326078233.tar.gz | |
notify: add support for sending fds with notification messages
This exposes the fd passing we support via sd_pid_notify_with_fds() also
via the command line tool systemd-notify.
Diffstat (limited to 'man/systemd-notify.xml')
| -rw-r--r-- | man/systemd-notify.xml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index 5a154686f5..1b469fe85c 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -191,6 +191,29 @@ escaped as <literal>\;</literal>.</para></listitem> </varlistentry> + <varlistentry> + <term><option>--fd=</option></term> + + <listitem><para>Send a file descriptor along with the notification message. This is useful when + invoked in services that have the <varname>FileDescriptorStoreMax=</varname> setting enabled, see + <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details. The specified file descriptor must be passed to <command>systemd-notify</command> when + invoked. This option may be used multiple times to pass multiple file descriptors in a single + notification message.</para> + + <para>To use this functionality from a <command>bash</command> shell, use an expression like the following:</para> + <programlisting>systemd-notify --fd=4 --fd=5 4</some/file 5</some/other/file</programlisting></listitem> + </varlistentry> + + <varlistentry> + <term><option>--fdname=</option></term> + + <listitem><para>Set a name to assign to the file descriptors passed via <option>--fd=</option> (see + above). This controls the <literal>FDNAME=</literal> field. This setting may only be specified once, + and applies to all file descriptors passed. Invoke this tool multiple times in case multiple file + descriptors with different file descriptor names shall be submitted.</para></listitem> + </varlistentry> + <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> </variablelist> |