NAME

       sq toolbox keyring filter - Join keys into a keyring applying a filter

SYNOPSIS

       sq toolbox keyring filter [OPTIONS] FILE

DESCRIPTION

       Join keys into a keyring applying a filter.

       This  can  be used to filter keys based on given predicates, e.g. whether they have a user
       id containing an email address with a certain  domain.   Additionally,  the  keys  can  be
       pruned to only include components matching the predicates.

       If no filters are supplied, everything matches.

       If  multiple  predicates  are  given,  they  are  or'ed,  i.e. a key matches if any of the
       predicates match.  To require all predicates to match, chain multiple invocations of  this
       command.  See EXAMPLES for inspiration.

OPTIONS

   Subcommand options
       -B, --binary
              Emit binary data

       -P, --prune-certs
              Remove certificate components not matching the filter

       --domain=FQDN
              Parse  user  ids  into  name  and email address and case-sensitively matches on the
              domain of the email address, requiring an exact match.

       --email=ADDRESS
              Parse user ids into name and email address  and  case-sensitively  matches  on  the
              email address, requiring an exact match.

       --handle=FINGERPRINT|KEYID
              Match on both primary keys and subkeys, including those certificates that match the
              given fingerprint or key id.

       --name=NAME
              Parse user ids into name and  email  and  case-sensitively  matches  on  the  name,
              requiring an exact match.

       -o, --output=FILE
              Write to FILE or stdout if omitted

       --to-cert
              Convert  any  keys in the input to certificates.  Converting a key to a certificate
              removes secret key material from the key thereby turning it into a certificate.

       --userid=USERID
              Case-sensitively matches on the user id, requiring an exact match.

        FILE  Read from FILE or stdin if omitted

   Global options
       See sq(1) for a description of the global options.

EXAMPLES

       Converts a key to a cert (i.e., remove any secret key material)

              sq toolbox keyring filter --to-cert cat juliet.pgp

       Gets the keys with a user id on example.org

              sq toolbox keyring filter --domain example.org keys.pgp

       Gets the keys with a user id on example.org or example.net

              sq toolbox keyring filter --domain example.org \
                     --domain example.net \
                     keys.pgp

       Gets the keys with a user id with the name Juliet

              sq toolbox keyring filter --name Juliet keys.pgp

       Gets the keys with a user id with the name Juliet on example.org

              sq toolbox keyring filter --domain example.org keys.pgp | \
                     sq toolbox keyring filter --name Juliet

       Gets the keys with a user id on example.org, pruning other userids

              sq toolbox keyring filter --domain example.org --prune-certs \
                     certs.pgp

SEE ALSO

       sq(1), sq-toolbox(1), sq-toolbox-keyring(1).

       For the full documentation see <https://book.sequoia-pgp.org>.

VERSION

       0.34.0 (sequoia-openpgp 1.19.0)