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.

              o splash: show the splash screen on startup (default: false)

              o tick_rate: set the tick rate of the terminal (default: 250)

              o color: set the accent color of the terminal (default: gray)

              o style: set the style of the terminal (default: colored)
                (possible values: plain, colored)

              o file_explorer: set the utility for file selection (default:
                xplr)

              o detail_level: set the detail level for the keys (default:
                minimum) (possible values: minimum, standard, full)

              o log_file: set the file to save the logs

              o key_bindings: list of custom key bindings



       [gpg]  Section for GnuPG settings.

              o armor: enable ASCII armored output (default: false)

              o homedir: set the GnuPG home directory

              o outdir: set the output directory

              o outfile: set the template for the output file name

              o 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 Parmaksiz <orhunparmaksiz@gmail.com>


ABOUT
       gpg-tui is maintained by Orhun Parmaksiz, and released under the MIT
       license.

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


SEE ALSO
       gpg-tui(1)

gpg-tui 0.11.0                    March 2024                   GPG-TUI.TOML(5)