]>
git.ipfire.org Git - thirdparty/systemd.git/blob - tools/make-directive-index.py
2 # SPDX-License-Identifier: LGPL-2.1+
7 from xml_helper
import xml_parse
, xml_print
, tree
8 from copy
import deepcopy
11 <refentry id="systemd.directives" conditional="HAVE_PYTHON">
14 <title>systemd.directives</title>
15 <productname>systemd</productname>
19 <refentrytitle>systemd.directives</refentrytitle>
20 <manvolnum>7</manvolnum>
24 <refname>systemd.directives</refname>
25 <refpurpose>Index of configuration directives</refpurpose>
29 <title>Unit directives</title>
31 <para>Directives for configuring units, used in unit
34 <variablelist id='unit-directives' />
38 <title>Options on the kernel command line</title>
40 <para>Kernel boot options for configuring the behaviour of the
41 systemd process.</para>
43 <variablelist id='kernel-commandline-options' />
47 <title>Environment variables</title>
49 <para>Environment variables understood by the systemd
50 manager and other programs.</para>
52 <variablelist id='environment-variables' />
56 <title>UDEV directives</title>
58 <para>Directives for configuring systemd units through the
61 <variablelist id='udev-directives' />
65 <title>Network directives</title>
67 <para>Directives for configuring network links through the
68 net-setup-link udev builtin and networks through
69 systemd-networkd.</para>
71 <variablelist id='network-directives' />
75 <title>Journal fields</title>
77 <para>Fields in the journal events with a well known meaning.</para>
79 <variablelist id='journal-directives' />
83 <title>PAM configuration directives</title>
85 <para>Directives for configuring PAM behaviour.</para>
87 <variablelist id='pam-directives' />
91 <title><filename>/etc/crypttab</filename> and
92 <filename>/etc/fstab</filename> options</title>
94 <para>Options which influence mounted filesystems and
95 encrypted volumes.</para>
97 <variablelist id='fstab-options' />
101 <title>System manager directives</title>
103 <para>Directives for configuring the behaviour of the
104 systemd process.</para>
106 <variablelist id='systemd-directives' />
110 <title>command line options</title>
112 <para>Command-line options accepted by programs in the
113 systemd suite.</para>
115 <variablelist id='options' />
119 <title>Constants</title>
121 <para>Various constant used and/or defined by systemd.</para>
123 <variablelist id='constants' />
127 <title>Miscellaneous options and directives</title>
129 <para>Other configuration elements which don't fit in
130 any of the above groups.</para>
132 <variablelist id='miscellaneous' />
136 <title>Files and directories</title>
138 <para>Paths and file names referred to in the
139 documentation.</para>
141 <variablelist id='filenames' />
145 <title>Colophon</title>
146 <para id='colophon' />
152 This index contains {count} entries in {sections} sections,
153 referring to {pages} individual manual pages.
156 def _extract_directives(directive_groups
, formatting
, page
):
158 section
= t
.find('./refmeta/manvolnum').text
159 pagename
= t
.find('./refmeta/refentrytitle').text
161 storopt
= directive_groups
['options']
162 for variablelist
in t
.iterfind('.//variablelist'):
163 klass
= variablelist
.attrib
.get('class')
164 storvar
= directive_groups
[klass
or 'miscellaneous']
165 # <option>s go in OPTIONS, unless class is specified
166 for xpath
, stor
in (('./varlistentry/term/varname', storvar
),
167 ('./varlistentry/term/option',
168 storvar
if klass
else storopt
)):
169 for name
in variablelist
.iterfind(xpath
):
170 text
= re
.sub(r
'([= ]).*', r
'\1', name
.text
).rstrip()
171 stor
[text
].append((pagename
, section
))
172 if text
not in formatting
:
173 # use element as formatted display
174 if name
.text
[-1] in '= ':
179 formatting
[text
] = name
181 storfile
= directive_groups
['filenames']
182 for xpath
, absolute_only
in (('.//refsynopsisdiv//filename', False),
183 ('.//refsynopsisdiv//command', False),
184 ('.//filename', True)):
185 for name
in t
.iterfind(xpath
):
186 if absolute_only
and not (name
.text
and name
.text
.startswith('/')):
188 if name
.attrib
.get('noindex'):
192 if name
.text
.endswith('*'):
193 name
.text
= name
.text
[:-1]
194 if not name
.text
.startswith('.'):
195 text
= name
.text
.partition(' ')[0]
196 if text
!= name
.text
:
199 if text
.endswith('/'):
201 storfile
[text
].append((pagename
, section
))
202 if text
not in formatting
:
203 # use element as formatted display
204 formatting
[text
] = name
206 text
= ' '.join(name
.itertext())
207 storfile
[text
].append((pagename
, section
))
208 formatting
[text
] = name
210 storfile
= directive_groups
['constants']
211 for name
in t
.iterfind('.//constant'):
212 if name
.attrib
.get('noindex'):
215 if name
.text
.startswith('('): # a cast, strip it
216 name
.text
= name
.text
.partition(' ')[2]
217 storfile
[name
.text
].append((pagename
, section
))
218 formatting
[name
.text
] = name
220 def _make_section(template
, name
, directives
, formatting
):
221 varlist
= template
.find(".//*[@id='{}']".format(name
))
222 for varname
, manpages
in sorted(directives
.items()):
223 entry
= tree
.SubElement(varlist
, 'varlistentry')
224 term
= tree
.SubElement(entry
, 'term')
225 display
= deepcopy(formatting
[varname
])
228 para
= tree
.SubElement(tree
.SubElement(entry
, 'listitem'), 'para')
231 for manpage
, manvolume
in sorted(set(manpages
)):
234 b
= tree
.SubElement(para
, 'citerefentry')
235 c
= tree
.SubElement(b
, 'refentrytitle')
237 c
.attrib
['target'] = varname
238 d
= tree
.SubElement(b
, 'manvolnum')
242 def _make_colophon(template
, groups
):
247 for pagelist
in group
.values():
248 pages |
= set(pagelist
)
250 para
= template
.find(".//para[@id='colophon']")
251 para
.text
= COLOPHON
.format(count
=count
,
252 sections
=len(groups
),
255 def _make_page(template
, directive_groups
, formatting
):
256 """Create an XML tree from directive_groups.
259 'class': {'variable': [('manpage', 'manvolume'), ...],
264 for name
, directives
in directive_groups
.items():
265 _make_section(template
, name
, directives
, formatting
)
267 _make_colophon(template
, directive_groups
.values())
271 def make_page(*xml_files
):
272 "Extract directives from xml_files and return XML index tree."
273 template
= tree
.fromstring(TEMPLATE
)
274 names
= [vl
.get('id') for vl
in template
.iterfind('.//variablelist')]
275 directive_groups
= {name
:collections
.defaultdict(list)
278 for page
in xml_files
:
280 _extract_directives(directive_groups
, formatting
, page
)
282 raise ValueError("failed to process " + page
)
284 return _make_page(template
, directive_groups
, formatting
)
286 if __name__
== '__main__':
287 with
open(sys
.argv
[1], 'wb') as f
:
288 f
.write(xml_print(make_page(*sys
.argv
[2:])))