diff --git a/nselib/bin.luadoc b/nselib/bin.luadoc new file mode 100644 index 000000000..56719604d --- /dev/null +++ b/nselib/bin.luadoc @@ -0,0 +1,49 @@ + +--- The Binary Data Library allows to pack and unpack to and from +-- binary data. Encoding and decoding works by using a format +-- string containing certain operator characters: +--
| Operator | Description |
|---|---|
| H | hex string |
| B | bit string |
| x | null byte |
| z | zero-terminated string |
| p | string preceded by 1-byte integer length |
| P | string preceded by 2-byte integer length |
| a | string preceded by 4-byte integer length |
| A | string |
| f | float |
| d | double |
| n | Lua number |
| c | char (1-byte integer) |
| C | byte = unsigned char (1-byte unsigned integer) |
| s | short (2-byte integer) |
| S | unsigned short (2-byte unsigned integer) |
| i | int (4-byte integer) |
| I | unsigned int (4-byte unsigned integer) |
| l | long (8-byte integer) |
| L | unsigned long (8-byte unsigned integer) |
| < | little endian modifier |
| > | big endian modifier |
| = | native endian modifier |