chiark / gitweb /
Also drop <authorgroup> from autogenerated pages
[elogind.git] / tools / make-directive-index.py
index 193f7416f7eec55852850a256f15f36adf5d36a7..ef407324d6602fcff4e5274979f3b71e347c9867 100755 (executable)
@@ -1,26 +1,13 @@
+#!/usr/bin/env python3
 #  -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
+# SPDX-License-Identifier: LGPL-2.1+
 #
-#  This file is part of elogind.
-#
-#  Copyright 2012-2013 Zbigniew Jędrzejewski-Szmek
-#
-#  elogind is free software; you can redistribute it and/or modify it
-#  under the terms of the GNU Lesser General Public License as published by
-#  the Free Software Foundation; either version 2.1 of the License, or
-#  (at your option) any later version.
-#
-#  elogind is distributed in the hope that it will be useful, but
-#  WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-#  Lesser General Public License for more details.
-#
-#  You should have received a copy of the GNU Lesser General Public License
-#  along with elogind; If not, see <http://www.gnu.org/licenses/>.
+#  Copyright © 2012-2013 Zbigniew Jędrzejewski-Szmek
 
 import sys
 import collections
 import re
-from xml_helper import *
+from xml_helper import xml_parse, xml_print, tree
 from copy import deepcopy
 
 TEMPLATE = '''\
@@ -29,15 +16,6 @@ TEMPLATE = '''\
         <refentryinfo>
                 <title>elogind.directives</title>
                 <productname>elogind</productname>
-
-                <authorgroup>
-                        <author>
-                                <contrib>Developer</contrib>
-                                <firstname>Zbigniew</firstname>
-                                <surname>Jędrzejewski-Szmek</surname>
-                                <email>zbyszek@in.waw.pl</email>
-                        </author>
-                </authorgroup>
         </refentryinfo>
 
         <refmeta>
@@ -50,6 +28,24 @@ TEMPLATE = '''\
                 <refpurpose>Index of configuration directives</refpurpose>
         </refnamediv>
 
+        <refsect1>
+                <title>Unit directives</title>
+
+                <para>Directives for configuring units, used in unit
+                files.</para>
+
+                <variablelist id='unit-directives' />
+        </refsect1>
+
+        <refsect1>
+                <title>Options on the kernel command line</title>
+
+                <para>Kernel boot options for configuring the behaviour of the
+                elogind process.</para>
+
+                <variablelist id='kernel-commandline-options' />
+        </refsect1>
+
         <refsect1>
                 <title>Environment variables</title>
 
@@ -59,6 +55,33 @@ TEMPLATE = '''\
                 <variablelist id='environment-variables' />
         </refsect1>
 
+        <refsect1>
+                <title>UDEV directives</title>
+
+                <para>Directives for configuring elogind units through the
+                udev database.</para>
+
+                <variablelist id='udev-directives' />
+        </refsect1>
+
+        <refsect1>
+                <title>Network directives</title>
+
+                <para>Directives for configuring network links through the
+                net-setup-link udev builtin and networks through
+                elogind-networkd.</para>
+
+                <variablelist id='network-directives' />
+        </refsect1>
+
+        <refsect1>
+                <title>Journal fields</title>
+
+                <para>Fields in the journal events with a well known meaning.</para>
+
+                <variablelist id='journal-directives' />
+        </refsect1>
+
         <refsect1>
                 <title>PAM configuration directives</title>
 
@@ -67,6 +90,25 @@ TEMPLATE = '''\
                 <variablelist id='pam-directives' />
         </refsect1>
 
+        <refsect1>
+                <title><filename>/etc/crypttab</filename> and
+                <filename>/etc/fstab</filename> options</title>
+
+                <para>Options which influence mounted filesystems and
+                encrypted volumes.</para>
+
+                <variablelist id='fstab-options' />
+        </refsect1>
+
+        <refsect1>
+                <title>System manager directives</title>
+
+                <para>Directives for configuring the behaviour of the
+                elogind process.</para>
+
+                <variablelist id='elogind-directives' />
+        </refsect1>
+
         <refsect1>
                 <title>command line options</title>