From c8ea2df16c70dce9f96a33190ab4f59eaab93568 Mon Sep 17 00:00:00 2001 From: matthewwall Date: Fri, 23 Sep 2016 11:58:44 -0400 Subject: [PATCH] disambiguate action and option --- docs/utilities.htm | 62 +++++++++++++++++++++++----------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/utilities.htm b/docs/utilities.htm index 7870a723..0e594de2 100644 --- a/docs/utilities.htm +++ b/docs/utilities.htm @@ -168,7 +168,7 @@ Options:

Actions and options

-

--config

+

Option --config

The utility is pretty good about "guessing" where the configuration file weewx.conf is, but if you've done @@ -182,7 +182,7 @@ Options: 

wee_config --config=/home/weewx/weewx.conf
-

--list-drivers

+

Action --list-drivers

Use this action to list which device drivers are available on your system. For example:

@@ -210,7 +210,7 @@ Module name Driver name Version Status

The column Status can give you some indication of whether you are missing any modules to use this driver. It's not completely accurate, but works for most drivers.

-

--reconfigure

+

Action --reconfigure

This action is used to change station parameters, including the device driver. The reconfigure action will prompt for all of @@ -390,7 +390,7 @@ permissions for the requested operation.

Actions and options

-

--create-archive

+

Action --create-archive

If the database does not already exist, this action will create it and initialize it with the schema specified in the weewx configuration file. @@ -399,7 +399,7 @@ permissions for the requested operation. 

wee_database --create-archive
-

--drop-daily

+

Action --drop-daily

In addition to the regular archive data, every weewx database also includes a daily summary table for each observation type. Because there can be dozens of observation types, there can be dozens of these daily summaries. It doesn't happen very often, but there can be occasions when it's necessary to drop them all and @@ -407,13 +407,13 @@ permissions for the requested operation. 

wee_database --drop-daily
-

--backfill-daily

+

Action --backfill-daily

This action is the inverse of option --drop-daily in that it rebuilds the daily summaries from the archive data.

wee_database --backfill-daily
-

--reconfigure

+

Action --reconfigure

This action is useful for changing the schema in your database.

It creates a new database with the same name as the old, except with the suffix See the section Adding a new observation type in the Customization Guide for step-by-step instructions that use this option.

-

--string-check

+

Action --string-check

Normally, all entries in the archive database are pure numbers. However, some visual SQLite database editors use a null string instead of a null value when deleting entries. These nulls strings can crash weewx. This action checks for them and, if the option --fix is specified, substitutes a true @@ -434,7 +434,7 @@ permissions for the requested operation. 

wee_database --string-check
 wee_database --string-check --fix
-

--transfer

+

Action --transfer

This action is useful for moving your database from one type of database to another, such as from SQLite to MySQL. To use it, you must have two bindings specified in your weewx.conf configuration file. One will serve as the source, the other as the destination. Specify the source binding @@ -494,7 +494,7 @@ before posting the information publicly.

Actions and options

-

--info

+

Action --info

This action generates a debug report which can be sent off for remote debugging.

@@ -625,7 +625,7 @@ Parsed and obfuscated weewx.conf wee_debug report successfully generated -

--output

+

Option --output

By default, wee_debug sends its output to the system "standard output" (stdout) @@ -641,7 +641,7 @@ wee_debug report successfully generated 

wee_debug --info --output /home/weewx/another.debug
-

--verbosity

+

Option --verbosity

The amount of information included in the wee_debug output can be changed using the @@ -812,20 +812,20 @@ Options:

Actions and options

-

--install

+

Action --install

Use this action to install an extension. You must specify the path to a .zip archive, a .tgz/.tar.gz archive, or a directory.

wee_extension --install extensions/basic
 wee_extension --install basic.tar.gz
-

--list

+

Action --list

This action will list all the extensions that you have installed.

wee_extension --list
-

--uninstall

+

Action --uninstall

