1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
.\" Manpage of gpg-tui.toml
.nh
.TH GPG-TUI.TOML "5" "February 2022" "gpg-tui 0.8.3"
.SH NAME
.PP
gpg-tui.toml - configuration file for gpg-tui
.SH SYNOPSIS
.PP
The \fBgpg-tui.toml\fP file is a configuration file for gpg-tui. The
file must be placed at one of the following locations:
$HOME/.config/gpg-tui.toml, $HOME/.config/gpg-tui/gpg-tui.toml,
$HOME/.config/gpg-tui/config
It can be also specified with the \fB--config\fP option or $GPG_TUI_CONFIG
environment variable.
If the file does not exist at the appropriate location or is not provided,
\fBgpg-tui\fP uses its default configuration settings.
.SH DESCRIPTION
.PP
The TOML file used to configure gpg-tui has a section of general settings
followed by the \fBgpg\fP section that allows configuring the GnuPG options.
.SH FORMAT
.TP
\fB[general]\fP
Section for general settings.
.RS
.IP \(bu 2
\fBsplash\fP: show the splash screen on startup (default: false)
.IP \(bu 2
\fBtick_rate\fP: set the tick rate of the terminal (default: 250)
.IP \(bu 2
\fBcolor\fP: set the accent color of the terminal (default: gray)
.IP \(bu 2
\fBstyle\fP: set the style of the terminal (default: plain) (possible values: plain, colored)
.IP \(bu 2
\fBfile_explorer\fP: set the utility for file selection (default: xplr)
.IP \(bu 2
\fBkey_bindings\fP: list of custom key bindings
.RE
.TP
\fB[gpg]\fP
Section for GnuPG settings.
.RS
.IP \(bu 2
\fBarmor\fP: enable ASCII armored output (default: false)
.IP \(bu 2
\fBhomedir\fP: set the GnuPG home directory
.IP \(bu 2
\fBoutdir\fP: set the output directory
.IP \(bu 2
\fBoutfile\fP: set the template for the output file name
.IP \(bu 2
\fBdefault_key\fP: set the default key to sign with
.RE
.SH EXAMPLE
.PP
The following is a complete \fBgpg-tui.toml\fP default configuration example:
.PP
.RS
.nf
[general]
splash = false
tick_rate = 250
color = "gray"
style = "plain"
file_explorer = "xplr"
key_bindings = [
{ keys = [ "?", "h", "f1" ], command = ":help" },
{ keys = [ "C-d", "C-c", "q" ], command = ":quit" },
]
[gpg]
armor = false
homedir = "~/.gnupg"
outdir = "~/.gnupg/out"
outfile = "{type}_{query}.{ext}"
default_key = ""
.fi
.RE
.SH BUGS
Report bugs at <https://github.com/orhun/gpg-tui/issues> or contact the author via email.
.SH AUTHOR
Orhun Parmaksız <orhunparmaksiz@gmail.com>
.SH ABOUT
.P
\f[I]gpg-tui\f[R] is maintained by Orhun Parmaksız, and released under the MIT license.
.PP
See the project homepage at <https://github.com/orhun/gpg-tui> for full documentation.
.SH SEE ALSO
.PP
gpg-tui(1)
|
