NAME

DESCRIPTION

NOTE

should give you access to the complete manual.

You can also view the manual using the info mode in emacs(1), or find it in various formats online at

If any discrepancies occur between this manpage and the GNU Dico Manual, the later shall be considered the authoritative source.

LEXICAL STRUCTURE

	Sequence	Expansion	ASCII
	\\	\	134
	\"	"	042
	\a	audible bell	007	
	\b	backspace	010
	\f	form-feed	014
	\n	new line	012
	\r	charriage return	015
	\t	horizontal tabulation	011
	\v	vertical tabulation	013

"a long string may be\
 split over several lines"

"a long string may be"
" split over several lines"

<<EOT
A multiline
string
EOT

<<- TEXT
    The leading whitespace will be
    ignored when reading these lines.
TEXT

help-text <<-EOT
    A sample help text.
EOT;

STATEMENTS

The following is a simple statement:

pidfile /var/run/direvent.pid;

See below for a list of valid simple statements.

A value can be one of the following:

number

A number is a sequence of decimal digits.

boolean

A boolean value is one of the following: yes, true, t or 1, meaning true, and no, false, nil, 0 meaning false.

word

quoted string

list

A comma-separated list of values, enclosed in parentheses.

acl global {
   allow all from 198.51.100.0/24;
   deny all;
}

SERVER SETTINGS

user NAME

Run with the privileges of this user. The argument is either a user name, or UID prefixed with a plus sign.

group LIST

If the user statement is present, dicod will drop all supplementary groups and switch to the principal group of that user. Sometimes, however, it may be necessary to retain one or more supplementary groups. For example, this might be necessary to access dictionary databases. The group statement retains the supplementary groups listed in LIST. Each group can be specified either by its name or by its GID number, prefixed with @samp{+}, e.g.:

user nobody;
group (man, dict +88);

mode daemon|inetd

Sets server operation mode.

listen LIST

Specify the IP addresses and ports to listen on in daemon mode. By default, dicod will listen on port 2628 on all existing interfaces.

Elements of LIST can have the following forms:

pidfile STRING

Store PID of the master process in this file. Default is /var/run/dicod.pid.

max-children NUMBER

Sets maximum number of subprocesses that can run simultaneously. This is equivalent to the number of clients that can simultaneously use the server. The default is 64.

inactivity-timeout NUMBER

Sets inactivity timeout to the NUMBER of seconds. The server disconnects automatically if the remote client has not sent any command within this number of seconds. Setting timeout to 0 disables inactivity timeout (the default).

This statement along with max-children allows you to control the server load.

shutdown-timeout NUMBER

When the master server is shutting down, wait this number of seconds for all children to terminate. Default is 5 seconds.

identity-check BOOLEAN

Enable identification check using AUTH protocol (RFC 1413). The received user name or UID can be shown in access log using the %l conversion (see below).

ident-keyfile STRING

Use encryption keys from the named file to decrypt AUTH replies encrypted using DES.

ident-timeout NUMBER

Set timeout for AUTH input/output operation to NUMBER of seconds. Default timeout is 3 seconds.

AUTHENTICATION SETTINGS

user-db URL {
    # Additional configuration options.
    options STRING;
    # Name of the password resource.
    password-resource RESOURCE;
    # Name of the resource returning user group information.
    group-resource RESOURCE;
}

The URL consists of the following parts (square brackets denoting optional ones):

TYPE://[[USER[:PASSWORD]@]HOST]/PATH[PARAMS]

where:

TYPE

Database type. Two types are supported: text and ldap.

USER

User name, if necessary to access the database.

PASSWORD

User password, if necessary to access the database.

HOST

Domain name or IP address of a machine running the database.

PATH

A path to the database. The exact meaning of this element depends on the database protocol. See the texinfo documentation.

PARAMS

A list of protocol-dependent parameters. Each parameter is of the form KEYWORD=NAME, multiple parameters are separated with semicolons.

The following statements can appear within the user-db block:

options STRING

Pass additional options to the underlying mechanism. The argument is treated as an opaque string and passed to the authentication open procedure verbatim. Its exact meaning depends on the type of the database.

password-resource ARG

A database resource which returns the user's password.

group-resource ARG

A database resource which returns the list of groups this user is member of.

The exact semantics of the database resource depends on the type of database being used. For flat text databases, it means the name of a text file that contains these data, for LDAP databases, the resource is the filter string, etc. Please refer to the GNU Dico Manual, subsection 4.3.3 Authentication for a detailed discussion.

SASL AUTHENTICATION

sasl {
    # Disable SASL mechanisms listed in MECH.
    disable-mechanism MECH;
    # Enable SASL mechanisms listed in MECH.
    enable-mechanism MECH;
    # Set service name for GSSAPI and Kerberos.
    service NAME;
    # Set realm name for GSSAPI and Kerberos.
    realm NAME;
    # Define groups for anonymous users.
    anon-group GROUPS;
}

disable-mechanism MECH

Disable SASL mechanisms listed in MECH, which is a list of names.

enable-mechanism MECH

