weeWX fixes in install pages. more fixes to utilities.

2026-04-18 08:36:54 -04:00 · 2017-01-26 20:25:42 -05:00
parent cb8616a46c
commit a4002dbb8a
7 changed files with 39 additions and 41 deletions
--- a/docs/debian.htm
+++ b/docs/debian.htm
@@ -11,7 +11,7 @@
 </head>
 <body>

-<h1 class="title">weewx: Installation on Debian-based systems
+<h1 class="title">weeWX: Installation on Debian-based systems
    <div class='os-icons'>
        <img class='logo' src='images/logo-debian.png' alt=""/>
        <img class='logo' src='images/logo-ubuntu.png' alt=""/>
@@ -21,7 +21,7 @@
    <div style="clear: both"></div>
 </h1>

-<p>This is a guide to installing <span class='code'>weewx</span> from a DEB package on Debian-based systems, including Ubuntu, Mint, and Raspbian.
+<p>This is a guide to installing weeWX from a DEB package on Debian-based systems, including Ubuntu, Mint, and Raspbian.
 </p>

 <h2>Download</h2>
@@ -43,7 +43,7 @@ sudo apt-get -f install</pre>
 </p>

 <h2>Status</h2>
-<p>To make sure things are running properly look in the system log for messages from <span class='code'>weewx</span>.
+<p>To make sure things are running properly look in the system log for messages from weeWX.
 </p>
 <pre class='tty cmd'>sudo tail -f /var/log/syslog</pre>

@@ -58,19 +58,19 @@ sudo apt-get -f install</pre>
 <p>To enable uploads such as Weather Underground or to customize reports, modify the configuration file <span class='code'>/etc/weewx/weewx.conf</span>. See the <a href="usersguide.htm">User Guide</a> and <a href="customizing.htm">Customization Guide</a> for details.
 </p>

-<p><span class='code'>weewx</span> must be restarted for configuration file changes to take effect.
+<p>WeeWX must be restarted for configuration file changes to take effect.
 </p>

 <h2>Start/Stop</h2>
-<p>To start/stop <span class='code'>weewx</span>:</p>
+<p>To start/stop weeWX:</p>
 <pre class='tty cmd'>sudo /etc/init.d/weewx start
 sudo /etc/init.d/weewx stop</pre>

 <h2>Uninstall</h2>
-<p>To uninstall <span class='code'>weewx</span> but retain configuration files and data:
+<p>To uninstall weeWX but retain configuration files and data:
 </p>
 <pre class='tty cmd'>sudo dpkg -r weewx</pre>
-<p>To uninstall <span class='code'>weewx</span>, removing configuration files but retaining data:
+<p>To uninstall weeWX, removing configuration files but retaining data:
 </p>
 <pre class='tty cmd'>sudo dpkg --purge weewx</pre>
 <p>To remove data:</p>
--- a/docs/devnotes.htm
+++ b/docs/devnotes.htm
@@ -287,7 +287,7 @@ now = datetime.datetime()</pre>
                </td>
            </tr>
            <tr>
-                <td class="text_highlight"><span class="code">config_dict</span></td>
+                <td class="text_highlight code">config_dict</td>
                <td>All configuration information used by weeWX is stored in the <em>configuration file</em>, usually
                    with the name <span class="code">weewx.conf</span>. By convention, when this file is read into the
                    program, it is called <span class="code">config_dict</span>, an instance of the class <span
@@ -339,7 +339,7 @@ now = datetime.datetime()</pre>
                </td>
            </tr>
            <tr>
-                <td class="text_highlight"><span class="code">skin_dict</span></td>
+                <td class="text_highlight code">skin_dict</td>
                <td>All configuration information used by a particular skin is stored in the <em>skin configuration
                    file</em>, usually with the name <span class="code">skin.conf</span>. By convention, when this file
                    is read into the program, it is called <span class="code">skin_dict</span>, an instance of the class
--- a/docs/macos.htm
+++ b/docs/macos.htm
@@ -11,14 +11,14 @@
 </head>
 <body>

