gpg-tui.toml(5)

GPG-TUI.TOML(5)

File Formats Manual

GPG-TUI.TOML(5)

NAME

gpg-tui.toml - configuration file for gpg-tui

SYNOPSIS

The gpg-tui.toml 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 --config option or $GPG_TUI_CONFIG environment variable. If the file does not exist at the appropriate location or is not provided, gpg-tui uses its default configuration settings.

DESCRIPTION

The TOML file used to configure gpg-tui has a section of general settings followed by the gpg section that allows configuring the GnuPG options.

FORMAT

[general]: Section for general settings.

splash: show the splash screen on startup (default: false)
tick_rate: set the tick rate of the terminal (default: 250)
color: set the accent color of the terminal (default: gray)
style: set the style of the terminal (default: colored) (possible values: plain, colored)
file_explorer: set the utility for file selection (default: xplr)
detail_level: set the detail level for the keys (default: minimum) (possible values: minimum, standard, full)
log_file: set the file to save the logs
key_bindings: list of custom key bindings

[gpg]: Section for GnuPG settings.

armor: enable ASCII armored output (default: false)
homedir: set the GnuPG home directory
outdir: set the output directory
outfile: set the template for the output file name
default_key: set the default key to sign with

EXAMPLE

The following is a complete gpg-tui.toml default configuration example:

[general]


  splash = false


  tick_rate = 250


  color = "gray"


  style = "colored"


  file_explorer = "xplr"


  detail_level = "minimum"


  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 = ""

BUGS

Report bugs at <https://github.com/orhun/gpg-tui/issues> or contact the author via email.

AUTHOR

Orhun Parmaksız <orhunparmaksiz@gmail.com>

ABOUT

gpg-tui is maintained by Orhun Parmaksız, and released under the MIT license.

See the project homepage at <https://github.com/orhun/gpg-tui> for full documentation.