Lots of docs fixes (#1457)

Found by: Various Patch by: Geo Fixes #1452 Fixes #1447 Fixes #1420 Fixes #1418 Fixes #297 * fix tcldocs link * Add putidx to docs * Fix firstscript link and table * Define channl in CHAT bind * Update readme dl link * Update channel mod settings organization * Fix firstscript table * Fix channels doc * Update affected HTML files
eggheads · Jul 8, 2023 · 08efaac · 08efaac
1 parent 7716e43
commit 08efaac
Show file tree

Hide file tree

Showing 10 changed files with 864 additions and 632 deletions.
diff --git a/doc/html/install/readme.html b/doc/html/install/readme.html
@@ -1,23 +1,27 @@
 
 <!DOCTYPE html>
 
-<html lang="en">
+<html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
     <title>README &#8212; Eggdrop 1.9.5 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/eggdrop.css" />
     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
     <script src="../_static/doctools.js"></script>
-    <script src="../_static/sphinx_highlight.js"></script>
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Installing Eggdrop" href="install.html" />
     <link rel="prev" title="Eggdrop, an open source IRC bot" href="../index.html" /> 
   </head><body>
     <div class="header-wrapper" role="banner">
       <div class="header">
+          <p class="logo"><a href="../index.html">
+            <img class="logo" src="../_static/eggman.png.gif" alt="Logo"/>
+          </a></p>
         <div class="headertitle"><a
           href="../index.html">Eggdrop 1.9.5 documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
@@ -109,21 +113,21 @@ <h3 style="margin-top: 1.5em;">Search</h3>
           <div class="body" role="main">
 
   <section id="readme">
-<h1>README<a class="headerlink" href="#readme" title="Permalink to this heading">¶</a></h1>
+<h1>README<a class="headerlink" href="#readme" title="Permalink to this headline">¶</a></h1>
 <blockquote>
 <div><p>Please, at least SKIM this document before asking questions. In fact,
 READ IT if you’ve never successfully set up an Eggdrop bot before.</p>
 </div></blockquote>
 <section id="notice">
-<h2>Notice<a class="headerlink" href="#notice" title="Permalink to this heading">¶</a></h2>
+<h2>Notice<a class="headerlink" href="#notice" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>Make SURE that you select your +n (owner) users wisely. They have 100%
 access to your bot and account. ONLY GIVE THIS POWER TO SOMEONE YOU
 TRUST COMPLETELY!</p>
 </div></blockquote>
 </section>
 <section id="what-is-eggdrop">
-<h2>What is Eggdrop?<a class="headerlink" href="#what-is-eggdrop" title="Permalink to this heading">¶</a></h2>
+<h2>What is Eggdrop?<a class="headerlink" href="#what-is-eggdrop" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>Eggdrop is the world’s most popular Internet Relay Chat (IRC) bot; it is
 freely distributable under the GNU General Public License (GPL). Eggdrop
@@ -160,16 +164,16 @@ <h2>What is Eggdrop?<a class="headerlink" href="#what-is-eggdrop" title="Permali
 </div></blockquote>
 </section>
 <section id="how-to-get-eggdrop">
-<h2>How to Get Eggdrop<a class="headerlink" href="#how-to-get-eggdrop" title="Permalink to this heading">¶</a></h2>
+<h2>How to Get Eggdrop<a class="headerlink" href="#how-to-get-eggdrop" title="Permalink to this headline">¶</a></h2>
 <p>There are two official methods to download Eggdrop source code. Alternately, Eggdrop also comes as a docker image.</p>
 <section id="ftp">
-<h3>FTP<a class="headerlink" href="#ftp" title="Permalink to this heading">¶</a></h3>
+<h3>FTP<a class="headerlink" href="#ftp" title="Permalink to this headline">¶</a></h3>
 <blockquote>
-<div><p>The latest Eggdrop stable source code is always located at <a class="reference external" href="https://geteggdrop.com">https://geteggdrop.com</a>. You can also download the current stable, previous stable, and development snapshot via FTP at <a class="reference external" href="ftp.eggheads.org/pub/Eggdrop/source">ftp.eggheads.org/pub/Eggdrop/source</a></p>
+<div><p>The latest Eggdrop stable source code is always located at <a class="reference external" href="https://geteggdrop.com">https://geteggdrop.com</a>. You can also download the current stable, previous stable, and development snapshot via FTP at <a class="reference external" href="ftp://ftp.eggheads.org/pub/eggdrop/source">ftp://ftp.eggheads.org/pub/eggdrop/source</a></p>
 </div></blockquote>
 </section>
 <section id="git-development-snapshot">
-<h3>Git Development Snapshot<a class="headerlink" href="#git-development-snapshot" title="Permalink to this heading">¶</a></h3>
+<h3>Git Development Snapshot<a class="headerlink" href="#git-development-snapshot" title="Permalink to this headline">¶</a></h3>
 <blockquote>
 <div><p>Eggdrop development has moved from a CVS-based version control system to
 git. If you are interested in trying out the VERY LATEST updates to
@@ -190,7 +194,7 @@ <h3>Git Development Snapshot<a class="headerlink" href="#git-development-snapsho
 </div></blockquote>
 </section>
 <section id="docker">
-<h3>Docker<a class="headerlink" href="#docker" title="Permalink to this heading">¶</a></h3>
+<h3>Docker<a class="headerlink" href="#docker" title="Permalink to this headline">¶</a></h3>
 <blockquote>
 <div><p>You can pull the official Eggdrop Docker image via:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">pull</span> <span class="n">eggdrop</span><span class="p">:</span><span class="n">latest</span>
@@ -201,26 +205,26 @@ <h3>Docker<a class="headerlink" href="#docker" title="Permalink to this heading"
 </section>
 </section>
 <section id="system-pre-requisites">
-<h2>System Pre-Requisites<a class="headerlink" href="#system-pre-requisites" title="Permalink to this heading">¶</a></h2>
+<h2>System Pre-Requisites<a class="headerlink" href="#system-pre-requisites" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>Before you can compile Eggdrop, Tcl must be installed on your system. Many systems have Tcl installed on them by default (you can check by trying the command “tclsh”; if you are given a ‘%’ for a prompt, it is, and you can type ‘exit’ to exit the Tcl shell. However, Eggdrop also requires the Tcl development header files to be installed. They can often be installed via an OS package manager, usually called something similar to ‘tcl-dev’ for the package name. You can also download Tcl source from <a class="reference external" href="https://www.tcl.tk/software/tcltk/download.html">https://www.tcl.tk/software/tcltk/download.html</a>.</p>
 <p>It is also strongly recommended to install openssl (and its development headers) in order to enable SSL/TLS protection of network data. The header files are often called something similar to ‘libssl-dev’.</p>
 </div></blockquote>
 </section>
 <section id="quick-startup">
-<h2>Quick Startup<a class="headerlink" href="#quick-startup" title="Permalink to this heading">¶</a></h2>
+<h2>Quick Startup<a class="headerlink" href="#quick-startup" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>Please see the <a class="reference external" href="install/install.html">Install</a> file after you finish reading this file.</p>
 </div></blockquote>
 </section>
 <section id="upgrading">
-<h2>Upgrading<a class="headerlink" href="#upgrading" title="Permalink to this heading">¶</a></h2>
+<h2>Upgrading<a class="headerlink" href="#upgrading" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>The upgrade process for Eggdrop is very simple, simply download the new source code and repeat the compile process. You will want to read the NEWS for any new configuration file settings you want to add. Please see <a class="reference external" href="install/upgrading.html">Upgrading</a> for full details.</p>
 </div></blockquote>
 </section>
 <section id="command-line">
-<h2>Command Line<a class="headerlink" href="#command-line" title="Permalink to this heading">¶</a></h2>
+<h2>Command Line<a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>Eggdrop has some command line options - not many, because most things
 should be defined through the config file. However, sometimes you may
@@ -251,7 +255,7 @@ <h2>Command Line<a class="headerlink" href="#command-line" title="Permalink to t
 </div></blockquote>
 </section>
 <section id="auto-starting-eggdrop">
-<h2>Auto-starting Eggdrop<a class="headerlink" href="#auto-starting-eggdrop" title="Permalink to this heading">¶</a></h2>
+<h2>Auto-starting Eggdrop<a class="headerlink" href="#auto-starting-eggdrop" title="Permalink to this headline">¶</a></h2>
 <p>Systems go down from time to time, taking your Eggdrop along with it. You may not be not around to restart it manually, so you can instead use features of the operating system to automatically restart Eggdrop should it quit for any reason. Eggdrop comes with an autobotchk shell script that can create either a systemd or crontab entry. The systemd option will monitor your Eggdrop and a) start it when the machine boots and b) restart the Eggdrop if it crashes for any reason. The (older) crontab option will check (by default) every 10 minutes to see if your Eggdrop is still running, and attempt to restart it if it is not.</p>
 <blockquote>
 <div><p>To auto-generate a systemd job, from the Eggdrop install directory, simply run:</p>
