#!/usr/bin/perl

=head1 NAME

.ddtcrc - ddtc script configuration file.

=head1 DESCRIPTION

This is the configuration file for ddtc. If it exists, it must be at the top of
your home directory (F<$HOME>). This file is optional unless you don't want to
use default values.

Lines beginning with a number sign (`B<#>') and empty lines will be ignored.
Spaces at the beginning and the end of a line will also be ignored as well as
tabulators.  If you need spaces at the end or the beginning of a value you can
use apostrophes (`B<">').
An option line starts with it's name followed by a value. An equal sign is
optional.
A comment starts with the number sign, there can be any number of spaces and/or
tab stops in front of the #.
Some possible examples:

 # this line is ignored
 option   value
 option = value                               # this is a comment
 option        "value ending with space   "

You have to escape number signs with a backslash (`B<\>') to use it in a value.

Default values are provided into square brackets, they should be suitable for
most installations.

You can use the configuration menu from interactive mode to edit it.

=head1 GENERAL

=over 4

=item I<base_dir>

base directory, sub-directory of your F<$HOME> unless an absolute path (i.e.
beginning with `/') is provided [ddts]

=item I<comment>

comment string for review, a space character will be added to this string [>>]

=item I<clean_regex>

regular expression to remove file with I<clean> command
[~\$|\.old\$|\.bak\$]

=item I<language>

language extension to use when asking for new documents to translate or to
review [none]

=item I<editor>

text editor [sensible-editor]

=item I<ddtc_bug>

whether reviews are sent in a special way to prevent updating ddts parts
databases or not. [no]

Caution: if set to `B<yes>', the `reply to accept modification' ddts feature
doesn't work anymore and the whole language team should use ddtc. Ask your
language team coordinator before setting this option.

=back

=head1 EMAIL

=over 4

=item I<mail_out>

your email address [first found in $ENV{EMAIL}, $ENV{DEBEMAIL} or none]

=item I<mail_in>

the mail address you want the ddts to answer to. This is the address the ddts
uses for your identification so you B<must> use this if you need to set
I<mail_out> to another value [I<mail_out>]

=item I<mail_server>

email address of the server [desc@ddtp.debian.org]

=item I<mail_encoding>

mail encoding for mime [8bit]

=item I<mail_charset>

mail charset for mime [ISO-8859-1 for lack of charset used by ddts]

=item I<mail_self>

set to `B<yes>' if you want to be sent a copy of outgoing mail [yes]

=back

=head1 MENU COLORS

Set text colors for clear presentation.

The recognized colors (all of which should be fairly intuitive) are: B<clear>,
B<reset>, B<dark>, B<bold>, B<underline>, B<underscore>, B<blink>, B<reverse>,
B<concealed>, B<black>, B<red>, B<green>, B<yellow>, B<blue>, B<magenta>,
B<cyan>, B<white>, B<on_black>, B<on_red>, B<on_green>, B<on_yellow>,
B<on_blue>, B<on_magenta>, B<on_cyan>, and B<on_white>.  Case is not
significant.  Underline and underscore are equivalent, as are clear and reset,
so use whichever is the most intuitive to you.  The I<color> alone sets the
foreground color, and I<on_color> sets the background color.

Note that not all colors are supported by all terminal types, and some
terminals may not support any of these sequences.  Dark, blink, and concealed
in particular are frequently not implemented.

=over 4

=item menu_title_color

color used for menu title [bold cyan]

=item menu_letter_color

color used for the letter to be entered [bold cyan]

=item menu_text_color

color used for the menu item description [cyan]

=back

=head1 EXAMPLE

A ddtc configuration example file can be found at
F</usr/share/doc/ddtc/ddtcrc>.

=head1 SEE ALSO

ddtc(1).

=head1 AUTHOR

Nicolas Bertolissio <bertol@debian.org>
  
=cut
