Document weectl station upgrade-skins

weewx · Feb 20, 2023 · ecc1e3d · ecc1e3d
1 parent bde1db7
commit ecc1e3d
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 3 deletions.
diff --git a/TODO.md b/TODO.md
@@ -8,6 +8,8 @@
 
 ## Utilities
 
+Lot of inconsistencies in how the path to the config file is handled. Some utilities accept a
+command line option, others require `--config=`.
 
 Remove wunderfixer and its documentation.
 

diff --git a/docs/utilities/utilities.htm b/docs/utilities/utilities.htm
@@ -50,7 +50,7 @@
 
     <div class="header">
         <div class="logoref">
-            <a href='https://weewx.com'> <img src='images/logo-weewx.png' class='logo' style="float:right"
+            <a href='https://weewx.com'> <img src='../images/logo-weewx.png' class='logo' style="float:right"
                                              alt="weewx logo"/> </a><br/> <span class='version'>
 Version: 5.0
     </span>

diff --git a/docs/weectl/station.md b/docs/weectl/station.md
@@ -59,6 +59,9 @@ Which action to take:
     upgrade-skins       Upgrade the skins.
 ```
 
+In the documentation that follows,  the exact output will depend on
+your operating system and username. What is shown below is for macOS and user `tkeffer`.
+
 ## `weectl station create`
 
 This action will create a new area for user data. When done, the area will include
@@ -75,8 +78,7 @@ By contrast, package installers create the necessary user data as part of their
 Nevertheless, you may want to create a second user data area, perhaps to support a second
 instrument &mdash; in that case, this action may be useful.
 
-Running `weectl station create --help` will show its options. The exact output will depend on
-your operating system and username. What is shown below is for macOS and user `tkeffer`.
+Running `weectl station create --help` will show its options.
 
 ```shell
 % weectl station create --help
@@ -296,3 +298,35 @@ optional arguments:
                         $WEEWX_ROOT. Default is "examples".
   --dry-run             Print what would happen, but do not actually do it.
 ```
+
+## `weectl station upgrade-skins`
+
+This action will upgrade your skins. Your old skins will be saved as a timestamped backup.
+Your configuration file will not be touched.
+
+Running `weectl station upgrade-skins --help` will show you its options.
+
+``` shell
+% weectl station upgrade-skins --help
+usage: weectl station upgrade-skins [--config=CONFIG-PATH] \
+                                    [--skin-root=SKIN_ROOT] \
+                                    [--no-prompt] \
+                                    [--dry-run]
+
+Upgrade skins to the latest version. A backup will be made first. In what
+follows, WEEWX_ROOT is the directory that contains the configuration
+file. For example, if "--config=/Users/tkeffer/weewx-data/weewx.conf", then
+WEEWX_ROOT will be "/Users/tkeffer/weewx-data".
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --config CONFIG-PATH  Path to configuration file. Default is
+                        "/Users/tkeffer/weewx-data/weewx.conf"
+  --skin-root SKIN_ROOT
+                        Where to put the skins, relatve to WEEWX_ROOT. Default
+                        is "skins".
+  --no-prompt           If set, do not prompt. Use default values.
+  --dry-run             Print what would happen, but do not actually do it.
+
+```
+