@@ -270,7 +274,7 @@ <h2>Auto-starting Eggdrop<a class="headerlink" href="#auto-starting-eggdrop" tit
 </div></blockquote>
 </section>
 <section id="documentation">
-<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">¶</a></h2>
+<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>We’re trying to keep the documentation up to date. If you feel that
 anything is missing here or that anything should be added, etc, please
@@ -279,7 +283,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 </div></blockquote>
 </section>
 <section id="obtaining-help">
-<h2>Obtaining Help<a class="headerlink" href="#obtaining-help" title="Permalink to this heading">¶</a></h2>
+<h2>Obtaining Help<a class="headerlink" href="#obtaining-help" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><p>You can obtain help with Eggdrop in the following IRC channels:</p>
 <blockquote>
@@ -336,8 +340,8 @@ <h2>Obtaining Help<a class="headerlink" href="#obtaining-help" title="Permalink
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2023, Eggheads.
-      Last updated on Mar 11, 2023.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.1.3.
+      Last updated on Jul 08, 2023.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
     </div>
         </div>
         <div class="clearer"></div>

diff --git a/doc/html/modules/mod/channels.html b/doc/html/modules/mod/channels.html
@@ -1,23 +1,27 @@
 
 <!DOCTYPE html>
 
-<html lang="en">
+<html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
     <title>Channels Module &#8212; Eggdrop 1.9.5 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/eggdrop.css" />
     <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
