Changes between Version 279 and Version 280 of ippToPsps

Timestamp:

Apr 5, 2012, 4:05:41 PM (14 years ago)

Author:

rhenders

Comment:

--

ippToPsps

@@ -150 +150 @@
 All {{{ippToPsps}}} programs register with the {{{ippToPsps}}} database upon start-up, adding a row in the [wiki:ippToPsps_Database#Theclientstable clients table]. While running, all programs routinely check the {{{ippToPsps}}} database to check for changes in the config, or to see if they should be paused or stopped.
 
-The config argument can be the name of any config in the [wiki:ippToPsps_Database#Theconfigtable config table of the database] or it can be '''{{{all}}}''', or it can be '''{{{edit}}}'''. Using {{{all}}} will mean that the program in question will cycle through all 'active' configs. This is handy for programs like {{{metrics.py}}} or {{{cleanup.py}}}; instead of having an intance of these programs per config, one instance can cycle through them all. Using {{{edit}}} first prompts the user for a config name. If the name of an existing config is given, then the user can them edit the current settings. If a new name is provided then the user is prompted for all necessary fields to build-up that new config.
-
 All programs catch Ctrl-C for clean exiting, and all programs write a log to stdout and some to file, the location of which is set in the [browser:trunk/ippToPsps/config/settings.xml settings file]. Extra information about logging can be found [wiki:ippToPsps#Logging here].
 
@@ -163 +161 @@
  * '''{{{setupScratchDb.py}}}''' - for setting up a scratch database
 
-More detail about each program follows.
+More detail about each program below.
+
+== Specifying, or creating, a config ==
+
+As stated, every {{{ippToPsps}}} program takes a config argument. This can be one of three things:
+
+ * the name of a particular config currently in the [wiki:ippToPsps_Database#Theconfigtable config table of the database], meaning that program will run using only that config
+ * 'all' meaning that program will cycle through all 'active' configs
+ * 'edit' allows the user to edit, or create, a config then the program proceeds to use that config
+
+The 'all' option is handy for programs like {{{metrics.py}}} or {{{cleanup.py}}}; instead of having an intance of these programs per config, one instance can cycle through them all. The {{{edit}}} option can be used when creating a config for the first time, or to edit an existing one.
 == queue.py ==