autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2017-07-18' version='Pike v8.1.9'> + <manual time-stamp='2017-07-21' version='Pike v8.1.9'>    <dir name='./onepage'>    <file name='./onepage/manual.html'>    <chapter number='1' title='Control Structures'>      <p>In this chapter all the control structures in Pike will be   explained. Control structures are used to control the flow of the   program execution. Note that functions that make the program pause and   simple function calls are not qualified as control structures.</p>      <section number='1' title='Conditions'>
autodoc.git/onepage.xml:2299:   <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable>   </docgroup>   <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text><p>Sets the proper authentication method and cipher specification    for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>.</p>   </text></doc>   <method name='set_cipher_suite'>   <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </text></doc>   <method name='set_compression_method'>   <arguments><argument name='compr'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='sslfile'>   <doc><text><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/onepage.xml:5663:   <docgroup homogen-name='make_time' homogen-type='method'><doc><text><p>Creates a <ref resolved='predef::Standards.ASN1.Types.UTC'>Standards.ASN1.Types.UTC</ref> object from the posix    time <ref resolved='8.0::Tools.X509.make_time.t'>t</ref>.</p>   </text></doc>   <method name='make_time'>   <arguments><argument name='t'><type><int/></type></argument></arguments>   <returntype><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_verifier' homogen-type='method'>   <method name='make_verifier'> - <arguments><argument name='_keyinfo'><type><object resolved='predef::Object'>Object</object></type></argument></arguments> + <arguments><argument name='_keyinfo'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></argument></arguments>   <returntype><object>Verifier</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='parse_time' homogen-type='method'><doc><text><p>Returns a mapping similar to that returned by gmtime</p>   </text><group><returns/><text><mapping><group><member><type><int/></type><index>"year"</index></member><member><type><int/></type><index>"mon"</index></member><member><type><int/></type><index>"mday"</index></member><member><type><int/></type><index>"hour"</index></member><member><type><int/></type><index>"min"</index></member><member><type><int/></type><index>"sec"</index></member></group></mapping>   </text></group></doc>   <method name='parse_time'>   <arguments><argument name='asn1'><type><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></type></argument></arguments>   <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype>   </method>
autodoc.git/onepage.xml:5764:   </docgroup>   <docgroup homogen-name='der' homogen-type='variable'>   <variable name='der'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc>   <variable name='extensions'><type><object resolved='8.0::Tools.X509.TBSCertificate'/></type></variable>   </docgroup>   <docgroup homogen-name='init' homogen-type='method'>   <method name='init'> - <arguments><argument name='asn1'><type><object resolved='predef::Object'>Object</object></type></argument></arguments> + <arguments><argument name='asn1'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></argument></arguments>   <returntype><object resolved='8.0::Tools.X509.TBSCertificate'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='issuer' homogen-type='variable'>   <variable name='issuer'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></variable>   </docgroup>   <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc>   <variable name='issuer_id'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable>   </docgroup>
autodoc.git/onepage.xml:22365:   </text></group></doc>   <method name='try_success'>   <arguments><argument name='value'><type><mixed/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   </module>   <module name='Crypto'>   <doc><text><p>Various cryptographic classes and functions.</p> - <p> <b>Hash functions</b> -  These are based on the <ref resolved='predef::Crypto.Hash'>Hash</ref> API; <ref resolved='predef::Crypto.MD2'>MD2</ref>, <ref resolved='predef::Crypto.MD4'>MD4</ref>, <ref resolved='predef::Crypto.MD5'>MD5</ref>, -  <ref resolved='predef::Crypto.SHA1'>SHA1</ref>, <ref resolved='predef::Crypto.SHA256'>SHA256</ref>.</p> - <p> <b>Stream cipher functions</b> -  These are based on the <ref resolved='predef::Crypto.Cipher'>Cipher</ref> API; <ref resolved='predef::Crypto.AES'>AES</ref>, <ref resolved='predef::Crypto.Arcfour'>Arcfour</ref>, -  <ref resolved='predef::Crypto.Blowfish'>Blowfish</ref>, <ref resolved='predef::Crypto.CAST'>CAST</ref>, <ref resolved='predef::Crypto.DES'>DES</ref>, <ref resolved='predef::Crypto.DES3'>DES3</ref>, <ref resolved='predef::Crypto.IDEA'>IDEA</ref>, <ref resolved='predef::Crypto.Serpent'>Serpent</ref>, -  <ref resolved='predef::Crypto.Twofish'>Twofish</ref>. The <ref resolved='predef::Crypto.Substitution'>Substitution</ref> program is compatible with the -  CipherState. Also conforming to the API are the helper modules + <dl><group><item name='Hash modules'/><text><p>These are based on the <ref resolved='predef::Nettle.Hash'>Nettle.Hash</ref> API. +  Examples include <ref resolved='predef::Crypto.MD5'>MD5</ref>, <ref resolved='predef::Crypto.SHA1'>SHA1</ref>, <ref resolved='predef::Crypto.SHA256'>SHA256</ref> and <ref resolved='predef::Crypto.SHA3_256'>SHA3_256</ref>.</p> + </text></group><group><item name='Cipher modules'/><text><p>These are based on the <ref resolved='predef::Nettle.Cipher'>Nettle.Cipher</ref> API. +  Examples include <ref resolved='predef::Crypto.AES'>AES</ref>, <ref resolved='predef::Crypto.Arcfour'>Arcfour</ref>, <ref resolved='predef::Crypto.DES'>DES</ref>, <ref resolved='predef::Crypto.DES3'>DES3</ref>, <ref>CAMELLIA</ref>.</p> + <p> The <ref resolved='predef::Crypto.Substitution'>Substitution</ref> program is compatible with <ref resolved='predef::Nettle.Cipher.State'>Cipher.State</ref>.</p> + <p> Also conforming to the API are several helper modules such as    <ref>Buffer</ref>, <ref resolved='predef::Nettle.BlockCipher.CBC'>predef::Nettle.BlockCipher.CBC</ref>, -  <ref>predef::Nettle.BlockCipher.GCM</ref> and <ref resolved='predef::Crypto.Pipe'>Pipe</ref>.</p> - <p> As the cryptographic services offered from this module isn't +  <ref resolved='predef::Nettle.BlockCipher16.GCM'>predef::Nettle.BlockCipher16.GCM</ref> and <ref resolved='predef::Crypto.Pipe'>Pipe</ref>.</p> + </text></group><group><item name='Message Authentication Code modules (MACs)'/><text><p><ref resolved='predef::Crypto.MAC'>MAC</ref> algorithms are provided as sub-modules to their corresponding +  <ref resolved='predef::Crypto.Hash'>Hash</ref> or <ref resolved='predef::Crypto.Cipher'>Cipher</ref> module. +  Examples include <ref resolved='predef::__builtin.Nettle.Hash.HMAC'>SHA1.HMAC</ref> and <ref resolved='predef::Crypto.AES.UMAC32'>AES.UMAC32</ref>.</p> + </text></group><group><item name='Authenticated Encryption with Associated Data modules (AEADs)'/><text><p><ref resolved='predef::Crypto.AEAD'>AEAD</ref>s combine ciphers with authentication codes, and may optionally +  also take into account some associated data that is provided out of band. +  This API is compatible with both <ref resolved='predef::Crypto.Cipher'>Cipher</ref> and <ref resolved='predef::Crypto.Hash'>Hash</ref>. +  AEADs are provided as sub-modules to their corresponding ciphers. +  Examples include <ref resolved='predef::Nettle.BlockCipher16.CCM'>AES.CCM</ref>, <ref resolved='predef::Nettle.BlockCipher16.GCM'>AES.GCM</ref> and <ref>CAMELLIA.EAX</ref>.</p> + </text></group></dl><p>As the cryptographic services offered from this module aren't    necessarily used for security applications, none of the strings -  inputted or outputted are marked as secure. This is up to the +  inputted or outputted are marked as secure. That is up to the    caller.</p> - </text><group><note/><text><p>This module is only available if Pike has been compiled with + </text><group><note/><text><p>Most of the APIs in this module work on 8 bit binary strings unless +  otherwise noted. +  For conversions to and from hexadecimal notation <ref resolved='predef::String.string2hex'>String.string2hex()</ref> +  and <ref resolved='predef::String.hex2string'>String.hex2string()</ref> may be of interest.</p> + </text></group><group><note/><text><p>This module is only available if Pike has been compiled with    <ref resolved='predef::Nettle'>Nettle</ref> enabled (this is the default).</p>   </text></group></doc>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='make_crypt_md5' homogen-type='method'><doc><text><p>Hashes a <ref resolved='predef::Crypto.make_crypt_md5.password'>password</ref> together with a <ref resolved='predef::Crypto.make_crypt_md5.salt'>salt</ref> with the    crypt_md5 algorithm and returns the result.</p>   </text><group><seealso/><text><p><ref resolved='predef::Crypto.verify_crypt_md5'>verify_crypt_md5</ref></p>   </text></group></doc>   <method name='make_crypt_md5'>
autodoc.git/onepage.xml:93808:   <variable name='lr_error'><type><int/></type></variable>   </docgroup>   <docgroup homogen-name='make_parser' homogen-type='method'><doc><text><p>Compiles the parser-specification given in the first argument.    Named actions are taken from the object if available, otherwise    left as is.</p>   </text><group><bugs/><text><p>Returns error-code in both GrammarParser.error and    return_value-&gt;lr_error.</p>   </text></group></doc>   <method name='make_parser'>   <arguments><argument name='str'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser'/><void/></or></type></argument></arguments> - <returntype><object resolved='predef::Parser'>Parser</object></returntype> + <returntype><object resolved='predef::Parser.LR.Parser'>Parser</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_parser_from_file' homogen-type='method'><doc><text><p>Compiles the file specified in the first argument into an LR parser.</p>   </text><group><seealso/><text><p><ref resolved='predef::Parser.LR.GrammarParser.make_parser'>make_parser</ref></p>   </text></group></doc>   <method name='make_parser_from_file'>   <arguments><argument name='fname'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser_from_file'/><void/></or></type></argument></arguments> - <returntype><or><int/><object resolved='predef::Parser'>Parser</object></or></returntype> + <returntype><or><int/><object resolved='predef::Parser.LR.Parser'>Parser</object></or></returntype>   </method>   </docgroup>   </module>   <class name='Parser'>   <doc><text><p>This object implements an LALR(1) parser and compiler.</p>   <p> Normal use of this object would be:</p>   <p> <pre>    set_error_handler    {add_rule, set_priority, set_associativity}*    set_symbol_to_string
autodoc.git/onepage.xml:118891:   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='_BSON' homogen-type='inherit'>   <inherit name='_BSON'><classname resolved='predef::Standards._BSON'>Standards._BSON</classname></inherit>   </docgroup>   <class name='Binary'>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers> - <arguments><argument name='_data'><type><string/></type></argument><argument name='_subtype'><type><or><int/><void/></or></type></argument></arguments> + <arguments><argument name='data'><type><string/></type></argument><argument name='subtype'><type><or><int/><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   </class>   <class name='Javascript'>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>