+    <script src="../../_static/jquery.js"></script>
+    <script src="../../_static/underscore.js"></script>
     <script src="../../_static/doctools.js"></script>
-    <script src="../../_static/sphinx_highlight.js"></script>
     <link rel="search" title="Search" href="../../search.html" />
     <link rel="next" title="Compress Module" href="compress.html" />
     <link rel="prev" title="Blowfish Module" href="blowfish.html" /> 
   </head><body>
     <div class="header-wrapper" role="banner">
       <div class="header">
+          <p class="logo"><a href="../../index.html">
+            <img class="logo" src="../../_static/eggman.png.gif" alt="Logo"/>
+          </a></p>
         <div class="headertitle"><a
           href="../../index.html">Eggdrop 1.9.5 documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
@@ -119,7 +123,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
   <p>Last revised: October 25, 2010</p>
 <section id="channels-module">
-<span id="channels"></span><h1>Channels Module<a class="headerlink" href="#channels-module" title="Permalink to this heading">¶</a></h1>
+<span id="channels"></span><h1>Channels Module<a class="headerlink" href="#channels-module" title="Permalink to this headline">¶</a></h1>
 <p>This module provides channel related support for the bot. Without it,
 you won’t be able to make the bot join a channel or save channel specific
 userfile information.</p>
@@ -131,8 +135,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 </div>
 <p>There are also some variables you can set in your config file:</p>
 <blockquote>
-<div><blockquote>
-<div><dl>
+<div><dl class="simple">
 <dt>set chanfile “LamestBot.chan”</dt><dd><p>Enter here the filename where dynamic channel settings are stored.</p>
 </dd>
 <dt>set force-expire 0</dt><dd><p>Set this setting to 1 if you want your bot to expire bans/exempts/invites
@@ -148,20 +151,30 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 Make sure your server supports +ps mixing or you may get endless mode
 floods.</p>
 </dd>
-<dt>channel add #channel { SETTINGS }</dt><dd><p>Add each static channel you want your bot to sit in using this command.
-There are many different possible settings you can insert into this
-command, which are explained below.</p>
-<dl>
-<dt>chanmode +/-&lt;modes&gt;</dt><dd><p>This setting makes the bot enforce channel modes. It will always add
-the +&lt;modes&gt; and remove the -&lt;modes&gt; modes.</p>
+<dt>channel add #channel { SETTINGS }</dt><dd><p>This command adds a static channel to your bot (it cannot be removed via the partyline- we recommend using the .+chan command on the partyline instead). This command will add the channel preconfigured with the specified settings. A full list of settings is defined in <a class="reference internal" href="#channel-settings">Channel Settings</a>.</p>
+</dd>
+<dt>channel set &lt;chan&gt; +/-&lt;setting&gt;</dt><dd><p>This command modifies a specific channel setting for a channel. There are many different options for channels which you can define. A full list of settings is defined in <a class="reference internal" href="#channel-settings">Channel Settings</a>.
+Some settings are enabled or disabled by a plus or minus in front of them, and others directly take text or integer values.</p>
 </dd>
