Skip to content

Commit 3bd2d7d

Browse files
committed
man: update with info about conf file
The SCONFDIR variable is expanded by the build system within the pam_u2f.8 manpage.
1 parent c7d280a commit 3bd2d7d

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

man/Makefile.am

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,7 @@ EXTRA_DIST = $(MANS:=.txt)
88
SUFFIXES = .1.txt .1 .8.txt .8
99

1010
.1.txt.1 .8.txt.8:
11-
$(AM_V_GEN)$(A2X) --format=manpage -L -a revdate="Version $(VERSION)" $<
11+
$(AM_V_GEN)$(A2X) --format=manpage -L \
12+
-a sconfdir="$(SCONFDIR)" \
13+
-a revdate="Version $(VERSION)" \
14+
$<

man/pam_u2f.8.txt

+27
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ FIDO devices. It is not possible to mix native credentials and SSH
134134
credentials. Once this option is enabled all credentials will be parsed
135135
as SSH.
136136

137+
*conf*=_path/to/pam_u2f.conf_::
138+
Set an alternative location for the configuration file.
139+
The supplied path must be absolute and must correspond to an existing
140+
regular file.
141+
See *CONFIGURATION FILE*.
142+
137143
== EXAMPLES
138144

139145
Second factor authentication deferring user verification configuration to the
@@ -162,6 +168,27 @@ mapping file in an encrypted home directory, will result in the
162168
impossibility of logging into the system. The partition is decrypted
163169
after login and the mapping file can not be accessed.
164170

171+
== CONFIGURATION FILE
172+
173+
A configuration file can be used to set the default module arguments.
174+
175+
- The file has a `name = value` format, with comments starting with the `#`
176+
character.
177+
178+
- White spaces at the beginning of line, end of line, and around the `=` sign
179+
are ignored.
180+
181+
- Any `conf` argument in the configuration file is ignored.
182+
183+
- The maximum size for the configuration file is 4 KiB.
184+
185+
- The default path for the configuration file is +{sconfdir}/pam_u2f.conf+.
186+
The default file is allowed to not exist. An alternative path may be set in
187+
the module command line options.
188+
189+
- The options specified on the module command line override the values from the
190+
configuration file.
191+
165192
== NOTES
166193

167194
*Nodetect*

0 commit comments

Comments
 (0)