systemd/man/systemd-binfmt.service.xml

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-binfmt.service" conditional='ENABLE_BINFMT'
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>systemd-binfmt.service</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-binfmt.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-binfmt.service</refname>
    <refname>systemd-binfmt</refname>
    <refpurpose>Configure additional binary formats for executables at boot</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-binfmt.service</filename></para>
    <para><filename>/usr/lib/systemd/systemd-binfmt</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-binfmt.service</filename> is an early boot
    service that registers additional binary formats for executables
    in the kernel.</para>

    <para>See
    <citerefentry><refentrytitle>binfmt.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
    for information about the configuration of this service.</para>
  </refsect1>

  <refsect1><title>Options</title>
    <variablelist>

      <varlistentry>
        <term><option>--unregister</option></term>
        <listitem><para>If passed, instead of registering configured binary formats in the kernel, the
        reverse operation is executed: all currently registered binary formats are unregistered from the
        kernel.</para>

        <xi:include href="version-info.xml" xpointer="v246"/></listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="cat-config" />
      <xi:include href="standard-options.xml" xpointer="tldr" />
      <xi:include href="standard-options.xml" xpointer="no-pager" />
      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para><simplelist type="inline">
      <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>binfmt.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry project='die-net'><refentrytitle>wine</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
    </simplelist></para>
  </refsect1>

</refentry>
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00			`<?xml version="1.0"?>`
			`<!---nxml--->`
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book\|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml 2019-03-14 21:40:58 +08:00			`<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"`
man: use same version in public and system ident. 2023-12-25 22:48:33 +08:00			`"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">`
license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 12:23:58 +08:00			`<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->`
binfmt: add --cat-config Document --help and --version while at it. 2018-04-27 15:11:59 +08:00			`<refentry id="systemd-binfmt.service" conditional='ENABLE_BINFMT'`
			`xmlns:xi="http://www.w3.org/2001/XInclude">`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`<refentryinfo>`
			`<title>systemd-binfmt.service</title>`
			`<productname>systemd</productname>`
			`</refentryinfo>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`<refmeta>`
			`<refentrytitle>systemd-binfmt.service</refentrytitle>`
			`<manvolnum>8</manvolnum>`
			`</refmeta>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`<refnamediv>`
			`<refname>systemd-binfmt.service</refname>`
			`<refname>systemd-binfmt</refname>`
			`<refpurpose>Configure additional binary formats for executables at boot</refpurpose>`
			`</refnamediv>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`<refsynopsisdiv>`
			`<para><filename>systemd-binfmt.service</filename></para>`
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all. 2015-06-19 01:47:44 +08:00			`<para><filename>/usr/lib/systemd/systemd-binfmt</filename></para>`
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`</refsynopsisdiv>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`<refsect1>`
			`<title>Description</title>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
doc: correct punctuation and improve typography in documentation 2014-08-03 13:11:12 +08:00			`<para><filename>systemd-binfmt.service</filename> is an early boot`
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`service that registers additional binary formats for executables`
			`in the kernel.</para>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`<para>See`
			`<citerefentry><refentrytitle>binfmt.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>`
			`for information about the configuration of this service.</para>`
			`</refsect1>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
binfmt: add --cat-config Document --help and --version while at it. 2018-04-27 15:11:59 +08:00			`<refsect1><title>Options</title>`
			`<variablelist>`
man: document binfmt's new --unregister switch 2020-04-23 22:51:37 +08:00
			`<varlistentry>`
			`<term><option>--unregister</option></term>`
			`<listitem><para>If passed, instead of registering configured binary formats in the kernel, the`
			`reverse operation is executed: all currently registered binary formats are unregistered from the`
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output. 2023-08-23 00:52:36 +08:00			`kernel.</para>`

			`<xi:include href="version-info.xml" xpointer="v246"/></listitem>`
man: document binfmt's new --unregister switch 2020-04-23 22:51:37 +08:00			`</varlistentry>`

binfmt: add --cat-config Document --help and --version while at it. 2018-04-27 15:11:59 +08:00			`<xi:include href="standard-options.xml" xpointer="cat-config" />`
binfmt: add --tldr 2023-10-16 00:34:54 +08:00			`<xi:include href="standard-options.xml" xpointer="tldr" />`
binfmt,sysctl,sysuers,tmpfiles: add auto-paging for --cat-config commands The output of these commands is really long, and already enriched with color. Let's add auto-paging to make this easier to digest. 2018-06-12 21:37:53 +08:00			`<xi:include href="standard-options.xml" xpointer="no-pager" />`
binfmt: add --cat-config Document --help and --version while at it. 2018-04-27 15:11:59 +08:00			`<xi:include href="standard-options.xml" xpointer="help" />`
			`<xi:include href="standard-options.xml" xpointer="version" />`
			`</variablelist>`
			`</refsect1>`

Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`<refsect1>`
			`<title>See Also</title>`
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering. 2023-12-23 02:09:32 +08:00			`<para><simplelist type="inline">`
			`<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>`
			`<member><citerefentry><refentrytitle>binfmt.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>`
			`<member><citerefentry project='die-net'><refentrytitle>wine</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>`
			`</simplelist></para>`
Reindent man pages to 2ch 2015-02-04 10:14:13 +08:00			`</refsect1>`
man: add documentation for the binfmt, modules-load, sysctl services 2012-05-31 22:00:34 +08:00
			`</refentry>`