diff options
author | Philipp Gesang <phg@phi-gamma.net> | 2018-12-09 21:29:09 +0100 |
---|---|---|
committer | Philipp Gesang <phg@phi-gamma.net> | 2018-12-09 21:29:09 +0100 |
commit | 4a754036826405dd488b0718315b434c9cb726d0 (patch) | |
tree | 339d4f6eda5340fcff5dc141639e6100996bd143 | |
parent | 5835b73456898c7bd48d3ed9ec2539c1b560f9b8 (diff) | |
download | ocaml-sid-4a754036826405dd488b0718315b434c9cb726d0.tar.gz |
doc: outline usage
-rw-r--r-- | readme.rst | 7 | ||||
-rw-r--r-- | sid.mli | 7 |
2 files changed, 13 insertions, 1 deletions
@@ -5,6 +5,13 @@ format. Includes a utility ``sidparse`` for dissecting SIDs on the command line. +entry points +------------ + +Convert to and from the string format using the *to_string* and *of_string* +functions. The binary representations can be encoded and decoded using the +corresponding *to_bytes* and *of_bytes* methods. + building -------- The main build system is Oasis_, but there is a wrapper for OPAM to simplify @@ -4,7 +4,12 @@ {e Sid} implements the “Security Identifier” data type commonly used on the Microsoft Windows platform. When processing input, it tries to - adhere as closely to the specification as possible. + adhere as closely to the specification as possible. Optionally, a + special mode for the text representation is available as the + {e MSStringFmt} module which aims to be bug-for-bug compatible with + the official implementation. There is no such mode for the two identical + binary representations due to the fact that they don’t leave room for + ambiguity. @see <https://msdn.microsoft.com/en-us/library/cc230371.aspx> the relevant section in the {e [MS-DTYP]} compilation of types. *) |