no way to compare when less than two revisions

Differences

This shows you the differences between two versions of the page.

@@ Line 1: / Line 1: @@
+# $EPIC: mask.txt,v 1.4 2009/05/27 18:36:41 zwhite Exp $
+======Synopsis:======
+$__mask__(<type> <address>)
+$__mask__(<address> <type>)
+======Technical:======
+In the second usage case, the <address> argument is a [[what is a word|dword]],
+which is different from most function arguments.  **In the first usage case,
+the <address> argument is not a dword!**
+This function returns <address> in a wildcard mask according to the type
+specified by <type>. The mask types are defined in the following table:
+    <type>     <address> has a hostname       <address> has an ip
+  -------------------------------------------------------------------
+            *!u@h.d                        *!u@d.h
+            *!*u@h.d                       *!*u@d.h
+            *!*@h.d                        *!*@d.h
+            *!*u@*.d                       *!*u@d.*
+            *!*@*.d                        *!*@d.*
+            n!u@h.d                        n!u@d.h
+            n!*u@h.d                       n!*u@d.h
+            n!*@h.d                        n!*@d.h
+            n!*u@*.d                       n!*u@d.*
+            n!*@*.d                        n!*@d.*
+           *!*@h.d                        *!*@d.*
+      *11          *!*u@h.d                       *!*u@d.*
+      *12          n!*@h.d                        n!*@d.*
+      *13          n!*u@h.d                       n!*u@d.*
+where n=nick, u=user, h=host, and d=domain
+With the following modifications:  In the ``local'' portion of
+the hostname, all sequence of numbers are substituted with a
+single '*'.  In the username, leading ~'s are also substituted
+with a single '*'.
+NOTE: Types marked with an asterisk (*) are not currently
+(as of epic5 1.0) implemented and will always return an empty
+string. They are expected to be implemented in a future release
+of epic5.
+======Returns:======
+<address> in a wildcard mask according to <type>
+======Examples:======
+<file>
+$mask(3 foo!bar@long.host.blah.com)              returns: *!*bar@*.blah.com
+$mask(10 nick!user@ppp-147-0-52-129.frobitz.com) returns: *!*@ppp-*-*-*-*.frobitz.com
+</file>
+======Other Notes:======
+This function strips all tildes ('~') from the left of the username. For
+script writers, this means that in mask types 0 and 5, the function is
+*NOT* guaranteed to produce a mask matching the given address. If a script
+is to use these types, they should expect tildes to be stripped and be able
+to act accordingly.