fhem.pl patch: Update cmds help text

Begonnen von Nestor, 23 Oktober 2019, 23:19:38

Vorheriges Thema - Nächstes Thema

Nestor

I noticed that the info displayed with help was missing some command flags (ex. list & sleep). Attached is patch that syncs the command options between help & help cmd. I just copy/pasted them.

--- - 2019-10-23 23:11:00.000000000 +0200
+++ fhem.pl 2019-10-23 23:08:12.000000000 +0200
@@ -402,33 +402,33 @@
%cmds = (
   "?"       => { ReplacedBy => "help" },
   "attr"    => { Fn=>"CommandAttr",
-           Hlp=>"<devspec> <attrname> [<attrval>],set attribute for <devspec>"},
+           Hlp=>"[-a|-r] <devspec> <attrname> [<value>],set attribute for <devspec>"},
   "cancel"  => { Fn=>"CommandCancel",
            Hlp=>"[<id> [quiet]],list sleepers, cancel sleeper with <id>" },
   "createlog"=> { ModuleName => "autocreate" },
   "define"  => { Fn=>"CommandDefine",
-           Hlp=>"<name> <type> <options>,define a device" },
+           Hlp=>"[option] <name> <type> <type-specific>,define a device" },
   "defmod"  => { Fn=>"CommandDefMod",
-           Hlp=>"<name> <type> <options>,define or modify a device" },
+           Hlp=>"[-temporary] <name> <type> <type-specific>,define or modify a device" },
   "deleteattr" => { Fn=>"CommandDeleteAttr",
            Hlp=>"<devspec> [<attrname>],delete attribute for <devspec>" },
   "deletereading" => { Fn=>"CommandDeleteReading",
-            Hlp=>"<devspec> [<attrname>],delete user defined reading for ".
+            Hlp=>"<devspec> [<readingname>],delete user defined reading for ".
                  "<devspec>" },
   "delete"  => { Fn=>"CommandDelete",
             Hlp=>"<devspec>,delete the corresponding definition(s)"},
   "displayattr"=> { Fn=>"CommandDisplayAttr",
             Hlp=>"<devspec> [attrname],display attributes" },
   "get"     => { Fn=>"CommandGet",
-            Hlp=>"<devspec> <type dependent>,request data from <devspec>" },
+            Hlp=>"<devspec> <type-specific>,request data from <devspec>" },
   "include" => { Fn=>"CommandInclude",
-            Hlp=>"<filename>,read the commands from <filenname>" },
+            Hlp=>"<filename>,read the commands from <filename>" },
   "iowrite" => { Fn=>"CommandIOWrite",
             Hlp=>"<iodev> <data>,write raw data with iodev" },
   "list"    => { Fn=>"CommandList",
-            Hlp=>"[-r] [devspec],list definitions and status info" },
+            Hlp=>"[devspec] [value ...] or list {-r|-R},list definitions and status info" },
   "modify"  => { Fn=>"CommandModify",
-            Hlp=>"device <options>,modify the definition (e.g. at, notify)" },
+            Hlp=>"<name> <type-dependent-options>,modify the definition (e.g. at, notify)" },
   "quit"    => { Fn=>"CommandQuit",
             ClientFilter => "telnet",
             Hlp=>",end the client session" },
@@ -436,7 +436,7 @@
             ClientFilter => "telnet",
             Hlp=>",end the client session" },
   "reload"  => { Fn=>"CommandReload",
-            Hlp=>"<module-name>,reload the given module (e.g. 99_PRIV)" },
+            Hlp=>"<module>,reload the given module (e.g. 99_PRIV)" },
   "rename"  => { Fn=>"CommandRename",
             Hlp=>"<old> <new>,rename a definition" },
   "rereadcfg"  => { Fn=>"CommandRereadCfg",
@@ -446,22 +446,22 @@
   "save"    => { Fn=>"CommandSave",
             Hlp=>"[configfile],write the configfile and the statefile" },
   "set"     => { Fn=>"CommandSet",
-            Hlp=>"<devspec> <type dependent>,transmit code for <devspec>" },
+            Hlp=>"<devspec> <type-specific>,transmit code for <devspec>" },
   "setreading" => { Fn=>"CommandSetReading",
             Hlp=>"<devspec> <reading> <value>,set reading for <devspec>" },
   "setstate"=> { Fn=>"CommandSetstate",
-            Hlp=>"<devspec> <state>,set the state shown in the command list" },
+            Hlp=>"<devspec> <value>,set the state shown in the command list" },
   "setuuid" => { Fn=>"CommandSetuuid", Hlp=>"" },
   "setdefaultattr" => { Fn=>"CommandDefaultAttr",
-            Hlp=>"<attrname> <attrvalue>,set attr for following definitions" },
+            Hlp=>"[<attrname> [<value>]],set attr for following definitions" },
   "shutdown"=> { Fn=>"CommandShutdown",
             Hlp=>"[restart|exitValue],terminate the server" },
   "sleep"  => { Fn=>"CommandSleep",
-            Hlp=>"<sec> [<id>] [quiet],sleep for sec, 3 decimal places" },
+            Hlp=>"<sec|timespec|regex> [<id>] [quiet],sleep for sec, 3 decimal places" },
   "trigger" => { Fn=>"CommandTrigger",
             Hlp=>"<devspec> <state>,trigger notify command" },
   "update" => {
-            Hlp => "[<fileName>|all|check|force] ".
+            Hlp => "[<fileName>|all|check|checktime|force] ".
                                       "[http://.../controlfile],update FHEM" },
   "updatefhem" => { ReplacedBy => "update" },
   "usb"     => { ModuleName => "autocreate" },

rudolfkoenig

Thanks for the work, I rechecked the entries, and corrected them, mostly taking your suggestions.