Update docs

eggheads · Oct 14, 2024 · 23c66d1 · 23c66d1
1 parent 594e36f
commit 23c66d1
Show file tree

Hide file tree

Showing 61 changed files with 169 additions and 75 deletions.
diff --git a/FEATURES b/FEATURES
@@ -36,8 +36,8 @@ Eggdrop Features
     -   Console mode: you can view each channel through dcc chat or
         telnet, selectively looking at mode changes, joins and parts,
         channel talk, or any combination of the above.
-    -   Scripting languages: commands and features can be easily added
-        to the bot by means of the Tcl or Python scripting language, giving you
+    -   A scripting language: commands and features can be easily added
+        to the bot by means of the Tcl scripting language, giving you
         the power of TOTAL customization of your bot.
     -   Module support: you can remove/add features to your bot by
         adding or removing modules.

diff --git a/aclocal.m4 b/aclocal.m4
@@ -565,7 +565,7 @@ AC_DEFUN([EGG_CHECK_MODULE_SUPPORT],
 [
   MODULES_OK="yes"
   MOD_EXT="so"
-  DEFAULT_MAKE="debug"
+  DEFAULT_MAKE="eggdrop"
   LOAD_METHOD="dl"
   WEIRD_OS="yes"
   UNKNOWN_OS="no"

diff --git a/configure b/configure
@@ -6266,7 +6266,7 @@ printf "%s\n" "$egg_cv_var_system_release" >&6; }
 
   MODULES_OK="yes"
   MOD_EXT="so"
-  DEFAULT_MAKE="debug"
+  DEFAULT_MAKE="eggdrop"
   LOAD_METHOD="dl"
   WEIRD_OS="yes"
   UNKNOWN_OS="no"

diff --git a/doc/html/about/about.html b/doc/html/about/about.html
@@ -177,7 +177,7 @@ <h1>About Eggdrop<a class="headerlink" href="#about-eggdrop" title="Link to this
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/about/legal.html b/doc/html/about/legal.html
@@ -128,7 +128,7 @@ <h1>Boring legal stuff<a class="headerlink" href="#boring-legal-stuff" title="Li
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/index.html b/doc/html/index.html
@@ -239,9 +239,10 @@ <h2>Where to find more help<a class="headerlink" href="#where-to-find-more-help"
 <li class="toctree-l1"><a class="reference internal" href="using/python.html">Using the Python Module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="using/python.html#system-requirements">System Requirements</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using/python.html#loading-python">Loading Python</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using/python.html#reloading-python-scripts">Reloading Python Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using/python.html#multithreading-and-async">Multithreading and async</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using/python.html#eggdrop-python-commands">Eggdrop Python Commands</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using/python.html#writing-an-eggdrop-python-script">Writing an Eggdrop Python script</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using/python.html#writing-a-module-for-use-with-eggdrop">Writing a module for use with Eggdrop</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="using/twitchinfo.html">Twitch</a><ul>
@@ -419,7 +420,7 @@ <h2>Where to find more help<a class="headerlink" href="#where-to-find-more-help"
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/install/install.html b/doc/html/install/install.html
@@ -283,7 +283,7 @@ <h2>Modules<a class="headerlink" href="#modules" title="Link to this heading">¶
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/install/readme.html b/doc/html/install/readme.html
@@ -365,7 +365,7 @@ <h2>Obtaining Help<a class="headerlink" href="#obtaining-help" title="Link to th
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/install/upgrading.html b/doc/html/install/upgrading.html
@@ -189,7 +189,7 @@ <h3>Documentation<a class="headerlink" href="#documentation" title="Link to this
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/included.html b/doc/html/modules/included.html
@@ -301,7 +301,7 @@ <h1>Modules included with Eggdrop<a class="headerlink" href="#modules-included-w
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/index.html b/doc/html/modules/index.html
@@ -169,7 +169,7 @@ <h3>Do I still need to ‘loadmodule’ modules?<a class="headerlink" href="#do-
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/internals.html b/doc/html/modules/internals.html
@@ -450,7 +450,7 @@ <h2>Summary<a class="headerlink" href="#summary" title="Link to this heading">¶
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/assoc.html b/doc/html/modules/mod/assoc.html
@@ -160,7 +160,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/blowfish.html b/doc/html/modules/mod/blowfish.html
@@ -165,7 +165,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/channels.html b/doc/html/modules/mod/channels.html
@@ -537,7 +537,7 @@ <h2>Default Channel Values<a class="headerlink" href="#default-channel-values" t
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/compress.html b/doc/html/modules/mod/compress.html
@@ -173,7 +173,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/console.html b/doc/html/modules/mod/console.html
@@ -175,7 +175,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/ctcp.html b/doc/html/modules/mod/ctcp.html
@@ -187,7 +187,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/dns.html b/doc/html/modules/mod/dns.html
@@ -188,7 +188,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/filesys.html b/doc/html/modules/mod/filesys.html
@@ -385,7 +385,7 @@ <h3>.filesys module<a class="headerlink" href="#id1" title="Link to this heading
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/ident.html b/doc/html/modules/mod/ident.html
@@ -226,7 +226,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/irc.html b/doc/html/modules/mod/irc.html
@@ -296,7 +296,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/notes.html b/doc/html/modules/mod/notes.html
@@ -183,7 +183,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/pbkdf2.html b/doc/html/modules/mod/pbkdf2.html
@@ -182,7 +182,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/python.html b/doc/html/modules/mod/python.html
@@ -192,7 +192,7 @@ <h3>pysource &lt;path/to/file&gt;<a class="headerlink" href="#pysource-path-to-f
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/seen.html b/doc/html/modules/mod/seen.html
@@ -162,7 +162,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/server.html b/doc/html/modules/mod/server.html
@@ -371,7 +371,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/share.html b/doc/html/modules/mod/share.html
@@ -192,7 +192,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/transfer.html b/doc/html/modules/mod/transfer.html
@@ -181,7 +181,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/twitch.html b/doc/html/modules/mod/twitch.html
@@ -196,7 +196,7 @@ <h2>Partyline commands<a class="headerlink" href="#partyline-commands" title="Li
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/uptime.html b/doc/html/modules/mod/uptime.html
@@ -169,7 +169,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/mod/woobie.html b/doc/html/modules/mod/woobie.html
@@ -161,7 +161,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/modules/writing.html b/doc/html/modules/writing.html
@@ -426,7 +426,7 @@ <h2>What to do with a module?<a class="headerlink" href="#what-to-do-with-a-modu
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/search.html b/doc/html/search.html
@@ -148,7 +148,7 @@ <h1 id="search-documentation">Search</h1>
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js
diff --git a/doc/html/tutorials/firstscript.html b/doc/html/tutorials/firstscript.html
@@ -257,7 +257,7 @@ <h1>Writing an Eggdrop Script<a class="headerlink" href="#writing-an-eggdrop-scr
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/tutorials/firststeps.html b/doc/html/tutorials/firststeps.html
@@ -306,7 +306,7 @@ <h2>Setting up SASL authentication<a class="headerlink" href="#setting-up-sasl-a
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/tutorials/module.html b/doc/html/tutorials/module.html
@@ -353,7 +353,7 @@ <h3>Calling the Bind<a class="headerlink" href="#calling-the-bind" title="Link t
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/tutorials/setup.html b/doc/html/tutorials/setup.html
@@ -293,7 +293,7 @@ <h3>No show?<a class="headerlink" href="#no-show" title="Link to this heading">
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/tutorials/tlssetup.html b/doc/html/tutorials/tlssetup.html
@@ -198,7 +198,7 @@ <h2>Additional Information<a class="headerlink" href="#additional-information" t
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/tutorials/userfilesharing.html b/doc/html/tutorials/userfilesharing.html
@@ -167,7 +167,7 @@ <h2>Explaining the Linking/Sharing Process<a class="headerlink" href="#explainin
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/using/accounts.html b/doc/html/using/accounts.html
@@ -207,7 +207,7 @@ <h2>Using Accounts with Tcl Scripts<a class="headerlink" href="#using-accounts-w
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>

diff --git a/doc/html/using/autoscripts.html b/doc/html/using/autoscripts.html
@@ -332,7 +332,7 @@ <h3>egg_all<a class="headerlink" href="#egg-all" title="Link to this heading">¶
 
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Eggheads.
-      Last updated on Sep 08, 2024.
+      Last updated on Oct 13, 2024.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
     </div>
         </div>