Missing Documentation
#260958
09/07/17 11:16 AM
|
Joined: Aug 2003
Posts: 303
Protopia
OP
Pan-dimensional mouse
|
OP
Pan-dimensional mouse
Joined: Aug 2003
Posts: 303 |
This thread has been started as a place for people to list all the functionality that is not yet documented in the help file: As a starter (by x-referencing versions.txt since 6.17 with help file): - aline / iline / sline / etc. -t
- $cb(N,u)
- /setlayer
- /toolbar -v
- $window.lb
- $encode/$decode -celsirznp support for salt/iv
- $msgstamp
- $onlineserver / $onlinetotal
- /timer -z
- /sockopen -t
- /list -n
- $tempfn
- /rename -f / /copy -f
- $samepath
- $chan().iql / $iql()
- /ialfill
- $eventid
I don't claim that this list is definitive. Please add any you think are missing. Perhaps khaled might consider open sourcing the help file on github so that the community can improve the documentation.
Last edited by Protopia; 09/07/17 12:31 PM.
|
|
|
Re: Missing Documentation
[Re: Protopia]
#260959
09/07/17 12:10 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
Probably not a bad idea to start the list, however Khaled stated the best move would be to start an online wiki, which already exists and also has tutorial on all scripting features: https://en.wikichip.org/wiki/mircAll commands are documented (except for /ialfill) but only half of identifiers are.
|
|
|
Re: Missing Documentation
[Re: Wims]
#260961
09/07/17 12:34 PM
|
Joined: Aug 2003
Posts: 303
Protopia
OP
Pan-dimensional mouse
|
OP
Pan-dimensional mouse
Joined: Aug 2003
Posts: 303 |
Many of us still use the local help file, and this is also available online and also available through "/help command" - so community updated help would be more generic and convenient than a wiki which is only online and not linked.
|
|
|
Re: Missing Documentation
[Re: Wims]
#260962
09/07/17 12:37 PM
|
Joined: Aug 2003
Posts: 303
Protopia
OP
Pan-dimensional mouse
|
OP
Pan-dimensional mouse
Joined: Aug 2003
Posts: 303 |
All commands are documented (except for /ialfill) but only half of identifiers are. All commands except /ialfill ... and /setlayer ... and /drawsize and ...
Last edited by Protopia; 09/07/17 12:38 PM.
|
|
|
Re: Missing Documentation
[Re: Protopia]
#260963
09/07/17 12:40 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
Many of us still use the local help file, and this is also available online and also available through "/help command" - so community updated help would be more generic and convenient than a wiki which is only online and not linked. That's why I said this is still a good idea, I myself still ask for the help to be updated. /setlayer is there, /ialfill and /drawsize are quite new, that's why there aren't, anyone can add them.
|
|
|
Re: Missing Documentation
[Re: Protopia]
#260964
09/07/17 01:19 PM
|
Joined: Aug 2003
Posts: 303
Protopia
OP
Pan-dimensional mouse
|
OP
Pan-dimensional mouse
Joined: Aug 2003
Posts: 303 |
Comparing the list of commands on the wiki, it appears that the following additional commands are missing from the help file: - /ctcp
- /finger
- /fsend
- /hotlink
- /leave
- /registration
The wiki is also incomplete and has the following commands missing: - /join
- /kick
- /nick
- /nickserv
- /notice
- /topic
- /whois
Last edited by Protopia; 09/07/17 01:22 PM.
|
|
|
Re: Missing Documentation
[Re: Protopia]
#260965
09/07/17 02:41 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
The point of wikichip is to document all the existing identifiers, the removed ones and the deprecated ones, some command and identifier are not documented on purpose in the help file, while some are just undocumented. /finger is an old things which I believe was removed, (some command support switch which means 'use the finger window'), this shouldn't be documented in the help file. Wikichip is not missing the commands you listed, there aren't mIRC commands, they are IRC server command, for instance /nickserv is not even a thing, only IRC dealing with nickserv may have this command, it's not even mandatory.
|
|
|
Re: Missing Documentation
[Re: Wims]
#260969
09/07/17 11:38 PM
|
Joined: Feb 2003
Posts: 2,800
Raccoon
Hoopy frood
|
Hoopy frood
Joined: Feb 2003
Posts: 2,800 |
Well. At least I won lunch. Good philosophy, see good in bad, I like!
|
|
|
Re: Missing Documentation
[Re: Protopia]
#260971
10/07/17 12:16 AM
|
Joined: Aug 2016
Posts: 53
rockcavera
Babel fish
|
Babel fish
Joined: Aug 2016
Posts: 53 |
There are some /commands and $identifiers that have no cataloging, neither in help nor in versions.txtI really do not know why, but some reason exists. Example: /bdupAnother example refers to this topic Before I even asked, there was support for the "-a" switch, if I remember correctly, since version 7.42. However, the "-a" switch was only officially cataloged in version 7.48 versions.txt 7.48: "32.Added -a switch to all binary variable commands that makes them not apply UTF-8 encoding to characters in the range 0-255, as long as the line contains no characters > 255." The interesting thing would be to catalog everyone in the official mirc help file, but we have the wikichip where users can do it. I will assist today with the identifier: $regerrstr Note: I have no idea what it is for. However, by name, it seems to have something to do with regex.
rockcavera #Scripts @ irc.VirtuaLife.com.br
|
|
|
Re: Missing Documentation
[Re: Protopia]
#260974
10/07/17 08:49 AM
|
Joined: Jun 2003
Posts: 81
TRT
Babel fish
|
Babel fish
Joined: Jun 2003
Posts: 81 |
|
|
|
Re: Missing Documentation
[Re: rockcavera]
#261374
16/09/17 04:38 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
Heh, sadly I remembered from your post that you were saying you couldn't get $regerrstr to work (where in fact you said you had no idea what it's for). Luckily it came up on IRC and after quick testing it's exactly what the name suggests: it returns the PCRE string version of the error code returned by the different PCRE regex function calls.
@Khaled: I don't know why $regerrstr is undocumented but it is pretty useful to know if a pattern fails because of an error or because there is no match found. Please document this identifier.
|
|
|
Re: Missing Documentation
[Re: Wims]
#261400
23/09/17 08:37 AM
|
Joined: Aug 2016
Posts: 53
rockcavera
Babel fish
|
Babel fish
Joined: Aug 2016
Posts: 53 |
I saw it on the channel.
Thank you.
rockcavera #Scripts @ irc.VirtuaLife.com.br
|
|
|
Re: Missing Documentation
[Re: Protopia]
#262965
27/04/18 09:23 PM
|
Joined: Apr 2018
Posts: 83
Erasimus
Babel fish
|
Babel fish
Joined: Apr 2018
Posts: 83 |
2 that are currently bugging me are to do with the Dialog List 'control' and, in particluar, the styles size and extsel,
Both are mentioned in mIRC Help as far as their existance - 'list id, x y w h, style (sort, extsel, multsel, size, vsbar, hsbar, check, radio)'
but no explation.
WikiChip has extsel with - 'Allows extra selection support', but nothing further. What extra selction support ?
So what do they do ?
|
|
|
Re: Missing Documentation
[Re: Erasimus]
#262966
27/04/18 09:30 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
it means you can control how you select item in the list, namely using the control key and clicking
I edited the wikichip explanation to illustrate the difference using the word 'consecutive'.
Last edited by Wims; 27/04/18 09:33 PM.
|
|
|
Re: Missing Documentation
[Re: Wims]
#262967
28/04/18 04:17 AM
|
Joined: Apr 2018
Posts: 83
Erasimus
Babel fish
|
Babel fish
Joined: Apr 2018
Posts: 83 |
I think I saw that explanation, but to me that sounds like a description of the style multsel which allows multiple entries to be selected using the control key and click together.
Isn't that what you just said about extsel ? or have I mixed the 2 styles up ?
|
|
|
Re: Missing Documentation
[Re: Erasimus]
#262971
28/04/18 09:25 AM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
That's right, sorry, feel free to edit back on wikichip if you want, I'll do it later if not done.
|
|
|
Re: Missing Documentation
[Re: Protopia]
#263266
24/06/18 01:40 AM
|
Joined: Feb 2011
Posts: 403
KindOne
Pan-dimensional mouse
|
Pan-dimensional mouse
Joined: Feb 2011
Posts: 403 |
05/09/2000 - mIRC v5.8 128.Added hash table support for scripting. A hash table can be created/destroyed/modified using: ... /hsave also supports -o to overwite an existing file, and -a to append to an existing file.
Missing the -o.
irc.swiftirc.net #msl (mIRC Scripting Language)
|
|
|
Re: Missing Documentation
[Re: KindOne]
#263267
24/06/18 10:11 AM
|
Joined: Dec 2002
Posts: 5,111
Khaled
Hoopy frood
|
Hoopy frood
Joined: Dec 2002
Posts: 5,111 |
Thanks, however the -o switch was made the default in later versions, so it was no longer needed.
|
|
|
Re: Missing Documentation
[Re: Khaled]
#263276
26/06/18 03:36 AM
|
Joined: Dec 2008
Posts: 1,512
westor
Hoopy frood
|
Hoopy frood
Joined: Dec 2008
Posts: 1,512 |
Missing details from help file.
/fupdate hole command informations. -p parameter from /set command.
Last edited by westor; 26/06/18 03:52 AM.
|
|
|
Re: Missing Documentation
[Re: Khaled]
#263508
13/08/18 03:26 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
$window().cx $window().cy, $mouse.cx and $mouse.cy are missing from the help file.
|
|
|
Re: Missing Documentation
[Re: Wims]
#264586
16/12/18 11:49 PM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
7.52's /fupdate and 7.53's $caller not documented in /help
also, if the /fupdate setting isn't going to be saved to mirc.ini [options], could there be something like an $fupdate identifier which returns the 0-100 value shown by /fupdate? This would allow scripts to save/restore the existing value, so they could change it during a specific burst of output.
|
|
|
Re: Missing Documentation
[Re: maroon]
#265048
21/02/19 06:59 AM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
/help /dll says: Note: The data and parms variables can each hold 900 chars maximum.
Could the dll page be updated from '900 chars' to indicate the current max limit in bytes, now that Unicode means chars and bytes aren't the same thing? Most DLL's won't care as long as the length is longer than 8292, but the info would be useful for a DLL which needs to support languages from the unicode codepoints above 2047 where each 'char' requires 3 bytes. I've only tested 'data but not 'parms', but 900 appears to be an obsolete number from older 6.x versions which had that shorter line length. I tested to see how long of a text string of hex digits could be written into 'data' for sending back to mIRC, before it crashes mIRC. The byte length in 6.35 seems to be a few dozen bytes longer than than the 4150 limit. In 7.52 the byte length limit was somewhere around 8400 bytes, I'm assuming this extra length is for supporting multi-byte unicode characters. And now that the line length limit has doubled, the valid string bytes-length has doubled above 16k.
|
|
|
Re: Missing Documentation
[Re: Protopia]
#265789
22/07/19 12:24 PM
|
Joined: Sep 2015
Posts: 97
klez
Babel fish
|
Babel fish
Joined: Sep 2015
Posts: 97 |
In the mirc 7.56 there's no help info about $urlget. It will be good if the mirc.chm will be updated in time. I don't know about other changes/adds if they are 
|
|
|
Re: Missing Documentation
[Re: maroon]
#266140
04/10/19 06:12 PM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
/help $ltimer
both locations says it returns the number of the timer. Should say 'timer ID'
//timerfoobar $+ $rand(1,99) 1 1 noop | echo -a $ltimer
|
|
|
Re: Missing Documentation
[Re: Wims]
#266712
20/01/20 07:10 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
$file().attr is returning a bunch of letter which are different from what one can read on the internet. I believe mIRC is translating the constant here https://docs.microsoft.com/fr-fr/windows/win32/fileio/file-attribute-constants to various letters, if some can be obvious, others aren't, it would be great to have a documentation of each possible letter.
|
|
|
Re: Missing Documentation
[Re: Wims]
#268184
07/12/20 07:48 PM
|
Joined: Jul 2006
Posts: 3,881
Wims
Hoopy frood
|
Hoopy frood
Joined: Jul 2006
Posts: 3,881 |
It looks like $urlget can return 0 when the connection is refused or something. I'm doing a lot of successive $urlget call via milliseconds timers and at some points i get 0 from $urlget, I'm not sure if this is a bug but I'm assuming the website is refusing my connecting as an antispam protection and that cause $urlget to return 0. My point is that in this case the callback alias won't be triggered, all of this is not documented, it would be nice to know what 0 really means and how it's not going to trigger the callback alias.
|
|
|
Re: Missing Documentation
[Re: Wims]
#268448
08/02/21 01:59 PM
|
Joined: Oct 2017
Posts: 47
DooMaster
Ameglian cow
|
Ameglian cow
Joined: Oct 2017
Posts: 47 |
/loadbuf -g
-g = ?? (it's undocumented)
|
|
|
Re: Missing Documentation
[Re: DooMaster]
#268522
05/03/21 05:29 PM
|
Joined: Oct 2017
Posts: 47
DooMaster
Ameglian cow
|
Ameglian cow
Joined: Oct 2017
Posts: 47 |
Missing $evalnext() identifier
|
|
|
Re: Missing Documentation
[Re: DooMaster]
#268941
17/05/21 06:23 PM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
Examples should be changed since root folder of c:\ has been read-only for a long time, unless mIRC is running in $isadmin=$true mode. It's hard to tell if there are other similar path strings elsewhere in /help since the search function returns a lot of false matches
/write -c c:\info.txt This file will be erased and have this line written to it /write -c c:\info.txt This file will be erased and have this line written to it /write -il5 c:\info.txt This line will be inserted at the 5th line in the file /write -dl5 c:\info.txt /write -dstest c:\info.txt
edit: this is in response to someone coming into channel asking why the /write command in the /help doesn't work
Last edited by maroon; 17/05/21 11:03 PM.
|
|
|
Re: Missing Documentation
[Re: maroon]
#268957
21/05/21 08:10 AM
|
Joined: Dec 2002
Posts: 5,111
Khaled
Hoopy frood
|
Hoopy frood
Joined: Dec 2002
Posts: 5,111 |
Thanks, I've removed all references to c:\ from the help file.
|
|
|
Re: Missing Documentation
[Re: Khaled]
#269001
26/05/21 05:01 PM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
While making this answer to a question https://forums.mirc.com/ubbthreads....-you-must-specify-a-parameter#Post268998I noticed that labels in popups aren't behaving the same way as the command following the semi-colon. When more than 1 nick is highlighted, the command following the semi-colon sees $2 $3 etc get filled in, but they are not filled as seen by the menu label. While it is true that the /help doesn't mention anything beyond $1, the default popups menu does contain them and the command here does use them: .Op:/mode # +ooo $$1 $2 $3 ... and users could see unexpected behavior if they assume that $2 behaves the same way across the entire label if you have the following lines in the nicklist popup menu: Label (0) $0 (1-) $1- parms $parms (2) $2 : echo -a (0) $0 (1-) $1- parms $parms (2) $2 .Give Op to $1-3:/mode # +ooo $$1 $2 $3 In the label, the $0 is always 1 when $2- is filled due to more than 1 nick selected, $parms is always ignoring the presence of $2- nicks, and $2- $2 $3 etc are always blank. This can result in a menu command targeting a different group of nicks than indicated by the label, ie giving ops to 3 nicks even though the label says only 1 nick. Whether $2- should become part of the menu label, or the /help should be updated to indicate that $2- are valid in the :/command portion, I dunno.
|
|
|
Re: Missing Documentation
[Re: Protopia]
#269287
17/08/21 11:52 PM
|
Joined: Feb 2011
Posts: 403
KindOne
Pan-dimensional mouse
|
Pan-dimensional mouse
Joined: Feb 2011
Posts: 403 |
$lock(sendmessage) ; 7.34 $min()/$max() .text .textcs ; 7.62 /hotlink -dm ; 7.23
irc.swiftirc.net #msl (mIRC Scripting Language)
|
|
|
Re: Missing Documentation
[Re: KindOne]
#269289
18/08/21 01:09 PM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
It appears that $lock is having backwards compatibility for obsolete functionality, where it returns $false for things no longer able to be disabled from the menu. This $false reply also happens for things including:
//echo -a $lock(decode) $lock(run) $lock(com) $lock(dll)
|
|
|
Re: Missing Documentation
[Re: maroon]
#269292
19/08/21 05:16 PM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
My reply wasn't completely accurate. $lock(sendmessage) is not one of the other obsolete features returning $false. Instead, the option to enable or disable it is on options/other, instead of being at options/other/lock along with the other active remaining items.
|
|
|
Re: Missing Documentation
[Re: maroon]
#270171
15/04/22 09:35 AM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
Based on the different behavior of these 2 commands, it appears that 'v' is an undocumented switch, so it would be great if F1 help could tell us what -v does. /echo -jkopuwxyz /echo -jkopuvwxyz If -v turns out to be a 'do nothing switch letter that will never be used as a valid switch' as referenced HERE that would also be helpful if it were documented.
Last edited by maroon; 15/04/22 09:37 AM.
|
|
|
Re: Missing Documentation
[Re: maroon]
#270172
15/04/22 09:39 AM
|
Joined: Jan 2004
Posts: 1,745
maroon
Hoopy frood
|
Hoopy frood
Joined: Jan 2004
Posts: 1,745 |
The documentation for the /*line commands could be made more clear by having the syntax line showing the location for the switch letters. Especially since it's different than for /echo because the switch letter goes before the color index instead of after.
i.e. /aline -a 4 abc vs /echo 4 -a abc
|
|
|
Re: Missing Documentation
[Re: maroon]
#270176
15/04/22 08:46 PM
|
Joined: Feb 2003
Posts: 2,800
Raccoon
Hoopy frood
|
Hoopy frood
Joined: Feb 2003
Posts: 2,800 |
It's probably from /drawtext -v &binvar being passed to /echo internally. Or it's an experiment where Khaled tried, or anticipated, adding &binvar support to /echo in order to print things like sequential spaces.
Well. At least I won lunch. Good philosophy, see good in bad, I like!
|
|
|
|
|