Use this action to remove an extension. You must specify the name of the extension, without any version number or zip/tgz @@ -968,7 +968,7 @@ the daily summaries using the wee_database utility.

The wee_import actions and options are described in more detail below:

-

--config

+

Option --config

The utility is pretty good at "guessing" where your configuration file weewx.conf is, but if you've done an unusual install, you may have to tell it explicitly. You can do this by using the @@ -977,7 +977,7 @@ the daily summaries using the wee_database utility. 

wee_import --config=/this/folder/weewx.conf --import-config=/folder/import.conf
-

--import-config

+

Option --import-config

wee_import uses a secondary configuration file to store various import parameters. The --import-config option is mandatory for all imports. @@ -990,7 +990,7 @@ the daily summaries using the wee_database utility. 

wee_import --import-config=/folder/import.conf
-

--dry-run

+

Option --dry-run

The inclusion of the --dry-run option will cause the import to proceed but no actual data will be saved to the database. This is a useful option to use when first @@ -999,7 +999,7 @@ the daily summaries using the wee_database utility. 

wee_import --import-config=/folder/import.conf --dry-run
-

--date

+

Option --date

The date-time range of records to be imported can be specified by use of the --date option. The --date option can specify a single @@ -1050,7 +1050,7 @@ the daily summaries using the wee_database utility. is to import all available records when importing from a CSV or Cumulus source or to import today's records only when importing from Weather Underground.

-

--log

+

Option --log

The --log option controls the wee_import log output. Omitting the option will result in wee_import log output being sent to the @@ -1063,7 +1063,7 @@ the daily summaries using the wee_database utility. 

wee_import --import-config=/folder/import.conf --log=-
-

--verbose

+

Option --verbose

Inclusion of the --verbose option will cause additional information to be printed during wee_import execution.

@@ -2495,7 +2495,7 @@ Options:

The wunderfixer options are described in more detail below:

-

--config

+

Option --config

The utility is pretty good at "guessing" where your configuration file weewx.conf is, but if you've done an unusual install, you may have to tell it explicitly. You can do this by using the @@ -2505,7 +2505,7 @@ Options: 

wunderfixer --config=/this/folder/weewx.conf
-

--binding

+

Option --binding

Specifies the data binding to be used as the source of data for missing records to be published to Weather Underground. Default is wx_binding. The wunderfixer --binding=another_binding -

--station

+

Option --station

Optional weather station ID of the Weather Underground PWS to be checked. The default is to use the station specified in the [[StdRESTful][[Wunderground]] section of wunderfixer --station=AB123456789 -

--password

+

Option --password

Optional password for the weather station ID to be checked. The default is to use the password specified in the [[StdRESTful][[Wunderground]] section of --config @@ -2533,7 +2533,7 @@ Options: 

wunderfixer --station=AB123456789 --password=hardtoguess
-

--date

+

Option --date

Optional date to check. By default wunderfixer checks the current date according to the system date-time. This feature is useful if running wunderfixer as a cron job. @@ -2543,7 +2543,7 @@ Options: 

wunderfixer --date=2016-04-20
-

--epsilon

+

Option --epsilon

At times Weather Underground records may have a date-time that is slightly different to the timestamp of the record as recorded by weewx. The --epsilon @@ -2554,7 +2554,7 @@ Options: 

wunderfixer --epsilon=60
-

--verbose

+

Option --verbose

Use of the --verbose option results in wunderfixer displaying useful additional information during execution. The wunderfixer is run as a cron job.

-

--log

+

Option --log

Control the wunderfixer log output. The default is no logging. If --log=weewx is used then wunderfixer logs to @@ -2573,14 +2573,14 @@ Options: 

wunderfixer --log=weewx
-

--test

+

Option --test

The --test option will cause wunderfixer to do everything except upload any missing data to Weather Underground. Summary information on any identified missing data will be displayed.

-

--query

+

Option --query

The --query option will cause wunderfixer to seek user confirmation