[Pkg-gnupg-commit] [gnupg2] 105/241: doc: Add documentation for gpgkey2ssh.

[Daniel Kahn Gillmor]

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

dkg pushed a commit to branch master
in repository gnupg2.

commit 2b27acc3435e73fad7460b551a36b4064cdd58be
Author: Neal H. Walfield <neal at g10code.com>
Date:   Thu Nov 5 13:57:32 2015 +0100

    doc: Add documentation for gpgkey2ssh.
    
    * doc/tools.texi: Add documentation for gpgkey2ssh.
    
    --
    Signed-off-by: Neal H. Walfield <neal at g10code.com>
    Co-authored-by: Daniel Kahn Gillmor <dkg at fifthhorseman.net>
    GnuPG-bug-id: 1067
    Debian-bug-id 380241
---
 doc/tools.texi | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/doc/tools.texi b/doc/tools.texi
index 425790e..bab0fe8 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -21,6 +21,7 @@ GnuPG comes with a couple of smaller tools:
 * gpgparsemail::          Parse a mail message into an annotated format
 * symcryptrun::           Call a simple symmetric encryption tool.
 * gpg-zip::               Encrypt or sign files into an archive.
+* gpgkey2ssh::            Emit GPG public keys in OpenSSH format.
 @end menu
 
 @c
@@ -1893,3 +1894,73 @@ gpg-zip --list-archive test1
 @command{tar}(1),
 @end ifset
 @include see-also-note.texi
+
+
+ at c
+ at c  GPGKEY2SSH
+ at c
+ at manpage gpgkey2ssh.1
+ at node gpgkey2ssh
+ at section Emit GPG public keys in OpenSSH format
+ at ifset manverb
+.B gpgkey2ssh \- Emit GPG public keys in OpenSSH format
+ at end ifset
+
+ at mansect synopsis
+ at ifset manverb
+.B  gpgkey2ssh
+.I keyid
+ at end ifset
+
+ at mansect description
+ at command{gpgkey2ssh} emits the public key of an OpenPGP RSA or DSA key
+in a format readable by OpenSSH clients and servers.
+
+It takes only a single argument, a key ID, which designates the
+primary key or subkey whose public key should be converted.
+
+The key ID should use upper-case (A-F, not a-f) for all hex digits
+greater than 9, and the key in question must be present in
+ at code{gpg}'s public keyring.
+
+The output of a successful run can be used verbatim as an entry in an
+ at code{authorized_keys} file for @code{sshd}, or can be prefixed with a
+host name and appended to a @code{known_hosts} file for @code{ssh}.
+
+ at mansect return value
+
+The program returns 0 if the key was successfully converted and
+non-zero if there was an error (e.g., if the key ID was malformed, the
+key was not present in the public keyring, or if the key is not an RSA
+or DSA key).
+
+ at mansect environment
+ at subsection Environment
+
+ at table @asis
+
+ at item HOME
+Used to locate the default home directory.
+
+ at item GNUPGHOME
+If set directory used instead of "~/.gnupg".
+
+ at end table
+
+ at mansect files
+ at subsection FILES
+
+ at table @asis
+
+ at item gpg2
+The command used to search the user's keyring.
+
+ at end table
+
+ at mansect see also
+ at ifset isman
+ at command{gpg2}(1),
+ at command{sshd}(8),
+ at command{ssh}(1)
+ at end ifset
+ at include see-also-note.texi

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