]>
git.ipfire.org Git - thirdparty/systemd.git/blob - tools/make-man-index.py
2 # -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
3 # SPDX-License-Identifier: LGPL-2.1+
8 from xml_helper
import xml_parse
, xml_print
, tree
10 MDASH
= ' — ' if sys
.version_info
.major
>= 3 else ' -- '
13 <refentry id="systemd.index" conditional="HAVE_PYTHON">
16 <title>systemd.index</title>
17 <productname>systemd</productname>
21 <refentrytitle>systemd.index</refentrytitle>
22 <manvolnum>7</manvolnum>
26 <refname>systemd.index</refname>
27 <refpurpose>List all manpages from the systemd project</refpurpose>
34 <title>See Also</title>
36 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
44 This index contains {count} entries, referring to {pages} individual manual pages.'
47 def check_id(page
, t
):
48 id = t
.getroot().get('id')
49 if not re
.search('/' + id + '[.]', page
):
50 raise ValueError("id='{}' is not the same as page name '{}'".format(id, page
))
52 def make_index(pages
):
53 index
= collections
.defaultdict(list)
57 section
= t
.find('./refmeta/manvolnum').text
58 refname
= t
.find('./refnamediv/refname').text
59 purpose
= ' '.join(t
.find('./refnamediv/refpurpose').text
.split())
60 for f
in t
.findall('./refnamediv/refname'):
61 infos
= (f
.text
, section
, purpose
, refname
)
62 index
[f
.text
[0].upper()].append(infos
)
65 def add_letter(template
, letter
, pages
):
66 refsect1
= tree
.SubElement(template
, 'refsect1')
67 title
= tree
.SubElement(refsect1
, 'title')
69 para
= tree
.SubElement(refsect1
, 'para')
70 for info
in sorted(pages
, key
=lambda info
: str.lower(info
[0])):
71 refname
, section
, purpose
, realname
= info
73 b
= tree
.SubElement(para
, 'citerefentry')
74 c
= tree
.SubElement(b
, 'refentrytitle')
76 d
= tree
.SubElement(b
, 'manvolnum')
79 b
.tail
= MDASH
+ purpose
# + ' (' + p + ')'
81 tree
.SubElement(para
, 'sbr')
83 def add_summary(template
, indexpages
):
86 for group
in indexpages
:
89 refname
, section
, purpose
, realname
= info
90 pages
.add((realname
, section
))
92 refsect1
= tree
.fromstring(SUMMARY
)
93 template
.append(refsect1
)
95 para
= template
.find(".//para[@id='counts']")
96 para
.text
= COUNTS
.format(count
=count
, pages
=len(pages
))
98 def make_page(*xml_files
):
99 template
= tree
.fromstring(TEMPLATE
)
100 index
= make_index(xml_files
)
102 for letter
in sorted(index
):
103 add_letter(template
, letter
, index
[letter
])
105 add_summary(template
, index
.values())
109 if __name__
== '__main__':
110 with
open(sys
.argv
[1], 'wb') as f
:
111 f
.write(xml_print(make_page(*sys
.argv
[2:])))