php man page for pspell_config_repl

PSPELL_CONFIG_REPL(3)							 1						     PSPELL_CONFIG_REPL(3)

pspell_config_repl - Set a file that contains replacement pairs

SYNOPSIS
       bool pspell_config_repl (int  $dictionary_link, string  $file)

DESCRIPTION
	Set a file that contains replacement pairs.

	The  replacement  pairs  improve  the quality of the spellchecker. When a word is misspelled, and a proper suggestion was not found in the
       list, pspell_store_replacement(3) can be used to store a replacement pair and then pspell_save_wordlist(3) to save the wordlist along  with
       the replacement pairs.

       pspell_config_repl(3) should be used on a config before calling pspell_new_config(3).

PARAMETERS
	      o $dictionary_link
		-

	      o $file
		- The file should be writable by whoever PHP runs as (e.g. nobody).

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      pspell_config_repl(3)

	      <?php
	      $pspell_config = pspell_config_create("en");
	      pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
	      pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
	      $pspell_link = pspell_new_config($pspell_config);
	      pspell_check($pspell_link, "thecat");
	      ?>

NOTES
       Note

	       This function will not work unless you have pspell .11.2 and aspell .32.5 or later.

PHP Documentation Group 												     PSPELL_CONFIG_REPL(3)