-<h1 class="title">weewx: Installation on macOS systems
+<h1 class="title">weeWX: Installation on macOS systems
    <div class='os-icons'>
        <img class='logo' src='images/logo-apple.png' alt=""/>
    </div>
    <div style="clear: both"></div>
 </h1>

-<p>This is a guide to installing <span class='code'>weewx</span> on macOS.</p>
+<p>This is a guide to installing weeWX on macOS.</p>

 <h2>Download</h2>

@@ -43,7 +43,7 @@ sudo easy_install pyephem</pre>
 <pre class='tty cmd'>xcode-select --install</pre>
 <p>then try the easy_install again.</p>

-<h2>Install <span class='code'>weewx</span></h2>
+<h2>Install weeWX</h2>
 <p>Expand the source archive:</p>
 <pre class="tty cmd">tar xvfz weewx-X.Y.Z.tar.gz</pre>
 <p>Change directory:</p>
@@ -66,7 +66,7 @@ sudo easy_install pyephem</pre>
 sudo launchctl load /Library/LaunchDaemons/com.weewx.weewxd.plist</pre>

 <h2>Status</h2>
-<p>To make sure things are running properly, look in the system log for messages from <span class='code'>weewx</span>.  Run the <span class="code">Console</span> application and select <span class="code">All Messages</span>.
+<p>To make sure things are running properly, look in the system log for messages from weeWX.  Run the <span class="code">Console</span> application and select <span class="code">All Messages</span>.
 </p>

 <h2>Verify</h2>
@@ -80,16 +80,16 @@ sudo launchctl load /Library/LaunchDaemons/com.weewx.weewxd.plist</pre>
 <p>To enable uploads such as Weather Underground or to customize reports, modify the configuration file <span class='code'>/Users/Shared/weewx/weewx.conf</span>. See the <a href="usersguide.htm">User Guide</a> and <a href="customizing.htm">Customization Guide</a> for details.
 </p>

-<p><span class='code'>weewx</span> must be restarted for configuration file changes to take effect.
+<p>WeeWX must be restarted for configuration file changes to take effect.
 </p>

 <h2>Start/Stop</h2>
-<p>To start/stop <span class='code'>weewx</span>:</p>
+<p>To start/stop weeWX:</p>
 <pre class='tty cmd'>sudo launchctl load /Library/LaunchDaemons/com.weewx.weewxd.plist
 sudo launchctl unload /Library/LaunchDaemons/com.weewx.weewxd.plist</pre>

 <h2>Uninstall</h2>
-<p>To uninstall, simply delete the directory <span class='code'>/Users/Shared/weewx</span>.  This will delete weewx, configuration files, and data.</p>
+<p>To uninstall, simply delete the directory <span class='code'>/Users/Shared/weewx</span>.  This will delete weeWX, configuration files, and data.</p>
 <pre class='tty cmd'>rm -r /Users/Shared/weewx
 sudo rm /Library/LaunchDaemons/com.weewx.weewxd.plist</pre>

--- a/docs/redhat.htm
+++ b/docs/redhat.htm
@@ -11,7 +11,7 @@
 </head>
 <body>

-<h1 class="title">weewx: Installation on Redhat-based systems
+<h1 class="title">weeWX: Installation on Redhat-based systems
    <div class='os-icons'>      
        <img class='logo' src='images/logo-redhat.png' alt=""/>
        <img class='logo' src='images/logo-centos.png' alt=""/>
@@ -21,7 +21,7 @@
 </h1>

 <p>
-    This is a guide to installing <span class='code'>weewx</span> from an RPM package on systems such as Redhat, CentOS or Fedora.
+    This is a guide to installing weeWX from an RPM package on systems such as Redhat, CentOS or Fedora.
 </p>

 <h2>Download</h2>
@@ -56,7 +56,7 @@ sudo easy_install pyusb</pre>

 <h2>Status</h2>
 <p>
-    Look in the system log for messages from <span class='code'>weewx</span>.
+    Look in the system log for messages from weeWX.
 </p>
 <pre class='tty cmd'>sudo tail -f /var/log/messages</pre>

