From c1e634bae3f1c3578e7dafc533542eeba6a2cbd5 Mon Sep 17 00:00:00 2001
From: Giovanni Simoni <giovanni.simoni@yubico.com>
Date: Wed, 18 Dec 2024 10:49:41 +0100
Subject: [PATCH] man: update with info about conf file

The SCONFDIR variable is expanded by the build system within
the pam_u2f.8 manpage.
---
 .gitignore                              |  1 +
 configure.ac                            |  1 +
 man/Makefile.am                         |  1 +
 man/{pam_u2f.8.txt => pam_u2f.8.txt.in} | 28 +++++++++++++++++++++++++
 4 files changed, 31 insertions(+)
 rename man/{pam_u2f.8.txt => pam_u2f.8.txt.in} (90%)

diff --git a/.gitignore b/.gitignore
index 85d22b9f..573bd8c4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -35,6 +35,7 @@ m4/ltsugar.m4
 m4/ltversion.m4
 m4/lt~obsolete.m4
 man/pam_u2f.8
+man/pam_u2f.8.txt
 man/pamu2fcfg.1
 pamu2fcfg/cmdline.c
 pamu2fcfg/cmdline.h
diff --git a/configure.ac b/configure.ac
index a52e5676..f780a15a 100644
--- a/configure.ac
+++ b/configure.ac
@@ -115,6 +115,7 @@ AC_CONFIG_FILES([
   tests/Makefile
   fuzz/Makefile
   man/Makefile
+  man/pam_u2f.8.txt
 ])
 
 creduser=$(whoami)
diff --git a/man/Makefile.am b/man/Makefile.am
index 888bb01d..c14e8933 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -4,6 +4,7 @@ dist_man1_MANS = pamu2fcfg.1
 dist_man8_MANS = pam_u2f.8
 MAINTAINERCLEANFILES = $(MANS)
 EXTRA_DIST = $(MANS:=.txt)
+DISTCLEANFILES = pam_u2f.8
 
 SUFFIXES = .1.txt .1 .8.txt .8
 
diff --git a/man/pam_u2f.8.txt b/man/pam_u2f.8.txt.in
similarity index 90%
rename from man/pam_u2f.8.txt
rename to man/pam_u2f.8.txt.in
index 4524d39b..d58c5485 100644
--- a/man/pam_u2f.8.txt
+++ b/man/pam_u2f.8.txt.in
@@ -134,6 +134,12 @@ FIDO devices. It is not possible to mix native credentials and SSH
 credentials. Once this option is enabled all credentials will be parsed
 as SSH.
 
+*conf*=_path/to/pam_u2f.conf_::
+Set an alternative location for the configuration file.
+The supplied path must be absolute and must correspond to an existing
+regular file.
+See *CONFIGURATION FILE*.
+
 == EXAMPLES
 
 Second factor authentication deferring user verification configuration to the
@@ -162,6 +168,28 @@ mapping file in an encrypted home directory, will result in the
 impossibility of logging into the system. The partition is decrypted
 after login and the mapping file can not be accessed.
 
+== CONFIGURATION FILE
+
+A configuration file can be used to set the default module arguments.
+
+- The file has a `name = value` format, with comments starting with the `#`
+  character.
+
+- White spaces at the beginning of line, end of line, and around the `=` sign
+  are ignored.
+
+- Any `conf` argument in the configuration file is ignored.
+
+- The maximum size for the configuration file is 4 KiB.
+
+- The default path for the configuration file is `@SCONFDIR@/pam_u2f.conf`.
+  Note that it may have been set to another value by the distribution.  The
+  default file is allowed to not exist.  An alternative path may be set in the
+  module command line options.
+
+- The options specified on the module command line override the values from the
+  configuration file.
+
 == NOTES
 
 *Nodetect*