summaryrefslogtreecommitdiffstats
path: root/src/modules/rlm_unix/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/rlm_unix/README.md')
-rw-r--r--src/modules/rlm_unix/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/modules/rlm_unix/README.md b/src/modules/rlm_unix/README.md
new file mode 100644
index 0000000..46b4b23
--- /dev/null
+++ b/src/modules/rlm_unix/README.md
@@ -0,0 +1,15 @@
+# rlm_unix
+## Metadata
+<dl>
+ <dt>category</dt><dd>datastore</dd>
+</dl>
+
+## Summary
+
+Retrieves a user's encrypted password from the local system and
+places it into the `&control:Crypt-Password` attribute. The
+password is retrieved via the `getpwent()` and `getspwent()`
+system calls.
+
+When used for accounting, works in conjunction with rlm_radutmp to
+update the utmp database.