@@ -68,14 +68,14 @@ sudo easy_install pyusb</pre>

 <h2>Configure</h2>
 <p>
-    The default installation uses Simulator as the <span class='code'>station_type</span>.  To use real hardware, stop <span class='code'>weewx</span>, change to the actual station type and station parameters, delete the simulation data, then restart <span class='code'>weewx</span>:</p>
+    The default installation uses Simulator as the <span class='code'>station_type</span>.  To use real hardware, stop weeWX, change to the actual station type and station parameters, delete the simulation data, then restart weeWX:</p>
 <pre class='tty cmd'>sudo /etc/init.d/weewx stop
 sudo wee_config --reconfigure
 sudo rm /var/lib/weewx/weewx.sdb
 sudo /etc/init.d/weewx start</pre>

 <h2>Start/Stop</h2>
-<p>To start/stop <span class='code'>weewx</span>:</p>
+<p>To start/stop weeWX:</p>
 <pre class='tty cmd'>sudo /etc/init.d/weewx start
 sudo /etc/init.d/weewx stop</pre>

@@ -84,11 +84,11 @@ sudo /etc/init.d/weewx stop</pre>
    To enable uploads such as Weather Underground or to customize reports, modify the configuration file <span class='code'>/etc/weewx/weewx.conf</span>.  See the <a href="usersguide.htm">User Guide</a> and <a href="customizing.htm">Customization Guide</a> for details.
 </p>
 <p>
-    <span class='code'>weewx</span> must be restarted for configuration file changes to take effect.
+    WeeWX must be restarted for configuration file changes to take effect.
 </p>

 <h2>Uninstall</h2>
-<p>To uninstall <span class='code'>weewx</span>, removing configuration files but retaining data:</p>
+<p>To uninstall weeWX, removing configuration files but retaining data:</p>
 <pre class='tty cmd'>sudo rpm -e weewx</pre>
 <p>To remove data:</p>
 <pre class='tty cmd'>sudo rm -r /var/lib/weewx
--- a/docs/setup.htm
+++ b/docs/setup.htm
@@ -12,7 +12,7 @@

 <body>

-<h1 class="title">weewx: Installation using setup.py
+<h1 class="title">weeWX: Installation using setup.py
    <div class='os-icons'>
        <img class='logo' src='images/logo-linux.png' alt=""/>
        <img class='logo' src='images/logo-debian.png' alt=""/>
@@ -27,8 +27,7 @@
    <div style="clear: both"></div>
 </h1>

-<p>These are generic instructions for installing
-    <span class="code">weewx</span> using the Python utility
+<p>These are generic instructions for installing weeWX using the Python utility
    <span class="code">setup.py</span>.
 </p>

@@ -135,7 +134,7 @@ sudo pip install pyusb</span>
    </div>
 </div>

-<h2>Install <span class='code'>weewx</span></h2>
+<h2>Install weeWX</h2>

 <p>Expand the source archive:</p>
 <pre class="tty cmd">tar xvfz weewx-X.Y.Z.tar.gz</pre>
@@ -192,7 +191,7 @@ sudo /etc/init.d/weewx start</pre>
 <h2>Status</h2>

 <p>
-    Look in the system log for messages from <span class='code'>weewx</span>.
+    Look in the system log for messages from weeWX.
    For example, on Debian systems:
 </p>
 <pre class='tty cmd'>sudo tail -f /var/log/syslog</pre>
@@ -221,15 +220,14 @@ sudo /etc/init.d/weewx start</pre>
 </p>

 <p>
-    <span class='code'>weewx</span> must be restarted for configuration file
-    changes to take effect.
+    WeeWX must be restarted for configuration file changes to take effect.
 </p>

 <h2>Uninstall</h2>

 <p>
    To uninstall, simply delete the directory
-    <span class='code'>/home/weewx</span>. This will delete weewx,
+    <span class='code'>/home/weewx</span>. This will delete weeWX,
    configuration files, and data.
 </p>
 <pre class='tty cmd'>sudo rm -r /home/weewx
