[Pkg-gnupg-commit] [gnupg2] 15/16: document migrate-pubring-from-classic-gpg

[Daniel Kahn Gillmor]

This is an automated email from the git hooks/post-receive script.

dkg pushed a commit to branch experimental
in repository gnupg2.

commit 9e7947bd4f6a428bc6e41c8f7aecc131b49f1481
Author: Daniel Kahn Gillmor <dkg at fifthhorseman.net>
Date:   Fri Apr 1 15:12:29 2016 -0300

    document migrate-pubring-from-classic-gpg
---
 debian/migrate-pubring-from-classic-gpg   |  2 ++
 debian/migrate-pubring-from-classic-gpg.1 | 50 +++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+)

diff --git a/debian/migrate-pubring-from-classic-gpg b/debian/migrate-pubring-from-classic-gpg
index 65fa770..d560e38 100755
--- a/debian/migrate-pubring-from-classic-gpg
+++ b/debian/migrate-pubring-from-classic-gpg
@@ -8,6 +8,8 @@
 
 # This was written for the Debian project
 
+set -e
+
 GPG="${GPG:-gpg}"
 
 # select the default GnuPG home directory to work from:
diff --git a/debian/migrate-pubring-from-classic-gpg.1 b/debian/migrate-pubring-from-classic-gpg.1
new file mode 100644
index 0000000..4d26b89
--- /dev/null
+++ b/debian/migrate-pubring-from-classic-gpg.1
@@ -0,0 +1,50 @@
+.TH "MIGRATE-PUBRING-FROM-CLASSIC-GPG" 1 "April 2016"
+
+.SH NAME
+migrate\-pubring\-from\-classic\-gpg \- Migrate a public keyring from "classic" to "modern" GnuPG
+
+.SH SYNOPSIS
+.B migrate\-pubring\-from\-classic\-gpg
+.RB "[ " GPGHOMEDIR " | "
+.IR \-\-default " ]"
+
+.SH DESCRIPTION
+
+.B migrate\-pubring\-from\-classic\-gpg
+migrates the public keyring in GnuPG home directory GPGHOMEDIR from
+the "classic" keyring format to the "modern" keybox format using GnuPG
+versions 2.1 or 2.2.
+
+Specifying
+.B \-\-default
+selects the standard GnuPG home directory (looking at $GNUPGHOME
+first, and falling back to ~/.gnupg if unset.
+
+.SH OPTIONS
+.BR \-h ", " \-\-help ", " \-\-usage
+Output a short usage information.
+
+.SH DIAGNOSTICS
+The program sends quite a bit of text (perhaps too much) to stderr.
+
+During a migration, the tool backs up several pieces of data in a
+timestamped subdirectory of the GPGHOMEDIR.
+
+.SH ENVIRONMENT VARIABLES
+
+.B GNUPGHOME
+Selects the GnuPG home directory when set and --default is given.
+
+.B GPG
+The name of the
+.B gpg
+executable (defaults to
+.B gpg
+).
+
+.SH SEE ALSO
+.BR gpg (1)
+
+.SH AUTHOR
+Copyright (C) 2016 Daniel Kahn Gillmor for the Debian project. Please
+report bugs via the Debian BTS.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/gnupg2.git