Enable SASL mechanisms listed in MECH, which is a list of names.

service NAME

Sets the service name for GSSAPI and Kerberos mechanisms.

realm NAME

Sets the realm name.

anon-group LIST

Declares the list of user groups considered anonymous.

ACCESS CONTROL LISTS

acl NAME {
    DEFINITION...
}

The parameter NAME assigns a unique name to that ACL. This name will be used by another configuration statements to refer to that ACL (see SECURITY SETTINGS, and Database Visibility).

Each DEFINITION is:

allow|deny [all|authenticated|group GROUPLIST] [acl NAME] [from ADDRLIST]

A definition starting with allow allows access to the resource, and the one starting with deny denies it.

The next part controls what users have access to the resource:

all

All users (the default).

authenticated

Only authenticated users.

group GROUPLIST

Authenticated users which are members of at least one of the groups listed in GROUPLIST.

The acl part refers to an already defined ACL.

The from keyword declares that the client IP must be within the ADDRLIST in order for the definition to apply. Elements of ADDRLIST are:

any

Matches any client address.

IP address

Matches if the request comes from the given IP (both IPv4 and IPv6 are allowed).

ADDR/NETLEN

Matches if first NETLEN bits from the client IP address equal to ADDR. The network mask length, NETLEN must be an integer number between 0 and 32 for IPv4, and between 0 and 128 for IPv6. The address part, ADDR, is as described above.

ADDR/NETMASK

The specifier matches if the result of logical AND between the client IP address and NETMASK equals to ADDR. The network mask must be specified in a IP address (either IPv4 or IPv6) notation.

SECURITY SETTINGS

connection-acl NAME

Use ACL NAME to control incoming connections. The ACL itself must be defined before this statement. Using the group clause in this ACL makes no sense, because the authentication itself is performed only after the connection have been established.

show-sys-info NAME

Controls whether to show system information in reply to SHOW SERVER command. The information will be shown only if ACL NAME allows it.

visibility-acl NAME

Sets name of the ACL that controls visibility of all databases.

LOGGING AND DEBUGGING

log-tag STRING

Prefix syslog messages with this string. By default, the program name is used.

log-facility STRING

Sets the syslog facility to use. Allowed values are: user, daemon, auth, authpriv, mail, cron, local0 through local7 (case-insensitive), or a decimal facility number.

log-print-severity BOOLEAN

Prefix diagnostics messages with a string identifying their severity.

transcript BOOLEAN

Controls the transcript of user sessions.

ACCESS LOG

access-log-file STRING

Sets access log file name.

access-log-format STRING

Defines the format string. Its argument can contain literal characters, which are copied into the log file verbatim, and format specifiers, i.e. special sequences beginning with %, which are replaced in the log file as shown in the table below:

The absence of access-log-format statement is equivalent to the following:

  access-log-format "%h %l %u %t \"%r\" %>s %b";

GENERAL SETTINGS

initial-banner-text TEXT

Display TEXT in the textual part of the initial server reply.

hostname STRING

Sets the hostname. By default it is determined automatically.

The server hostname is used, among others, in the initial reply after the 220 and may also be displayed in the access log file using the %v escape (see ACCESS LOG).

server-info TEXT

Sets the server description to be shown in reply to the SHOW SERVER command.

It is common for TEXT to use the here-document syntax, e.g.:

  server-info <<EOT
    Welcome to the FOO dictionary service.
    Contact <dict@foo.example.org> if you have questions or
    suggestions.
  EOT;
    

help-text TEXT

Sets the text to be displayed in reply to the HELP command.

The default reply displays a list of commands understood by the server with a short description of each.

If TEXT begins with a plus sign, it will be appended to the default reply.

default-strategy NAME

Sets the name of the default matching strategy (*note MATCH::). By default, Levenshtein matching is used, which is equivalent to default-strategy lev;

CAPABILITIES

capability LIST

Requests additional capabilities from the LIST.

Capabilities are certain server features that can be enabled or disabled at the system administrator's will. The following capabilities are defined:

auth

The AUTH command is supported. See the section AUTHENTICATION, for its configuration.

mime

The OPTION MIME command is supported. Notice that RFC 2229 requires all servers to support that command, so you should always specify this capability.

xversion

The XVERSION command is supported. It is a GNU extension that displays the dicod implementation and version number.

xlev

The XLEV command is supported. This command allows the remote party to set and query maximal Levenshtein distance for the lev matching strategy.

The capabilities set using this directive are displayed in the initial server reply, and their descriptions are added to the HELP command output (unless specified otherwise by the help-text statement).

DATABASE MODULES

A handler is an instance of the database module loaded by dicod and configured for a specific database or a set of databases.

Database handlers are defined using the following block statement:

load-module NAME {
    command CMD;
}

The load-module statement creates an instance of a database module. The NAME argument specifies a unique name which will be used by subsequent parts of the configuration to refer to this handler. The command line for this handler is supplied with the command statement. It must begin with the name of the module (without the library suffix) and can contain any additional arguments. If the module name is not an absolute file name, the module will be searched in the module load path.

