mIRC Homepage

Missing Documentation

Posted By: Protopia

Missing Documentation - 09/07/17 11:16 AM

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.
Posted By: Wims

Re: Missing Documentation - 09/07/17 12:10 PM

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.
Posted By: Protopia

Re: Missing Documentation - 09/07/17 12:34 PM

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.
Posted By: Protopia

Re: Missing Documentation - 09/07/17 12:37 PM

Originally Posted By: Wims
All commands are documented (except for /ialfill) but only half of identifiers are.

All commands except /ialfill ... and /setlayer ... and /drawsize and ...
Posted By: Wims

Re: Missing Documentation - 09/07/17 12:40 PM

Quote:
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.
Posted By: Protopia

Re: Missing Documentation - 09/07/17 01:19 PM

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
Posted By: Wims

Re: Missing Documentation - 09/07/17 02:41 PM

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.
Posted By: Raccoon

Re: Missing Documentation - 09/07/17 11:38 PM

/returnex
Posted By: rockcavera

Re: Missing Documentation - 10/07/17 12:16 AM

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.
Posted By: TRT

Re: Missing Documentation - 10/07/17 08:49 AM

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

Re: Missing Documentation - 16/09/17 04:38 PM

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.
Posted By: rockcavera

Re: Missing Documentation - 23/09/17 08:37 AM

I saw it on the channel.

Thank you.
Posted By: Wims

Re: Missing Documentation - 02/03/18 03:18 PM

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
Posted By: Erasimus

Re: Missing Documentation - 27/04/18 09:23 PM

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 ?
Posted By: Wims

Re: Missing Documentation - 27/04/18 09:30 PM

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'.
Posted By: Erasimus

Re: Missing Documentation - 28/04/18 04:17 AM

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 ?
Posted By: Wims

Re: Missing Documentation - 28/04/18 09:25 AM

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

Re: Missing Documentation - 24/06/18 01:40 AM

05/09/2000 - mIRC v5.8
Quote:

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.
Posted By: Khaled

Re: Missing Documentation - 24/06/18 10:11 AM

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

Re: Missing Documentation - 26/06/18 03:36 AM

Missing details from help file.

/fupdate hole command informations.
-p parameter from /set command.
Posted By: Wims

Re: Missing Documentation - 13/08/18 03:26 PM

$window().cx $window().cy, $mouse.cx and $mouse.cy are missing from the help file.
Posted By: maroon

Re: Missing Documentation - 16/12/18 11:49 PM

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.
Posted By: maroon

Re: Missing Documentation - 21/02/19 06:59 AM

/help /dll says:

Quote:

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.
Posted By: klez

Re: Missing Documentation - 22/07/19 12:24 PM

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 smile
© 2019 mIRC Discussion Forums