1 # -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
3 # This file is part of systemd.
5 # Copyright 2012 Lennart Poettering
6 # Copyright 2013 Zbigniew Jędrzejewski-Szmek
8 # systemd is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU Lesser General Public License as published by
10 # the Free Software Foundation; either version 2.1 of the License, or
11 # (at your option) any later version.
13 # systemd is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 # Lesser General Public License for more details.
18 # You should have received a copy of the GNU Lesser General Public License
19 # along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 import xml.etree.ElementTree as tree
24 MDASH = ' — ' if sys.version_info.major >= 3 else ' -- '
27 <refentry id="systemd.index" conditional="HAVE_PYTHON">
30 <title>systemd.index</title>
31 <productname>systemd</productname>
35 <contrib>Developer</contrib>
36 <firstname>Lennart</firstname>
37 <surname>Poettering</surname>
38 <email>lennart@poettering.net</email>
44 <refentrytitle>systemd.index</refentrytitle>
45 <manvolnum>7</manvolnum>
49 <refname>systemd.index</refname>
50 <refpurpose>List all manpages from the systemd project</refpurpose>
57 <title>See Also</title>
59 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
67 This index contains {count} entries, referring to {pages} individual manual pages.'
69 def make_index(pages):
70 index = collections.defaultdict(list)
73 section = t.find('./refmeta/manvolnum').text
74 refname = t.find('./refnamediv/refname').text
75 purpose = ' '.join(t.find('./refnamediv/refpurpose').text.split())
76 for f in t.findall('./refnamediv/refname'):
77 infos = (f.text, section, purpose, refname)
78 index[f.text[0].upper()].append(infos)
81 def add_letter(template, letter, pages):
82 refsect1 = tree.SubElement(template, 'refsect1')
83 title = tree.SubElement(refsect1, 'title')
85 para = tree.SubElement(refsect1, 'para')
86 for info in sorted(pages, key=lambda info: str.lower(info[0])):
87 refname, section, purpose, realname = info
89 b = tree.SubElement(para, 'citerefentry')
90 c = tree.SubElement(b, 'refentrytitle')
92 d = tree.SubElement(b, 'manvolnum')
95 b.tail = MDASH + purpose # + ' (' + p + ')'
97 tree.SubElement(para, 'sbr')
99 def add_summary(template, indexpages):
102 for group in indexpages:
105 refname, section, purpose, realname = info
106 pages.add((realname, section))
108 refsect1 = tree.fromstring(SUMMARY)
109 template.append(refsect1)
111 para = template.find(".//para[@id='counts']")
112 para.text = COUNTS.format(count=count, pages=len(pages))
114 def make_page(xml_files):
115 template = tree.fromstring(TEMPLATE)
116 index = make_index(xml_files)
118 for letter in sorted(index):
119 add_letter(template, letter, index[letter])
121 add_summary(template, index.values())
125 if __name__ == '__main__':
126 tree.dump(make_page(sys.argv[1:]))