.\" ctct_config.5 - the man page for configuration of ctct
.\"
.\" Copyright 2015 - 2019 Einhard Leichtfuß
.\"
.\" This file is part of ctct.
.\" 
.\" ctct is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU Affero General Public License as published
.\" by the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" ctct is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU Affero General Public License for more details.
.\"
.\" You should have received a copy of the GNU Affero General Public License
.\" along with ctct.  If not, see <https://www.gnu.org/licenses/>.
.\"
.TH CTCT_CONFIG 5 "2019-01-10" "ctct @PACKAGE_VERSION@"
.\"
.\"
.SH NAME
ctct_config \- configuration of ctct
.SH DESCRIPTION
.P
The main configuration file for
.BR ctct (1)
is
.IR @sysconfdir_expanded@/ctct_config \.
The file is a
.BR bash (1)
script which is simply sourced by
.BR ctct (1)\.
It must not exit\.
Any configuration is done by setting shell variables\.
Configuration may be overriden in per-user configuration scripts, see
.BR user_config_file \.
.P
To configure the choice of external programs, array variables are used\.
For these, the first element is the executable name; further elements may
specify arguments to the respective program\.
.P
The following variables are recognized:
.\"
.TP
.BR user_config_file "=\fIfile\fP"
The per user configuration file\.
If set,
.I file
must contain the prefix
.I $HOME
or alternatively any other variable resolving to a directory
below the respective home directory\.
The default value is
.IR @default_user_config_file@ \.
.\"
.TP
.BR datadir "=\fIpath\fP"
The location of the directory where the contact data are stored\.
Typically,
.I path
should contain the prefix
.IR $HOME \.
The default value is
.IR @default_datadir@ \.
.\"
.TP
.BR default_editor "=(\fIprogram\fP [\|\fIarg\fP \.\.\.\|])"
The editor to use when
.B ctct
is called with the
.B \-\-edit
option\.
If set, supersedes both the
environment variables
.RB $ VISUAL ,
.RB $ EDITOR
and the
.BR fallback_editor \.
By default, unset\.
.\"
.TP
.BR fallback_editor "=(\fIprogram\fP [\|\fIarg\fP \.\.\.\|])"
The editor to fall back to if neither any of the environment variables
.RB $ VISUAL
and
.RB $ EDITOR ,
nor
.B default_editor
is set\.
The default value is
.IR @default_fallback_editor@ \.
.\"
.TP
.BR input_program "=(\fIprogram\fP [\|\fIarg\fP \.\.\.\|])"
The program that gets passed the data written after editing a contact
entry\.
This is mostly useful in combination with an
.B output_program
to enable encryption\.
.br
If both
.B input_program
and
.B output_program
are set to
.IR cat ,
they have no special effect\.
Elsewise
.BR ctct (1)
supplied with the
.B \-\-edit
option, will operate on a temporary file populated by the output of
.BR output_program \.
When editing is done, the
.B input_program
will receive the content of that temporary file on stdin and its stdout
will be written on disk\.
The default value is
.IR @default_input_program@ \.
.\"
.TP
.BR output_program "=(\fIprogram\fP [\|\fIarg\fP \.\.\.\|])"
The program to convert data as stored on disk to human readable form\.
It should be inverse to
.BR input_program \.
Note, that the respective program must accept its input on stdin and print
its output on stdout\.
This option is hence not useful for pagers such as
.BR less (1)
or
.BR more (1)\.
Use
.B visual_program
for this purpose\.
The default value is
.IR @default_output_program@ \.
For further details, see
.BR input_program \.
.\"
.TP
.BR visual_program "=(\fIprogram\fP [\|\fIarg\fP \.\.\.\|])"
The program that the data as written by the
.B output_program
are passed to\.
It can be used with any program accepting its input on stdin\.
Common options are 
.BR less (1)
and
.BR more (1)\.
If it is set to
.IR cat ,
it has no effect\.
The default value is
.IR @default_visual_program@ \.
.\"
.TP
.BR confirm_deletion "=\fIboolean\fP"
Whether to ask for confirmation upon deleting an entry, that is when
.BR ctct (1)
is called with the
.B \-\-delete
option\.
The default value is
.IR @default_confirm_deletion@ \.
.\"
.TP
.BR confirm_default_yes "=\fIboolean\fP"
Whether to assume yes as answer to confirmation when no answer,
that is an empty answer is given\.
This option only has an effect, if
.B confirm_deletion
is set to true\.
The default value is
.IR @default_confirm_default_yes@ \.
.\"
.\"
.SH ENVIROMENT
.TP
.B HOME
The directory below of which the contact data and the user configuration
file are stored by default\.
.\"
.\"
.SH FILES
.TP
.I @sysconfdir_expanded@/ctct_config
System wide configuration file\.
.\"
.TP
.I @default_user_config_file@
Default location of the user configuration file\.
.\"
.TP
.I @default_datadir@/
Default
.BR datadir \.
.\"
.\"
.SH SEE ALSO
.BR ctct (1),
.BR bash (1),
.BR vi (1),
.BR less (1),
.BR more (1)
.\"
.\" vi: tw=75