+</dl>
+</div></blockquote>
+<section id="channel-settings">
+<h2>Channel Settings<a class="headerlink" href="#channel-settings" title="Permalink to this headline">¶</a></h2>
+<section id="value-based-channel-settings">
+<h3>Value-based Channel Settings<a class="headerlink" href="#value-based-channel-settings" title="Permalink to this headline">¶</a></h3>
+<blockquote>
+<div><dl>
 <dt>idle-kick 0</dt><dd><p>This setting will make the bot check every minute for idle users. Set
 this to 0 to disable idle check.</p>
 </dd>
 <dt>stopnethack-mode 0</dt><dd><p>This setting will make the bot de-op anyone who enters the channel
 with serverops. There are seven different modes for this settings:</p>
 <blockquote>
 <div><table class="docutils align-default">
+<colgroup>
+<col style="width: 5%" />
+<col style="width: 95%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td><p>0</p></td>
 <td><p>turn off</p></td>
@@ -196,6 +209,10 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 revenging. There are four possible settings:</p>
 <blockquote>
 <div><table class="docutils align-default">
+<colgroup>
+<col style="width: 4%" />
+<col style="width: 96%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td><p>0</p></td>
 <td><p>Deop the user.</p></td>
@@ -217,6 +234,10 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 +k users or when revenge-mode is 3. Available types are:</p>
 <blockquote>
 <div><table class="docutils align-default">
+<colgroup>
+<col style="width: 11%" />
+<col style="width: 89%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td colspan="2"><p>0 *!user&#64;host</p></td>
 </tr>
@@ -270,6 +291,10 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 put both modes on one line.</p>
 <blockquote>
 <div><table class="docutils align-default">
+<colgroup>
+<col style="width: 25%" />
+<col style="width: 75%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td><p>aop-delay 0</p></td>
 <td><p>No delay is used.</p></td>
@@ -337,12 +362,18 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 </dl>
 </dd>
 </dl>
+</div></blockquote>
+</section>
+<section id="enable-disable-channel-settings">
+<h3>Enable/Disable Channel Settings<a class="headerlink" href="#enable-disable-channel-settings" title="Permalink to this headline">¶</a></h3>
+<blockquote>
+<div><dl>
+<dt>chanmode +/-&lt;modes&gt;</dt><dd><p>This setting makes the bot enforce channel modes. It will always enforce
+the +&lt;modes&gt; and remove the -&lt;modes&gt; modes.</p>
 </dd>
 <dt>channel set &lt;chan&gt; +/-&lt;setting&gt;</dt><dd><p>There are many different options for channels which you can define.
 They can be enabled or disabled by a plus or minus in front of them.</p>
-<p>A complete list of all available channel settings:</p>
-<blockquote>
-<div><dl>
+</dd>
 <dt>enforcebans</dt><dd><p>When a ban is set, kick people who are on the channel and match
 the ban?</p>
 </dd>
@@ -430,10 +461,14 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 </dd>
 </dl>
 </div></blockquote>
-</dd>
-</dl>
-<p>The following settings are used as default values when you .+chan #chan or .tcl
-channel add #chan. Look in the section above for explanation of every option.</p>
+</section>
+</section>
+<section id="default-channel-values">
+<h2>Default Channel Values<a class="headerlink" href="#default-channel-values" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><blockquote>
+<div><p>The following settings are used as default values when you .+chan #chan or .tcl
+channel add #chan. You can modify these default values by adding the below values to your config fil. Look in the <a class="reference internal" href="#channel-settings">Channel Settings</a> for an explanation of each option.</p>
 <blockquote>
 <div><p>set default-flood-chan 15:60</p>
 <p>set default-flood-deop 3:10</p>
@@ -486,6 +521,7 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 </div></blockquote>
 <p>Copyright (C) 2000 - 2023 Eggheads Development Team</p>
 </div></blockquote>
+</section>
 </section>
 
 
@@ -515,8 +551,8 @@ <h3 style="margin-top: 1.5em;">Search</h3>
 
     <div class="footer" role="contentinfo">
         &#169; Copyright 2023, Eggheads.
-      Last updated on Mar 11, 2023.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.1.3.
+      Last updated on Jul 08, 2023.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
     </div>
         </div>
         <div class="clearer"></div>