diff --git a/reference/mcrypt/ciphers.xml b/reference/mcrypt/ciphers.xml index 920c3af116..0a11ebce9c 100644 --- a/reference/mcrypt/ciphers.xml +++ b/reference/mcrypt/ciphers.xml @@ -1,5 +1,5 @@ - + Mcrypt ciphers @@ -56,7 +56,8 @@ - You must (in CFB and OFB mode) or can (in CBC mode) supply an + You must (in CFB and OFB mode) + or can (in CBC mode) supply an initialization vector (IV) to the respective cipher function. The IV must be unique and must be the same when decrypting/encrypting. With data which is stored encrypted, you diff --git a/reference/mcrypt/constants.xml b/reference/mcrypt/constants.xml index 9ab0acb549..a93e72f9ce 100644 --- a/reference/mcrypt/constants.xml +++ b/reference/mcrypt/constants.xml @@ -1,39 +1,45 @@ - + &reftitle.constants; &extension.constants; - Mcrypt can operate in four block cipher modes (CBC, OFB, CFB, and - ECB). If linked against libmcrypt-2.4.x or higher the functions can also operate - in the block cipher mode nOFB and in STREAM mode. Below you find a list - with all supported encryption modes together with the constants that are + Mcrypt can operate in four block cipher modes (CBC, + OFB, CFB, and + ECB). If linked against libmcrypt-2.4.x or higher the + functions can also operate in the block cipher mode nOFB + and in STREAM mode. Below you find a list with all + supported encryption modes together with the constants that are defines for the encryption mode. For a more complete reference and discussion see &book.applied.cryptography;. - MCRYPT_MODE_ECB (electronic codebook) is suitable for random data, + MCRYPT_MODE_ECB (electronic + codebook) is suitable for random data, such as encrypting other keys. Since data there is short and random, the disadvantages of ECB have a favorable negative effect. - MCRYPT_MODE_CBC (cipher block chaining) is especially suitable for - encrypting files where the security is increased over ECB + MCRYPT_MODE_CBC (cipher block + chaining) is especially suitable for + encrypting files where the security is increased over ECB significantly. - MCRYPT_MODE_CFB (cipher feedback) is the best mode for encrypting byte + MCRYPT_MODE_CFB (cipher + feedback) is the best mode for encrypting byte streams where single bytes must be encrypted. - MCRYPT_MODE_OFB (output feedback, in 8bit) is comparable to CFB, but + MCRYPT_MODE_OFB (output feedback, in + 8bit) is comparable to CFB, but can be used in applications where error propagation cannot be tolerated. It's insecure (because it operates in 8bit mode) so it is not recommended to use it. @@ -41,14 +47,15 @@ - MCRYPT_MODE_NOFB (output feedback, in nbit) is comparable to OFB, but + MCRYPT_MODE_NOFB (output feedback, + in nbit) is comparable to OFB, but more secure because it operates on the block size of the algorithm. - MCRYPT_MODE_STREAM is an extra mode to include some stream algorithms - like WAKE or RC4. + MCRYPT_MODE_STREAM is an extra mode to include + some stream algorithms like "WAKE" or "RC4". diff --git a/reference/mcrypt/examples.xml b/reference/mcrypt/examples.xml index 35f31ca9fd..f993c1cff6 100644 --- a/reference/mcrypt/examples.xml +++ b/reference/mcrypt/examples.xml @@ -1,17 +1,19 @@ - + &reftitle.examples; Mcrypt can be used to encrypt and decrypt using the above - mentioned ciphers. If you linked against libmcrypt-2.2.x, the + mentioned ciphers. If you linked against libmcrypt-2.2.x, the four important mcrypt commands (mcrypt_cfb, mcrypt_cbc, mcrypt_ecb, and mcrypt_ofb) can operate in both modes - which are named MCRYPT_ENCRYPT and MCRYPT_DECRYPT, respectively. + which are named MCRYPT_ENCRYPT and + MCRYPT_DECRYPT, respectively. - Encrypt an input value with TripleDES under 2.2.x in ECB mode + Encrypt an input value with <literal>TripleDES</literal> + under 2.2.x in <literal>ECB</literal> mode - Encrypt an input value with TripleDES under 2.4.x and higher in ECB mode + Encrypt an input value with <literal>TripleDES</literal> under 2.4.x and higher in <literal>ECB</literal> mode - + mcrypt_list_algorithms @@ -61,7 +61,7 @@ The above example will produce a list with all supported - algorithms in the "/usr/local/lib/libmcrypt" directory. + algorithms in the "/usr/local/lib/libmcrypt" directory. diff --git a/reference/mcrypt/functions/mcrypt-list-modes.xml b/reference/mcrypt/functions/mcrypt-list-modes.xml index d594fbf437..3ad042274a 100644 --- a/reference/mcrypt/functions/mcrypt-list-modes.xml +++ b/reference/mcrypt/functions/mcrypt-list-modes.xml @@ -1,5 +1,5 @@ - + mcrypt_list_modes @@ -27,8 +27,8 @@ Specifies the directory where all modes are located. If not - specifies, the value of the mcrypt.modes_dir &php.ini; directive - is used. + specifies, the value of the mcrypt.modes_dir + &php.ini; directive is used. @@ -63,7 +63,7 @@ The above example will produce a list with all supported algorithms in the default mode directory. If it is not set with the ini directive mcrypt.modes_dir, the default directory - of mcrypt is used (which is /usr/local/lib/libmcrypt). + of mcrypt is used (which is /usr/local/lib/libmcrypt). diff --git a/reference/mcrypt/functions/mcrypt-module-open.xml b/reference/mcrypt/functions/mcrypt-module-open.xml index 440dbf5ae3..e60a67af52 100644 --- a/reference/mcrypt/functions/mcrypt-module-open.xml +++ b/reference/mcrypt/functions/mcrypt-module-open.xml @@ -1,5 +1,5 @@ - + mcrypt_module_open @@ -17,8 +17,8 @@ This function opens the module of the algorithm and the mode to be used. - The name of the algorithm is specified in algorithm, e.g. "twofish" or is - one of the MCRYPT_ciphername constants. The module is closed by calling + The name of the algorithm is specified in algorithm, e.g. "twofish" or is + one of the MCRYPT_ciphername constants. The module is closed by calling mcrypt_module_close. Normally it returns an encryption descriptor, or &false; on error. @@ -26,11 +26,11 @@ The algorithm_directory and mode_directory are used to locate the encryption modules. When you supply a directory name, it is used. When you set one - of these to the empty string (""), the value set by the + of these to the empty string (""), the value set by the mcrypt.algorithms_dir or mcrypt.modes_dir ini-directive is used. When these are not set, the default directories that are used are the ones - that were compiled in into libmcrypt (usually /usr/local/lib/libmcrypt). + that were compiled in into libmcrypt (usually /usr/local/lib/libmcrypt). @@ -52,8 +52,8 @@ - The first line in the example above will try to open the DES cipher from - the default directory and the EBC mode from the directory + The first line in the example above will try to open the DES cipher from + the default directory and the EBC mode from the directory /usr/lib/mcrypt-modes. The second example uses strings as name for the cipher and mode, this only works when the extension is linked against libmcrypt 2.4.x or 2.5.x. diff --git a/reference/mnogosearch/functions/udm-set-agent-param.xml b/reference/mnogosearch/functions/udm-set-agent-param.xml index 34e2aca06c..ce0ca8ba09 100644 --- a/reference/mnogosearch/functions/udm-set-agent-param.xml +++ b/reference/mnogosearch/functions/udm-set-agent-param.xml @@ -1,5 +1,5 @@ - + udm_set_agent_param @@ -40,52 +40,55 @@ - UDM_PARAM_PAGE_NUM - used to choose search results page number (results - are returned by pages beginning from 0, with UDM_PARAM_PAGE_SIZE results per page). + UDM_PARAM_PAGE_NUM - used to choose search results page number (results + are returned by pages beginning from 0, with UDM_PARAM_PAGE_SIZE results per page). - UDM_PARAM_PAGE_SIZE - number of search results displayed on one page. + UDM_PARAM_PAGE_SIZE - number of search results displayed on one page. - UDM_PARAM_SEARCH_MODE - search mode. The following values available: UDM_MODE_ALL - - search for all words; UDM_MODE_ANY - search for any word; UDM_MODE_PHRASE - - phrase search; UDM_MODE_BOOL - boolean search. See udm_find + UDM_PARAM_SEARCH_MODE - search mode. The following values available: UDM_MODE_ALL - + search for all words; UDM_MODE_ANY - search for any word; UDM_MODE_PHRASE - + phrase search; UDM_MODE_BOOL - boolean search. See udm_find for details on boolean search. - UDM_PARAM_CACHE_MODE - turns on or off search result cache mode. + UDM_PARAM_CACHE_MODE - turns on or off search result cache mode. When enabled, the search engine will store search results to disk. In case a similar search is performed later, the engine will take results from the cache for faster performance. - Available values: UDM_CACHE_ENABLED, UDM_CACHE_DISABLED. + Available values: UDM_CACHE_ENABLED, + UDM_CACHE_DISABLED. - UDM_PARAM_TRACK_MODE - turns on or off trackquery mode. Since + UDM_PARAM_TRACK_MODE - turns on or off trackquery mode. Since version 3.1.2 mnoGoSearch has a query tracking support. Note that tracking is implemented in SQL version only and not available in built-in database. To use tracking, you have to create tables for tracking support. - For MySQL, use create/mysql/track.txt. + For MySQL, use create/mysql/track.txt. When doing a search, front-end uses those tables to store query words, a number of found documents and current Unix timestamp in seconds. - Available values: UDM_TRACK_ENABLED, UDM_TRACK_DISABLED. + Available values: UDM_TRACK_ENABLED, + UDM_TRACK_DISABLED. - UDM_PARAM_PHRASE_MODE - defines whether index database using phrases + UDM_PARAM_PHRASE_MODE - defines whether index database using phrases ("phrase" parameter in indexer.conf). - Possible values: UDM_PHRASE_ENABLED and UDM_PHRASE_DISABLED. - Please note, that if phrase search is enabled (UDM_PHRASE_ENABLED), - it is still possible to do search in any mode (ANY, ALL, BOOL or PHRASE). + Possible values: UDM_PHRASE_ENABLED and UDM_PHRASE_DISABLED. + Please note, that if phrase search is enabled (UDM_PHRASE_ENABLED), + it is still possible to do search in any mode (ANY, ALL, + BOOL or PHRASE). In 3.1.10 version of mnoGoSearch phrase search is supported only in sql and built-in database modes, while beginning with 3.1.11 phrases are supported in cachemode as well. @@ -94,40 +97,40 @@ Examples of phrase search: - "Arizona desert" - This query returns all indexed documents that contain + "Arizona desert" - This query returns all indexed documents that contain "Arizona desert" as a phrase. Notice that you need to put double quotes around the phrase - UDM_PARAM_CHARSET - defines local charset. Available values: set of + UDM_PARAM_CHARSET - defines local charset. Available values: set of charsets supported by mnoGoSearch, e.g. koi8-r, cp1251, ... - UDM_PARAM_STOPFILE - Defines name and path + UDM_PARAM_STOPFILE - Defines name and path to stopwords file. (There is a small difference with mnoGoSearch - while in mnoGoSearch if relative path or no path entered, it - looks for this file in relation to UDM_CONF_DIR, the module looks for + looks for this file in relation to UDM_CONF_DIR, the module looks for the file in relation to current path, i.e. to the path where the PHP script is executed.) - UDM_PARAM_STOPTABLE - Load stop words from the given SQL table. You may use + UDM_PARAM_STOPTABLE - Load stop words from the given SQL table. You may use several StopwordTable commands. This command has no effect when compiled without SQL database support. - UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific document parts. + UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific document parts. Currently body, title, keywords, description, url are supported. To activate this feature please use degrees of 2 in *Weight commands of - the indexer.conf. Let's imagine that we have these weights: + the indexer.conf. Let's imagine that we have these weights: URLWeight 1 @@ -146,7 +149,7 @@ - This parameter's value is a string of hex digits ABCDE. Each digit is a + This parameter's value is a string of hex digits ABCDE. Each digit is a factor for corresponding bit in word weight. For the given above weights configuration: @@ -161,17 +164,17 @@ Examples: - UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only. + UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only. - UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only. + UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only. - UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description + UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description but not through URL and Body. - UDM_PARAM_WEIGHT_FACTOR=F9421 will search through: + UDM_PARAM_WEIGHT_FACTOR=F9421 will search through: Description with factor 15 (F hex) @@ -181,36 +184,36 @@ URL with factor 1 - If UDM_PARAM_WEIGHT_FACTOR variable is omitted, original weight value is + If UDM_PARAM_WEIGHT_FACTOR variable is omitted, original weight value is taken to sort results. For a given above weight configuration it means that document description has a most big weight 16. - UDM_PARAM_WORD_MATCH - word match. You may use this parameter to choose + UDM_PARAM_WORD_MATCH - word match. You may use this parameter to choose word match type. This feature works only in "single" and "multi" modes using SQL based and built-in database. It does not work in cachemode and other modes since they use word CRC and do not support substring search. Available values: - UDM_MATCH_BEGIN - word beginning match; - UDM_MATCH_END - word ending match; - UDM_MATCH_WORD - whole word match; - UDM_MATCH_SUBSTR - word substring match. + UDM_MATCH_BEGIN - word beginning match; + UDM_MATCH_END - word ending match; + UDM_MATCH_WORD - whole word match; + UDM_MATCH_SUBSTR - word substring match. - UDM_PARAM_MIN_WORD_LEN - defines minimal word length. + UDM_PARAM_MIN_WORD_LEN - defines minimal word length. Any word shorter this limit is considered to be a stopword. Please note - that this parameter value is inclusive, i.e. if UDM_PARAM_MIN_WORD_LEN=3, + that this parameter value is inclusive, i.e. if UDM_PARAM_MIN_WORD_LEN=3, a word 3 characters long will not be considered a stopword, while a word 2 characters long will be. Default value is 1. - UDM_PARAM_ISPELL_PREFIXES - Possible values: UDM_PREFIXES_ENABLED and - UDM_PREFIXES_DISABLED, that respectively enable or disable using prefixes. + UDM_PARAM_ISPELL_PREFIXES - Possible values: UDM_PREFIXES_ENABLED and + UDM_PREFIXES_DISABLED, that respectively enable or disable using prefixes. E.g. if a word "tested" is in search query, also words like "test", "testing", etc. Only suffixes are supported by default. Prefixes usually change word meanings, for example if somebody is searching for the word "tested" @@ -221,8 +224,8 @@ - UDM_PARAM_CROSS_WORDS - enables or disables crosswords support. - Possible values: UDM_CROSS_WORDS_ENABLED and UDM_CROSS_WORDS_DISABLED. + UDM_PARAM_CROSS_WORDS - enables or disables crosswords support. + Possible values: UDM_CROSS_WORDS_ENABLED and UDM_CROSS_WORDS_DISABLED. The crosswords feature allows to assign words between <a href="xxx"> and </a> @@ -232,10 +235,10 @@ - UDM_PARAM_VARDIR - specifies a custom path to directory where indexer + UDM_PARAM_VARDIR - specifies a custom path to directory where indexer stores data when using built-in database and in cache mode. By default /var directory of - mnoGoSearch installation is used. Can have + mnoGoSearch installation is used. Can have only string values. @@ -289,7 +292,7 @@ &reftitle.notes; - Crosswords are supported only in mnoGoSearch 3.1.11 or later. + Crosswords are supported only in mnoGoSearch 3.1.11 or later.