pspell_config_save_repl(3) [php man page]

PSPELL_CONFIG_SAVE_REPL(3)						 1						PSPELL_CONFIG_SAVE_REPL(3)

pspell_config_save_repl - Determine whether to save a replacement pairs list along with the wordlist

SYNOPSIS

       bool pspell_config_save_repl (int  $dictionary_link, bool  $flag)

DESCRIPTION

       pspell_config_save_repl(3)  determines  whether	pspell_save_wordlist(3)  will  save the replacement pairs along with the wordlist. Usually
       there  is  no  need  to	use  this  function  because  if  pspell_config_repl(3)  is  used,  the  replacement  pairs  will  be	saved	by
       pspell_save_wordlist(3) anyway, and if it is not, the replacement pairs will not be saved.

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

PARAMETERS

	      o $dictionary_link
		-

	      o $flag
		- TRUE if replacement pairs should be saved, FALSE otherwise.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

NOTES

       Note

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

PHP Documentation Group 												PSPELL_CONFIG_SAVE_REPL(3)

PSPELL_NEW_PERSONAL(3)							 1						    PSPELL_NEW_PERSONAL(3)

pspell_new_personal - Load a new dictionary with personal wordlist

SYNOPSIS

       int pspell_new_personal (string	$personal, string  $language, [string  $spelling], [string  $jargon], [string  $encoding], [int  $mode])

DESCRIPTION

       pspell_new_personal(3)	opens	up   a	 new  dictionary  with	a  personal  wordlist.	The  wordlist  can  be	modified  and  saved  with
       pspell_save_wordlist(3), if desired. However, the replacement pairs are not saved. In order to save replacement pairs, you should create  a
       config  using  pspell_config_create(3),	set  the personal wordlist file with pspell_config_personal(3), set the file for replacement pairs
       with pspell_config_repl(3), and open a new dictionary with pspell_new_config(3).

	For more information and examples, check out inline manual pspell website:http://aspell.net/.

PARAMETERS

	      o $personal
		- The file where words added to the personal list will be stored. It should be an absolute filename  beginning	with  '/'  because
		otherwise it will be relative to $HOME, which is "/root" for most systems, and is probably not what you want.

	      o $language
		-  The language code which consists of the two letter ISO 639 language code and an optional two letter ISO 3166 country code after
		a dash or underscore.

	      o $spelling
		- The requested spelling for languages with more than one spelling such as English. Known values are  'american',  'british',  and
		'canadian'.

	      o $jargon
		- Extra information to distinguish two different words lists that have the same language and spelling parameters.

	      o $encoding
		-  The	encoding that words are expected to be in. Valid values are utf-8, iso8859-*, koi8-r, viscii, cp1252, machine unsigned 16,
		machine unsigned 32.

	      o $mode
		- The mode in which spellchecker will work. There are several modes available:

		     o PSPELL_FAST - Fast mode (least number of suggestions)

		     o PSPELL_NORMAL - Normal mode (more suggestions)

		     o PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions)

		     o PSPELL_RUN_TOGETHER - Consider run-together words as legal compounds. That is, "thecat" will be a legal compound,  although
		       there  should be a space between the two words. Changing this setting only affects the results returned by pspell_check(3);
		       pspell_suggest(3) will still return suggestions.

	       Mode is a bitmask constructed from different constants listed above. However, PSPELL_FAST,  PSPELL_NORMAL  and  PSPELL_BAD_SPELLERS
	      are mutually exclusive, so you should select only one of them.

RETURN VALUES

	Returns the dictionary link identifier for use in other pspell functions.

EXAMPLES

       Example #1

	      pspell_new_personal(3)

	      <?php
	      $pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws",
		      "en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER);
	      ?>

PHP Documentation Group 												    PSPELL_NEW_PERSONAL(3)