Forums Feature Suggestions Missing Documentation

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.

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/mirc
All commands are documented (except for /ialfill) but only half of identifiers are.

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.

All commands except /ialfill ... and /setlayer ... and /drawsize and ...

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.

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

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.

/returnex

There are some /commands and $identifiers that have no cataloging, neither in help nor in versions.txt

I really do not know why, but some reason exists.

Example: /bdup

Another 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.

I think this used to be a good starting point:
https://forum.swiftirc.net/viewtopic.php?f=36&t=16859

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.

I saw it on the channel.

Thank you.

The new on hotlink syntax with $hotlink and /hotlink aren't documented: https://forums.mirc.com/ubbthreads.php/ubb/showflat/Number/260721/

The new -p switch on /var and /set isn't documented

The new /fupdate isn't documented

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 ?

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'.

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 ?

That's right, sorry, feel free to edit back on wikichip if you want, I'll do it later if not done.

05/09/2000 - mIRC v5.8


Missing the -o.

Thanks, however the -o switch was made the default in later versions, so it was no longer needed.

Missing details from help file.

/fupdate hole command informations.
-p parameter from /set command.