chiark / gitweb /
machinectl: show /etc/os-release information of container in status output
[elogind.git] / man / binfmt.d.xml
1 <?xml version="1.0"?>
2 <!--*-nxml-*-->
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!--
5   This file is part of systemd.
6
7   Copyright 2011 Lennart Poettering
8
9   systemd is free software; you can redistribute it and/or modify it
10   under the terms of the GNU Lesser General Public License as published by
11   the Free Software Foundation; either version 2.1 of the License, or
12   (at your option) any later version.
13
14   systemd is distributed in the hope that it will be useful, but
15   WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   Lesser General Public License for more details.
18
19   You should have received a copy of the GNU Lesser General Public License
20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
21 -->
22 <refentry id="binfmt.d" conditional='ENABLE_BINFMT'>
23
24         <refentryinfo>
25                 <title>binfmt.d</title>
26                 <productname>systemd</productname>
27
28                 <authorgroup>
29                         <author>
30                                 <contrib>Developer</contrib>
31                                 <firstname>Lennart</firstname>
32                                 <surname>Poettering</surname>
33                                 <email>lennart@poettering.net</email>
34                         </author>
35                 </authorgroup>
36         </refentryinfo>
37
38         <refmeta>
39                 <refentrytitle>binfmt.d</refentrytitle>
40                 <manvolnum>5</manvolnum>
41         </refmeta>
42
43         <refnamediv>
44                 <refname>binfmt.d</refname>
45                 <refpurpose>Configure additional binary formats for
46                 executables at boot</refpurpose>
47         </refnamediv>
48
49         <refsynopsisdiv>
50                 <para><filename>/etc/binfmt.d/*.conf</filename></para>
51                 <para><filename>/run/binfmt.d/*.conf</filename></para>
52                 <para><filename>/usr/lib/binfmt.d/*.conf</filename></para>
53         </refsynopsisdiv>
54
55         <refsect1>
56                 <title>Description</title>
57
58                 <para>At boot,
59                 <citerefentry><refentrytitle>systemd-binfmt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
60                 reads configuration files from the above directories
61                 to register in the kernel additional binary
62                 formats for executables.</para>
63         </refsect1>
64
65         <refsect1>
66                 <title>Configuration Format</title>
67
68                 <para>Each file contains a list of binfmt_misc kernel
69                 binary format rules. Consult <ulink
70                 url="https://www.kernel.org/doc/Documentation/binfmt_misc.txt">binfmt_misc.txt</ulink>
71                 for more information on registration of additional
72                 binary formats and how to write rules.</para>
73
74                 <para>Empty lines and lines beginning with ; and # are
75                 ignored. Note that this means you may not use ; and #
76                 as delimiter in binary format rules.</para>
77
78                 <para>Each configuration file shall be named in the
79                 style of <filename><replaceable>program</replaceable>.conf</filename>.
80                 Files in <filename>/etc/</filename> override files
81                 with the same name in <filename>/usr/lib/</filename>
82                 and <filename>/run/</filename>. Files in
83                 <filename>/run/</filename> override files with the
84                 same name in <filename>/usr/lib/</filename>. Packages
85                 should install their configuration files in
86                 <filename>/usr/lib/</filename>, files in
87                 <filename>/etc/</filename> are reserved for the local
88                 administrator, who may use this logic to override the
89                 configuration files installed from vendor
90                 packages. All files are sorted by their filename in
91                 lexicographic order, regardless of which of the
92                 directories they reside in. If multiple files specify
93                 the same binary type name, the entry in the file with
94                 the lexicographically latest name will be applied.</para>
95
96                 <para>If the administrator wants to disable a
97                 configuration file supplied by the vendor, the
98                 recommended way is to place a symlink to
99                 <filename>/dev/null</filename> in
100                 <filename>/etc/binfmt.d/</filename> bearing the
101                 same filename.</para>
102         </refsect1>
103
104         <refsect1>
105                 <title>Example</title>
106                 <example>
107                         <title>/etc/binfmt.d/wine.conf example:</title>
108
109                         <programlisting># Start WINE on Windows executables
110 :DOSWin:M::MZ::/usr/bin/wine:</programlisting>
111                 </example>
112         </refsect1>
113
114         <refsect1>
115                 <title>See Also</title>
116                 <para>
117                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
118                         <citerefentry><refentrytitle>systemd-binfmt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
119                         <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
120                         <citerefentry><refentrytitle>wine</refentrytitle><manvolnum>8</manvolnum></citerefentry>
121                 </para>
122         </refsect1>
123
124 </refentry>