summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobbie Harwood (frozencemetery) <rharwood@redhat.com>2015-08-26 17:06:32 -0400
committerSimo Sorce <simo@redhat.com>2015-09-04 14:27:12 -0400
commit5eb49a01362df71dab345bb276d3d2d0b40aa005 (patch)
tree15d04eb1f70ddce78d59498fbd4fa9ba5e01489d
parentf2385558dd9542ca0a88f3386aa5833a23e5eb8b (diff)
downloadgss-proxy-5eb49a01362df71dab345bb276d3d2d0b40aa005.tar.gz
gss-proxy-5eb49a01362df71dab345bb276d3d2d0b40aa005.tar.xz
gss-proxy-5eb49a01362df71dab345bb276d3d2d0b40aa005.zip
Update man pages for symbolic euids and config snippets
Signed-off-by: Robbie Harwood <rharwood@redhat.com> Reviewed-by: Simo Sorce <simo@redhat.com>
-rw-r--r--proxy/man/gssproxy.8.xml30
-rw-r--r--proxy/man/gssproxy.conf.5.xml17
2 files changed, 40 insertions, 7 deletions
diff --git a/proxy/man/gssproxy.8.xml b/proxy/man/gssproxy.8.xml
index 68f5ff7..809ec20 100644
--- a/proxy/man/gssproxy.8.xml
+++ b/proxy/man/gssproxy.8.xml
@@ -72,9 +72,33 @@
</term>
<listitem>
<para>
- Specify a non-default config file. The default is
- <filename>/etc/gssproxy/gssproxy.conf</filename>. For reference
- on the config file syntax and options, consult the
+ Specify a config file to use as the main config file
+ (read before the rest of the config directory). The
+ default is to use the file
+ <filename>/etc/gssproxy/gssproxy.conf</filename>.
+ For reference on the config file syntax and options,
+ consult the
+ <citerefentry>
+ <refentrytitle>gssproxy.conf</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </citerefentry>
+ manual page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-C</option>,<option>--configdir</option>
+ </term>
+ <listitem>
+ <para>
+ Specify a non-default config dir. Files named of the
+ form "##-foo.conf" (that is, beginning with two digits
+ and a dash, and ending in ".conf") will be read in
+ numeric order from this directory, in addition to the
+ config file itself. The default is
+ <filename>/etc/gssproxy</filename>. For reference on
+ the config file syntax and options, consult the
<citerefentry>
<refentrytitle>gssproxy.conf</refentrytitle>
<manvolnum>5</manvolnum>
diff --git a/proxy/man/gssproxy.conf.5.xml b/proxy/man/gssproxy.conf.5.xml
index 95fdb65..9a79894 100644
--- a/proxy/man/gssproxy.conf.5.xml
+++ b/proxy/man/gssproxy.conf.5.xml
@@ -25,19 +25,26 @@
Optional configuration directives for the gssproxy daemon.
</para>
<para>
- The gssproxy.conf file is a classic ini-style configuration file.
+ GSS-Proxy conf files are classic ini-style configuration files.
Each option consist of a key = value pair.
Any characters behind '#' will be treated as comments and will be ignored.
Boolean parameters accept "1", "true", "yes" and "on" as
positive values. All other values will be considered as negative
values.
</para>
+ <para>
+ GSS-Proxy conf files must either be named "gssproxy.conf", or be
+ of the form "##-foo.conf" (that is, start with two numbers
+ followed by a dash, and end in ".conf"). Files not conforming to
+ this will be ignored unless specifically requested through command
+ line parameters.
+ </para>
</refsect1>
<refsect1 id='sections'>
<title>SECTIONS</title>
<para>
- A section in the gssproxy.conf file is identified by the sectionname in square brackets ([sectionname]).
+ A section in a GSS-Proxy conf file is identified by the sectionname in square brackets ([sectionname]).
</para>
<para>
There is one special section for global gssproxy settings, called
@@ -152,9 +159,11 @@
</varlistentry>
<varlistentry>
- <term>euid (integer)</term>
+ <term>euid (integer or string)</term>
<listitem>
- <para>The numeric effective uid of a running process, required to identify a service.</para>
+ <para>Either the numeric (e.g., 48) or symbolic (e.g.,
+ apache) effective uid of a running process,
+ required to identify a service.</para>
<para>The "euid" parameter is imperative, any section
without it will be discarded.</para>
<para>Default: euid =</para>