monkeysphere debianization. Package can now be cleanly built with minimal lintian...
[monkeysphere.git] / man / man1 / openpgp2ssh.1
index 1a02b3819393f386a17ae54392261670e8ecaa19..83b615467566ed977487fb5201739d08ec0efbc6 100644 (file)
@@ -7,31 +7,34 @@ openpgp2ssh
 .Nd translate OpenPGP keys to SSH keys
 .Sh SYNOPSIS
 .Nm openpgp2ssh < mykey.gpg 
-
+.Pp
 .Nm gpg --export $KEYID | openpgp2ssh $KEYID
-
+.Pp
 .Nm gpg --export-secret-key $KEYID | openpgp2ssh $KEYID
 .Sh DESCRIPTION
-openpgp2ssh takes an OpenPGP-formatted primary key and associated
+.Nm
+takes an OpenPGP-formatted primary key and associated
 subkeys on standard input, and spits out the requested equivalent
 SSH-style key on standard output.
-
+.Pp
 If the data on standard input contains no subkeys, you can invoke
-openpgp2ssh without arguments.  If the data on standard input contains
+.Nm
+without arguments.  If the data on standard input contains
 multiple keys (e.g. a primary key and associated subkeys), you must
 specify a specific OpenPGP keyid (e.g. CCD2ED94D21739E9) or
 fingerprint as the first argument to indicate which key to export.
 The keyid must be exactly 16 hex characters.
-
+.Pp
 If the input contains an OpenPGP RSA or DSA public key, it will be
 converted to the OpenSSH-style single-line keystring, prefixed with
 the key type.  This format is suitable (with minor alterations) for
 insertion into known_hosts files and authorized_keys files.
-
+.Pp
 If the input contains an OpenPGP RSA or DSA secret key, it will be
 converted to the equivalent PEM-encoded private key.
-
-openpgp2ssh is part of the
+.Pp
+.Nm
+is part of the
 .Xr monkeysphere 1
 framework for providing a PKI for SSH.
 .Sh CAVEATS
@@ -39,17 +42,20 @@ The keys produced by this process are stripped of all identifying
 information, including certifications, self-signatures, etc.  This is
 intentional, since ssh attaches no inherent significance to these
 features.
-
-openpgp2ssh only works with RSA or DSA keys, because those are the
+.Pp
+.Nm
+only works with RSA or DSA keys, because those are the
 only ones which work with ssh.
-
-Assuming a valid key type, though, openpgp2ssh will produce output for
+.Pp
+Assuming a valid key type, though, 
+.Nm
+will produce output for
 any requested key.  This means, among other things, that it will
 happily export revoked keys, unverifiable keys, expired keys, etc.
 Make sure you do your own key validation before using this tool!
 .Sh EXAMPLES
 .Nm gpg --export-secret-key $KEYID | openpgp2ssh $KEYID | ssh-add -c /dev/stdin
-
+.Pp
 This pushes the secret key into the active
 .Xr ssh-agent 1 . 
 Tools such as 
@@ -58,21 +64,25 @@ which know how to talk to the
 .Xr ssh-agent 1
 can now rely on the key.
 .Sh AUTHOR
-openpgp2ssh and this man page were written by Daniel Kahn Gillmor
+.Nm
+and this man page were written by Daniel Kahn Gillmor
 <dkg@fifthhorseman.net>.
 .Sh BUGS
-openpgp2ssh currently only exports into formats used by the OpenSSH.
+.Nm
+currently only exports into formats used by the OpenSSH.
 It should support other key output formats, such as those used by
 lsh(1) and putty(1).
-
+.Pp
 Secret key output is currently not passphrase-protected.
-
-openpgp2ssh currently cannot handle passphrase-protected secret keys on input.
-
+.Pp
+.Nm
+currently cannot handle passphrase-protected secret keys on input.
+.Pp
 It would be nice to be able to use keyids shorter or longer than 16
 hex characters.
-
-openpgp2ssh only acts on keys associated with the first primary key
+.Pp
+.Nm
+only acts on keys associated with the first primary key
 passed in.  If you send it more than one primary key, it will silently
 ignore later ones.
 .Sh SEE ALSO