From cf2fc5ff7b4a8555fda2a5ebe5f6ab0e45c22996 Mon Sep 17 00:00:00 2001
From: Stefan Schubert <schubi@suse.de>
Date: Tue, 25 Oct 2022 16:29:41 +0200
Subject: doc: Update PAM documentation from DockBook 4 to DocBook 5

Changed files
--------------

Make.xml.rules.in:
- Using RNG file instead of DTD file for checking XML files.
- Taking the correct stylesheet for README files.

doc/sag/Makefile.am, doc/adg/Makefile.am, doc/mwg/Makefile.am:
- Using RNG file instead of DTD file for checking XML files.

configure.ac:
- Adding a new option for selecting RNG check file (-enable-docbook-rng)
- Switching stylesheets to docbook 5
- Checking DocBook 5 environment instead of DocBook 4 environment

*.xml:
Update from DockBook 4 to DocBook 5
---
 modules/pam_env/README.xml         | 34 +++++---------------
 modules/pam_env/pam_env.8.xml      | 63 ++++++++++++++++++--------------------
 modules/pam_env/pam_env.conf.5.xml | 19 +++++-------
 3 files changed, 46 insertions(+), 70 deletions(-)

(limited to 'modules/pam_env')

diff --git a/modules/pam_env/README.xml b/modules/pam_env/README.xml
index 21a9b855..8becf870 100644
--- a/modules/pam_env/README.xml
+++ b/modules/pam_env/README.xml
@@ -1,39 +1,21 @@
-<?xml version="1.0" encoding='UTF-8'?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.docbook.org/xml/4.3/docbookx.dtd"
-[
-<!--
-<!ENTITY pamaccess SYSTEM "pam_env.8.xml">
--->
-<!--
-<!ENTITY accessconf SYSTEM "pam_env.conf.5.xml">
--->
-]>
-
-<article>
-
-  <articleinfo>
+<article xmlns="http://docbook.org/ns/docbook" version="5.0">
 
+  <info>
     <title>