For example:

load-module dict {
   command "dictorg dbdir=/var/dicodb";
}

A simplified form of this statement:

    load-module NAME;

is equivalent to:

    load-module NAME {
        command NAME;
    }

A module load path is an internal list of directories which dicod scans in order to find a loadable file name specified in the command statement. By default the search order is as follows:

1.

Optional prefix search directories specified in the prepend-load-path statement (see below);

2.

GNU Dico module directory /usr/local/lib/dico;

3.

Additional search directories specified in the module-load-path statement (see below);

4.

The value of the environment variable LTDL_LIBRARY_PATH;

5.

The system dependent library search path (e.g. on GNU/Linux it is defined by the file /etc/ld.so.conf and the environment variable LD_LIBRARY_PATH).

The value of LTDL_LIBRARY_PATH and LD_LIBRARY_PATH must be a colon-separated list of absolute directory names.

In each of these directories, dicod first attempts to find and load the given filename. If this fails, it tries to append the following suffixes to it:

1.

the libtool archive suffix .la;

2.

the suffix used for native dynamic libraries on the host platform, e.g., .so, .sl, etc.

module-load-path LIST

Add directories from LIST to the end of the module load path.

prepend-load-path LIST

Add directories from LIST to the beginning of the module load path.

DATABASES

database {
    name WORD;
    description STRING;
    info TEXT;
    languages-from LANGLIST;
    languages-to LANGLIST;
    handler NAME;
    visibility-acl NAME;
    mime-headers TEXT;
}

name STRING

Sets the name of this database (a single word). This name will be used to identify this database in DICT commands.

handler STRING

Specifies the handler name for this database and optional arguments for it. This handler must be previously defined using the load-module statement (see above).

description STRING

Supplies a short description, to be shown in reply to the SHOW DB command. The STRING may not contain newlines.

info STRING

Defines a full description of the database. This description is shown in reply to the SHOW INFO command. It is usually a multi-line text, so it is common to use here-document syntax.

content-type STRING

Sets the content type of the reply (for use in MIME headers).

content-transfer-encoding VALUE

Sets transfer encoding to use when sending MIME replies for this database. VALUE is one of: base64, quoted-printable.

visibility-acl NAME

Sets name of the ACL that controls that database visibility.

STRATEGIES AND SEARCHES

Default searches cabd be quite expensive and can cause considerable strain on the server. For example, the command MATCH * priefix "" returns all entries from all available databases, which would consume a lot of resources both on the server and on the client side.

To minimize harmful effects from such potentially dangerous requests, the following statement makes it possible to limit the use of certain strategies in default searches:

strategy NAME {
    deny-all BOOL;
    deny-word CONDLIST;
    deny-length-lt NUMBER;
    deny-length-le NUMBER;
    deny-length-gt NUMBER;
    deny-length-ge NUMBER;
    deny-length-eq NUMBER;
    deny-length-ne NUMBER;
}

deny-all BOOL

Unconditionally deny the use of this strategy in default searches.

deny-word LIST

Deny this strategy if the search word matches one of the words from LIST.

deny-length-lt NUMBER

Deny if length of the search word is less than NUMBER.

deny-length-le NUMBER

Deny if length of the search word is less than or equal to NUMBER.

deny-length-gt NUMBER

Deny if length of the search word is greater than NUMBER.

deny-length-ge NUMBER

Deny if length of the search word is greater than or equal to NUMBER.

deny-length-eq NUMBER

Deny if length of the search word is equal to NUMBER.

deny-length-ne NUMBER

Deny if length of the search word is not equal to NUMBER.

For example, the following statement denies the use of prefix strategy in default searches if its argument is an empty string:

strategy prefix {
    deny-length-eq 0;
}

TUNING

timing BOOLEAN

Provide timing information after successful completion of an operation.

This information is displayed after replies to the following requests: MATCH, DEFINE, and QUIT. The format is:

[d/m/c = ND/NM/NC RTr UTu STs]

where:

ND

Number of processed define requests.

NM

Number of processed match requests.

NC

Number of comparisons made. This value may be inaccurate if the underlying database module does not provide such information.

RT

Real time spent serving the request.

UT

Time in user space spent serving the request.

ST

Time in kernel space spent serving the request.

You can also add timing information to your access log files. See the %T conversuion in section ACCESS LOG.

COMMAND ALIASES

alias WORD COMMAND

Creates a new alias.

Aliases may be recursive, i.e. the first word of COMMAND may refer to another alias. To prevent endless loops, recursive expansion is stopped if the first word of the replacement text is identical to an alias expanded earlier.

Aliases are useful to facilitate manual interaction with the server, as they allow the administrator to create abbreviations for some frequently typed commands. For example, the following alias creates new command d which is equivalent to DEFINE *:

alias d DEFINE "*";

SEE ALSO

Complete GNU Dico manual: run info dico or use emacs(1) info mode to read it.

Online copies of GNU Dico documentation in various formats can be found at:

http://www.gnu.org.ua/software/dico/manual

AUTHORS

BUG REPORTS

COPYRIGHT