DICODCONFIG(8)						       Debian User's Manual						    DICODCONFIG(8)

NAME

       dicodconfig - write dicod database configuration section

SYNOPSIS

       dicodconfig [-hlovw] [--help] [--list] [--order] [--version] [--write]

DESCRIPTION

       dicodconfig  generates  a  complete  dicod database configuration section for available dictionary databases found in /usr/share/dictd/ (or
       possibly elsewhere if an optional order override file is present).  If a dictionary database contains a <basename>.suffix and/or  a  <base-
       name>.word file, appropriate index_suffix and index_word entries are created.

       Its  output  file  /var/lib/dicod/dictorg-db.list may then be included from the dicod configuration file /etc/dicod.conf with an ``#include
       /var/lib/dictd/dictorg-db.list'' line.  See infodico for an explanation of dicod configuration.

       In Debian, dicodconfig is automatically invoked upon installation or removal of dictionary database packages, so most users will never need
       to invoke it by hand.

   DATABASE ORDER
       The  default  order  in	which database entries are written is hard coded into dicodconfig, but it may be overridden via the optional order
       override file /etc/dicod/dicod.order.  This may be desired because dicod returns definitions from dictionary  databases	in  the  order	in
       which  they are listed in its configuration file.  The order override file may also be used to include local dictionary databases which may
       not necessarily reside in /usr/share/dictd/.

       /etc/dicod/dicod.order, if present, should be a whitespace separated list of basenames and  directories.   It  may  also  include  comments
       starting with # and extending to the end of the line.

       Dictionary  database  entries  will be generated only for those databases found via basename and directory entries in the default order (or
       the order override file, if present), and they will be generated in the order in which these entries appear.  No more than  one	dictionary
       database entry of any given name will be generated.

       Entries without a leading / are relative to /usr/share/dictd/.

       Entries	without a trailing / are basenames.  A dictionary database entry is generated if <basename>.index and <basename>.dict.dz or <base-
       name>.dict are present.

       Entries with a trailing / are directories.  A dictionary database entry is generated for each  <name>  where  <directory>/<name>.index  and
       <directory>/<name>.dict.dz or <directory>/<name>.dict are present.

       The  default order includes the directories /usr/share/dictd/ , /usr/share/dico/ as its final entry so that if a previously unknown dictio-
       nary database (one not explicitly mentioned in the default order) is installed, its dictionary database entry will still be generated.	An
       order  override	file should also use this technique, both for /usr/share/dictd/ , /usr/share/dico/ and for any other directory where local
       dictionary database might be installed.

       The -o option may be used to make dicodconfig display  the  default  order  information	along  with  the  order  override  information	if
       /etc/dicod/dicod.order is present.

   DUMMY ENTRY
       If  no  dictionary databases are found (via basename or directory entries in the default order or the order override file), a dummy dictio-
       nary database entry will be generated with /dev/null for both data and index.  This allows dicod to start without error.

   DATABASE ALIASES
       If an executable script named /etc/dicod/dicodconfig.alias exists, dicodconfig will filter database names through it.  The  script  can	be
       bash, sed, perl, or whatever.  Although dico -D will display database names of any length, names longer than 16 characters are displayed in
       a ragged format.  Appropriate entries in this alias file can be used to cause dico -D to display the database names in a reasonable format.

OPTIONS

       -w, --write
	      Write database section to /var/lib/dicod/dictorg-db.list.

       -l, --list
	      List database section to standard out.

       -o, --order
	      Display database order information.

       -h, --help
	      Display a usage message and exit.

       -v, --version
	      Display version information and exit.

FILES

       /var/lib/dicod/dictorg-db.list
	      Output of dicodconfig.

       /etc/dicod.conf
	      dicod configuration file which "includes" /var/lib/dicod/dictorg-db.list.

       /etc/dicod/dicod.order
	      Optional dicodconfig order override file.

SEE ALSO

       dicod(8)

BUGS

       Older dictionary database packages did not automatically invoke dicodconfig upon installation and removal, so you may need to do  so  manu-
       ally (after which, you should restart dicod).

AUTHOR

	 (Ahmed El-Mahmoudy) Based on dictdconfig(8) By Kirk Hilliard <kirk@debian.org>.

DEBIAN
								   April 5, 2009						    DICODCONFIG(8)