]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
Update the moduledir documentation
authorOndřej Surý <ondrej@sury.org>
Thu, 25 May 2017 10:23:59 +0000 (12:23 +0200)
committerOndřej Surý <ondrej@sury.org>
Fri, 26 May 2017 11:37:31 +0000 (13:37 +0200)
daemon/README.rst
doc/build.rst

index 26301b9fc37b44948063c4ff03ed252317eab861..ba01fb86404383500229036161a55ad2b1fb83f3 100644 (file)
@@ -380,7 +380,15 @@ Environment
    hostname. If called without a parameter, it will return kresd's
    internal hostname, or the system's POSIX hostname (see
    gethostname(2)) if kresd's internal hostname is unset.
-           
+
+.. function:: moduledir([dir])
+
+   :return: Modules directory.
+
+   If called with a parameter, it will change kresd's directory for
+   looking up the dynamic modules.  If called without a parameter, it
+   will return kresd's modules directory.
+   
 .. function:: verbose(true | false)
 
    :return: Toggle verbose logging.
index 2b054b5dd012b30d788e81075c0f6dbb8f13718f..b27ddd7c910ab47bfd430a9cf0ee61e06e8f8caf 100644 (file)
@@ -175,11 +175,11 @@ All paths are prefixed with ``PREFIX`` variable by default if not specified othe
    "library", "``LIBDIR``", "``$(PREFIX)/lib``", "pkg-config is auto-generated [#]_"
    "daemon",  "``SBINDIR``", "``$(PREFIX)/sbin``", ""
    "configuration", "``ETCDIR``", "``$(PREFIX)/etc/kresd``", "Configuration file, templates."
-   "modules", "``MODULEDIR``", "``$(LIBDIR)/kdns_modules``", "[#]_"
+   "modules", "``MODULEDIR``", "``$(LIBDIR)/kdns_modules``", "Runtime directory for loading dynamic modules [#]_."
    "work directory", "", "``$(PREFIX)/var/run/kresd``", "Run directory for daemon."
 
 .. [#] The ``libkres.pc`` is installed in ``$(LIBDIR)/pkgconfig``.
-.. [#] Users may install additional modules in ``~/.local/lib/kdns_modules`` or in the rundir of a specific instance.
+.. [#] The default moduledir can be changed with `-m` option to `kresd` daemon or by calling `moduledir()` function from lua.
 
 .. note:: Each module is self-contained and may install additional bundled files within ``$(MODULEDIR)/$(modulename)``. These files should be read-only, non-executable.