PINENTRY-WRAPPER(1)

NAME
pinentry-wrapper - customize pinentry prompts using environment variables

SYNOPSIS
[ENVIRONMENT_VARIABLE]... pinentry-wrapper [OPTION]...

DESCRIPTION
pinentry-wrapper is a wrapper script around pinentry to customize prompts using environment variables to set options through the Assuan protocol.

Its default behavior is to call pinentry, set options, send the GETPIN command, retrieve the password entered by the user, and print it to standard output.

This allows a script to easily prompt for passwords without needing to communicate with pinentry at all.

OPTIONS
All options are passed as-is to pinentry. The wrapper itself supports no options.

ENVIRONMENT VARIABLES

SETONLY
    If set, pinentry-wrapper will only set options from environment variables. The calling script will have to send the GETPIN command and analyze pinentry's output by itself to retrieve the password entered by the user.

DEBUG
    If set, pinentry-wrapper will print additional debugging output, and add --debug to pinentry's options.

The following environment variables may be used to set options:

SETTITLE
    Set the window's title (default: front-end program name).

SETPROMPT
    Set the prompt (default: "PIN:").

SETDESC
    Set the description (displayed under the prompt; no default).

SETERROR
    Set the error text (displayed under the password entry field; no default).

SETOK
    Set the label of the OK button (default: "Continue").

SETCANCEL
    Set the label of the Cancel button (default: "Cancel").

SETNOTOK
    Set the label of the third button.

EXAMPLE

Ask user to choose a password:
    $ SETTITLE="My script" SETPROMPT="Password configuration" SETDESC="Please choose a password." pinentry-wrapper

Ask a French user to choose a password:
    $ SETTITLE="Mon script" SETPROMPT="Configuration du mot de passe" SETDESC="Veuillez choisir un mot de passe." SETOK="Continuer" SETCANCEL="Annuler" pinentry-wrapper

SEE ALSO
pinentry(1).