From 263743c43945d4ee8d0fcd88636db3ddd4981eaa Mon Sep 17 00:00:00 2001 From: Einhard Leichtfuß Date: Mon, 24 Dec 2018 20:21:08 +0100 Subject: Split off ctct_config(5) --- ctct_config.5.in | 197 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 197 insertions(+) create mode 100644 ctct_config.5.in (limited to 'ctct_config.5.in') diff --git a/ctct_config.5.in b/ctct_config.5.in new file mode 100644 index 0000000..a1f6184 --- /dev/null +++ b/ctct_config.5.in @@ -0,0 +1,197 @@ +.\" ctct_config.5 - the man page for configuration of ctct +.\" +.\" Copyright 2015 - 2018 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 . +.\" +.TH CTCT_CONFIG 5 "2018-12-24" "ctct @PACKAGE_VERSION@" +.\" +.\" +.SH NAME +ctct_config \- configuration of ctct +.SH DESCRIPTION +.P +The main configuration file for +.BR ctct (1) +is +.IR @default_confdir@/config\.sh \. +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_dir \. +.P +The following variables are recognized: +.\" +.TP +.B user_config_dir +The directory where the per user configuration file +.I config\.sh +is searched for\. +If set, this variable must contain the prefix +.I $HOME +or alternatively any other variable resolving to a directory +below the respective home directory\. +.RI "The default value is " @default_user_config_dir@ \. +.\" +.TP +.B datadir +The location of the directory where the contact data are stored\. +Typically, +.B datadir +should contain the prefix +.IR $HOME \. +The default value is +.IR @default_datadir@ \. +.\" +.TP +.B default_editor +The editor to use when +.B ctct +is called with the +.B \-\-edit +option\. +If set, supersedes both the +.RB $ EDITOR +environment variable +and the +.BR fallback_editor \. +By default, unset. +.\" +.TP +.B fallback_editor +The editor to fall back to if neither the environment variable +.RB $ EDITOR +nor +.B default_editor +is set\. +The default value is +.IR @default_fallback_editor@ \. +.\" +.TP +.B input_program +The program with arguments +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 +.B output_program +The program with arguments +that any contact data that are to be print are passed to\. +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 +.B visual_program +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 +.B confirm_deletion +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 +.B confirm_default_yes +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 @default_confdir@/config\.sh +System wide configuration file\. +.\" +.TP +.I @default_user_config_dir@/config\.sh +Default location of the user configuration file\. +.\" +.TP +.I @default_datadir@/ +Default +.BR datadir \. +.\" +.\" +.SH SEE ALSO +.BR ctct (1), +.BR vi (1), +.BR less (1), +.BR more (1) +.\" vi: tw=75 -- cgit v1.2.3