-      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
-      href="pam_env.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_env-name"]/*)'/>
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="pam_env.8.xml" xpointer='xpointer(id("pam_env-name")/*)'/>
     </title>
-
-  </articleinfo>
+  </info>
 
   <section>
-    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
-      href="pam_env.8.xml" xpointer='xpointer(//refsect1[@id = "pam_env-description"]/*)'/>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="pam_env.8.xml" xpointer='xpointer(id("pam_env-description")/*)'/>
   </section>
 
   <section>
-    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
-      href="pam_env.8.xml" xpointer='xpointer(//refsect1[@id = "pam_env-options"]/*)'/>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="pam_env.8.xml" xpointer='xpointer(id("pam_env-options")/*)'/>
   </section>
 
   <section>
-    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
-      href="pam_env.conf.5.xml" xpointer='xpointer(//refsect1[@id = "pam_env.conf-examples"]/*)'/>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="pam_env.conf.5.xml" xpointer='xpointer(id("pam_env.conf-examples")/*)'/>
   </section>
 
-</article>
+</article>
\ No newline at end of file
diff --git a/modules/pam_env/pam_env.8.xml b/modules/pam_env/pam_env.8.xml
index d7687d6c..fb172e17 100644
--- a/modules/pam_env/pam_env.8.xml
+++ b/modules/pam_env/pam_env.8.xml
@@ -1,16 +1,13 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id='pam_env'>
+<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="pam_env">
 
   <refmeta>
     <refentrytitle>pam_env</refentrytitle>
     <manvolnum>8</manvolnum>
-    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
+    <refmiscinfo class="source">Linux-PAM</refmiscinfo>
+    <refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
   </refmeta>
 
-  <refnamediv id='pam_env-name'>
+  <refnamediv xml:id="pam_env-name">
     <refname>pam_env</refname>
     <refpurpose>
       PAM module to set/unset environment variables
@@ -20,31 +17,31 @@
 <!-- body begins here -->
 
   <refsynopsisdiv>
-    <cmdsynopsis id="pam_env-cmdsynopsis">
+    <cmdsynopsis xml:id="pam_env-cmdsynopsis" sepchar=" ">
       <command>pam_env.so</command>
-      <arg choice="opt">
+      <arg choice="opt" rep="norepeat">
         debug
       </arg>
-      <arg choice="opt">
+      <arg choice="opt" rep="norepeat">
         conffile=<replaceable>conf-file</replaceable>
       </arg>
-      <arg choice="opt">
+      <arg choice="opt" rep="norepeat">
         envfile=<replaceable>env-file</replaceable>
       </arg>
-      <arg choice="opt">
+      <arg choice="opt" rep="norepeat">
         readenv=<replaceable>0|1</replaceable>
       </arg>
-      <arg choice="opt">
+      <arg choice="opt" rep="norepeat">
         user_envfile=<replaceable>env-file</replaceable>
       </arg>
-      <arg choice="opt">
+      <arg choice="opt" rep="norepeat">
         user_readenv=<replaceable>0|1</replaceable>
       </arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
 
-  <refsect1 id="pam_env-description">
+  <refsect1 xml:id="pam_env-description">
     <title>DESCRIPTION</title>
     <para>
       The pam_env PAM module allows the (un)setting of environment
@@ -119,13 +116,13 @@
     </para>
   </refsect1>
 
-  <refsect1 id="pam_env-options">
+  <refsect1 xml:id="pam_env-options">
     <title>OPTIONS</title>
     <variablelist>
 
       <varlistentry>
         <term>
-          <option>conffile=<replaceable>/path/to/pam_env.conf</replaceable></option>
+          conffile=/path/to/pam_env.conf
         </term>
         <listitem>
           <para>
@@ -138,7 +135,7 @@
 
       <varlistentry>
         <term>
-          <option>debug</option>
+          debug
         </term>
         <listitem>
           <para>
@@ -150,7 +147,7 @@
 
       <varlistentry>
         <term>
-          <option>envfile=<replaceable>/path/to/environment</replaceable></option>
+          envfile=/path/to/environment
         </term>
         <listitem>
           <para>
@@ -166,7 +163,7 @@
 
       <varlistentry>
         <term>
-          <option>readenv=<replaceable>0|1</replaceable></option>
+          readenv=0|1
         </term>
         <listitem>
           <para>
@@ -179,7 +176,7 @@
 
       <varlistentry>
         <term>
-          <option>user_envfile=<replaceable>filename</replaceable></option>
+          user_envfile=filename
         </term>
         <listitem>
           <para>
@@ -195,7 +192,7 @@
 
       <varlistentry>
         <term>
-          <option>user_readenv=<replaceable>0|1</replaceable></option>
+          user_readenv=0|1
         </term>
         <listitem>
           <para>
@@ -216,7 +213,7 @@
     </variablelist>
   </refsect1>
 
-  <refsect1 id="pam_env-types">
+  <refsect1 xml:id="pam_env-types">
     <title>MODULE TYPES PROVIDED</title>
     <para>
       The <option>auth</option> and <option>session</option> module
@@ -224,7 +221,7 @@
     </para>
   </refsect1>
 
-  <refsect1 id="pam_env-return_values">
+  <refsect1 xml:id="pam_env-return_values">
     <title>RETURN VALUES</title>
     <variablelist>
       <varlistentry>
@@ -262,25 +259,25 @@
     </variablelist>
   </refsect1>
 
-  <refsect1 id="pam_env-files">
+  <refsect1 xml:id="pam_env-files">
     <title>FILES</title>
     <variablelist>
       <varlistentry>
-        <term condition="with_vendordir"><filename>/usr/etc/security/pam_env.conf</filename></term>
-        <term><filename>/etc/security/pam_env.conf</filename></term>
+        <term condition="with_vendordir">%vendordir%/security/pam_env.conf</term>
+        <term>/etc/security/pam_env.conf</term>
         <listitem>
           <para>Default configuration file</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term condition="with_vendordir"><filename>/usr/etc/environment</filename></term>
-        <term><filename>/etc/environment</filename></term>
+        <term condition="with_vendordir">%vendordir%/environment</term>
+        <term>/etc/environment</term>
         <listitem>
           <para>Default environment file</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><filename>$HOME/.pam_environment</filename></term>
+        <term>$HOME/.pam_environment</term>
         <listitem>
           <para>User specific environment file</para>
         </listitem>
@@ -288,7 +285,7 @@
     </variablelist>
   </refsect1>
 
-  <refsect1 id="pam_env-see_also">
+  <refsect1 xml:id="pam_env-see_also">
     <title>SEE ALSO</title>
     <para>
       <citerefentry>
@@ -306,10 +303,10 @@
     </para>
   </refsect1>
 
-  <refsect1 id="pam_env-authors">
+  <refsect1 xml:id="pam_env-authors">
     <title>AUTHOR</title>
     <para>
       pam_env was written by Dave Kinchlea &lt;kinch@kinch.ark.com&gt;.
     </para>
   </refsect1>
-</refentry>
+</refentry>
\ No newline at end of file
diff --git a/modules/pam_env/pam_env.conf.5.xml b/modules/pam_env/pam_env.conf.5.xml
index 5c0dbcb8..662ff0a0 100644
--- a/modules/pam_env/pam_env.conf.5.xml
+++ b/modules/pam_env/pam_env.conf.5.xml
@@ -1,13 +1,10 @@
-<?xml version="1.0" encoding='UTF-8'?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-        "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
-
-<refentry id="pam_env.conf">
+<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="pam_env.conf">
 
   <refmeta>
     <refentrytitle>pam_env.conf</refentrytitle>
     <manvolnum>5</manvolnum>
-    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
+    <refmiscinfo class="source">Linux-PAM</refmiscinfo>
+    <refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
   </refmeta>
 
   <refnamediv>
@@ -17,7 +14,7 @@
   </refnamediv>
 
 
-  <refsect1 id='pam_env.conf-description'>
+  <refsect1 xml:id="pam_env.conf-description">
     <title>DESCRIPTION</title>
 
     <para condition="with_vendordir">
@@ -87,7 +84,7 @@
     </para>
   </refsect1>
 
-  <refsect1 id="pam_env.conf-examples">
+  <refsect1 xml:id="pam_env.conf-examples">
     <title>EXAMPLES</title>
     <para>
       These are some example lines which might be specified in
@@ -133,7 +130,7 @@
     </programlisting>
   </refsect1>
 
-  <refsect1 id="pam_env.conf-see_also">
+  <refsect1 xml:id="pam_env.conf-see_also">
     <title>SEE ALSO</title>
     <para>
       <citerefentry><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
@@ -143,10 +140,10 @@
     </para>
   </refsect1>
 
-  <refsect1 id="pam_env.conf-author">
+  <refsect1 xml:id="pam_env.conf-author">
     <title>AUTHOR</title>
     <para>
       pam_env was written by Dave Kinchlea &lt;kinch@kinch.ark.com&gt;.
     </para>
   </refsect1>
-</refentry>
+</refentry>
\ No newline at end of file
-- 
cgit v1.2.3