@@ -237,7 +235,7 @@ sudo rm /etc/init.d/weewx</pre>

 <h2>Layout</h2>

-<p>The installation will place <span class="code">weewx</span> in the
+<p>The installation will place weeWX in the
    <span class="code">/home/weewx</span> directory with the following
    layout: </p>
 <table class='locations' style="width:50%">
--- a/docs/suse.htm
+++ b/docs/suse.htm
@@ -11,7 +11,7 @@
 </head>
 <body>

-<h1 class="title">weewx: Installation on SuSE-based systems
+<h1 class="title">weeWX: Installation on SuSE-based systems
    <div class='os-icons'>      
        <img class='logo' src='images/logo-suse.png' alt=""/>
        <img class='logo' src='images/logo-opensuse.png' alt=""/>
@@ -20,7 +20,7 @@
 </h1>

 <p>
-    This is a guide to installing <span class='code'>weewx</span>
+    This is a guide to installing weeWX
    from an RPM package on systems such as SuSE or OpenSUSE.
 </p>

@@ -52,7 +52,7 @@ sudo zypper install python-usb</pre>

 <h2>Status</h2>
 <p>
-    Look in the system log for messages from <span class='code'>weewx</span>.
+    Look in the system log for messages from weeWX.
 </p>
 <pre class='tty cmd'>sudo tail -f /var/log/messages</pre>

@@ -64,7 +64,7 @@ sudo zypper install python-usb</pre>

 <h2>Configure</h2>
 <p>
-    The default installation uses Simulator as the <span class='code'>station_type</span>.  To use real hardware, stop <span class='code'>weewx</span>, change to the actual station type and station parameters, delete the simulation data, then restart <span class='code'>weewx</span>:
+    The default installation uses Simulator as the <span class='code'>station_type</span>.  To use real hardware, stop weeWX, change to the actual station type and station parameters, delete the simulation data, then restart weeWX:
 </p>
 <pre class='tty cmd'>sudo /etc/init.d/weewx stop
 sudo wee_config --reconfigure
@@ -72,7 +72,7 @@ sudo rm /var/lib/weewx/weewx.sdb
 sudo /etc/init.d/weewx start</pre>

 <h2>Start/Stop</h2>
-<p>To start/stop <span class='code'>weewx</span>:</p>
+<p>To start/stop weeWX:</p>
 <pre class='tty cmd'>sudo /etc/init.d/weewx start
 sudo /etc/init.d/weewx stop</pre>

@@ -81,11 +81,11 @@ sudo /etc/init.d/weewx stop</pre>
    To enable uploads such as Weather Underground or to customize reports, modify the configuration file <span class='code'>/etc/weewx/weewx.conf</span>.  See the <a href="usersguide.htm">User Guide</a> and <a href="customizing.htm">Customization Guide</a> for details.
 </p>
 <p>
-    <span class='code'>weewx</span> must be restarted for configuration file changes to take effect.
+    WeeWX must be restarted for configuration file changes to take effect.
 </p>

 <h2>Uninstall</h2>
-<p>To uninstall <span class='code'>weewx</span>, removing configuration files but retaining data:</p>
+<p>To uninstall weeWX, removing configuration files but retaining data:</p>
 <pre class='tty cmd'>sudo rpm -e weewx</pre>
 <p>To remove data:</p>
 <pre class='tty cmd'>sudo rm -r /var/lib/weewx
--- a/docs/utilities.htm
+++ b/docs/utilities.htm
@@ -337,10 +337,10 @@ Usage: wee_database --help
       wee_database --transfer --dest-binding=BINDING_NAME [--dry-run]
       wee_database --check
       wee_database --update [--dry-run]
-       wee_database --check-strings
+       wee_database --check-strings [--dry-run]
       wee_database --fix-strings
       wee_database --drop-daily
-       wee_database --rebuild-daily
+       wee_database --rebuild-daily [--dry-run]
            [--date=YYYY-mm-dd | --from=YYYY-mm-dd --to=YYYY-mm-dd]

 Description: