|
 |
ed0ebb |
From 98a69ca00e3441128b181b59c06bb06e8c362360 Mon Sep 17 00:00:00 2001
|
|
|
ed0ebb |
From: Sumit Bose <sbose@redhat.com>
|
|
|
ed0ebb |
Date: Fri, 29 Nov 2019 21:57:02 +0100
|
|
|
ed0ebb |
Subject: [PATCH] doc: extend description of config handling
|
|
|
ed0ebb |
|
|
|
ed0ebb |
Related to https://bugzilla.redhat.com/show_bug.cgi?id=1625005
|
|
|
ed0ebb |
---
|
|
|
ed0ebb |
doc/manual/Makefile.am | 8 ++++++++
|
|
|
ed0ebb |
doc/manual/realmd.conf.xml | 15 +++++++++++----
|
|
|
ed0ebb |
doc/privatedir.xml.in | 1 +
|
|
|
ed0ebb |
4 files changed, 21 insertions(+), 4 deletions(-)
|
|
|
ed0ebb |
create mode 100644 doc/privatedir.xml.in
|
|
|
ed0ebb |
|
|
|
ed0ebb |
diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am
|
|
|
ed0ebb |
index 8b33fdd..9812c45 100644
|
|
|
ed0ebb |
--- a/doc/manual/Makefile.am
|
|
|
ed0ebb |
+++ b/doc/manual/Makefile.am
|
|
|
ed0ebb |
@@ -1,14 +1,20 @@
|
|
|
ed0ebb |
+XSLTPROC_FLAGS = --path $(abs_builddir):$(abs_srcdir):$(abs_builddir)/doc
|
|
|
ed0ebb |
|
|
|
ed0ebb |
man8_MANS += \
|
|
|
ed0ebb |
doc/manual/realm.8
|
|
|
ed0ebb |
man5_MANS += \
|
|
|
ed0ebb |
doc/manual/realmd.conf.5
|
|
|
ed0ebb |
|
|
|
ed0ebb |
+$(man5_MANS): doc/privatedir.xml
|
|
|
ed0ebb |
+
|
|
|
ed0ebb |
MAN_IN_FILES = \
|
|
|
ed0ebb |
$(man8_MANS:.8=.xml) \
|
|
|
ed0ebb |
$(man5_MANS:.5=.xml) \
|
|
|
ed0ebb |
$(NULL)
|
|
|
ed0ebb |
|
|
|
ed0ebb |
+doc/privatedir.xml: doc/privatedir.xml.in
|
|
|
ed0ebb |
+ $(V_SED) $(MKDIR_P) $(dir $@) && $(SED_SUBST) $< > $@
|
|
|
ed0ebb |
+
|
|
|
ed0ebb |
MANUAL_DOCBOOK = doc/manual/realmd-docs.xml
|
|
|
ed0ebb |
|
|
|
ed0ebb |
MANUAL_INCLUDES = \
|
|
|
ed0ebb |
@@ -41,6 +47,7 @@ MANUAL_XSLT = \
|
|
|
ed0ebb |
$(NULL)
|
|
|
ed0ebb |
|
|
|
ed0ebb |
EXTRA_DIST += \
|
|
|
ed0ebb |
+ doc/privatedir.xml.in \
|
|
|
ed0ebb |
$(MANUAL_DOCBOOK) \
|
|
|
ed0ebb |
$(MANUAL_INCLUDES) \
|
|
|
ed0ebb |
$(MAN_IN_FILES) \
|
|
|
ed0ebb |
@@ -50,6 +57,7 @@ EXTRA_DIST += \
|
|
|
ed0ebb |
|
|
|
ed0ebb |
CLEANFILES += \
|
|
|
ed0ebb |
realmd-org.freedesktop.realmd.generated \
|
|
|
ed0ebb |
+ doc/privatedir.xml \
|
|
|
ed0ebb |
$(DBUS_DOC_GENERATED) \
|
|
|
ed0ebb |
$(DBUS_ESCAPED) \
|
|
|
ed0ebb |
$(man8_MANS) \
|
|
|
ed0ebb |
diff --git a/doc/manual/realmd.conf.xml b/doc/manual/realmd.conf.xml
|
|
|
ed0ebb |
index 1592291..9062252 100644
|
|
|
ed0ebb |
--- a/doc/manual/realmd.conf.xml
|
|
|
ed0ebb |
+++ b/doc/manual/realmd.conf.xml
|
|
|
ed0ebb |
@@ -1,6 +1,9 @@
|
|
|
ed0ebb |
|
|
|
ed0ebb |
|
|
|
ed0ebb |
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
ed0ebb |
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
|
ed0ebb |
+[
|
|
|
ed0ebb |
+
|
|
|
ed0ebb |
+]>
|
|
|
ed0ebb |
|
|
|
ed0ebb |
<refentry id="realmd-conf">
|
|
|
ed0ebb |
|
|
|
ed0ebb |
@@ -35,7 +38,9 @@
|
|
|
ed0ebb |
to act in specific ways. This is done by placing settings in a
|
|
|
ed0ebb |
<filename>/etc/realmd.conf</filename>. This file does not exist by
|
|
|
ed0ebb |
default. The syntax of this file is the same as an INI file or
|
|
|
ed0ebb |
- Desktop Entry file.</para>
|
|
|
ed0ebb |
+ Desktop Entry file. If the file is changed and
|
|
|
ed0ebb |
+ <command>realmd</command> is running <command>realmd</command> must be
|
|
|
ed0ebb |
+ restarted to read the new values.</para>
|
|
|
ed0ebb |
|
|
|
ed0ebb |
<para>In general, settings in this file only apply at the point of
|
|
|
ed0ebb |
joining a domain or realm. Once the realm has been setup the settings
|
|
|
ed0ebb |
@@ -46,8 +51,10 @@
|
|
|
ed0ebb |
|
|
|
ed0ebb |
<para>Only specify the settings you wish to override in the
|
|
|
ed0ebb |
<filename>/etc/realmd.conf</filename> file. Settings not specified will
|
|
|
ed0ebb |
- be loaded from their packaged defaults. Only override the settings
|
|
|
ed0ebb |
- below. You may find other settings if you look through the
|
|
|
ed0ebb |
+ be loaded from their packaged defaults which can be found in
|
|
|
ed0ebb |
+ <filename>&privatedir;/realmd-defaults.conf</filename> and
|
|
|
ed0ebb |
+ <filename>&privatedir;/realmd-distro.conf</filename>. Only override the
|
|
|
ed0ebb |
+ settings below. You may find other settings if you look through the
|
|
|
ed0ebb |
<command>realmd</command> source code. However these are not guaranteed
|
|
|
ed0ebb |
to remain stable.</para>
|
|
|
ed0ebb |
|
|
|
ed0ebb |
diff --git a/doc/privatedir.xml.in b/doc/privatedir.xml.in
|
|
|
ed0ebb |
new file mode 100644
|
|
|
ed0ebb |
index 0000000..7f71afe
|
|
|
ed0ebb |
--- /dev/null
|
|
|
ed0ebb |
+++ b/doc/privatedir.xml.in
|
|
|
ed0ebb |
@@ -0,0 +1 @@
|
|
|
ed0ebb |
+@privatedir@
|
|
|
ed0ebb |
\ No newline at end of file
|
|
|
ed0ebb |
--
|
|
|
ed0ebb |
2.26.2
|
|
|
ed0ebb |
|