.SH NAME
-monkeysphere \- MonkeySphere client user interface
+monkeysphere \- Monkeysphere client user interface
.SH SYNOPSIS
.SH DESCRIPTION
-\fBMonkeySphere\fP is a framework to leverage the OpenPGP Web of Trust
-for ssh authentication. OpenPGP keys are tracked via GnuPG, and added
-to the authorized_keys and known_hosts files used by ssh for
+\fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust
+for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and
+added to the authorized_keys and known_hosts files used by OpenSSH for
connection authentication.
-\fBmonkeysphere\fP is the MonkeySphere client utility.
+\fBmonkeysphere\fP is the Monkeysphere client utility.
.SH SUBCOMMANDS
.B update-known_hosts [HOST]...
Update the known_hosts file. For each specified host, gpg will be
queried for a key associated with the host URI (see HOST
-IDENTIFICATION in monkeysphere(5)), optionally querying a keyserver.
+IDENTIFICATION in
+.BR monkeysphere(5)),
+optionally querying a keyserver.
If an acceptable key is found for the host (see KEY ACCEPTABILITY in
-monkeysphere(5)), the key is added to the user's known_hosts file. If
-a key is found but is unacceptable for the host, any matching keys are
-removed from the user's known_hosts file. If no gpg key is found for
-the host, nothing is done. If no hosts are specified, all hosts
-listed in the known_hosts file will be processed. This subcommand
-will exit with a status of 0 if at least one acceptable key was found
-for a specified host, 1 if no matching keys were found at all, and 2
-if matching keys were found but none were acceptable. `k' may be used
-in place of `update-known_hosts'.
+.BR monkeysphere(5)),
+the key is added to the user's known_hosts file. If a key is found
+but is unacceptable for the host, any matching keys are removed from
+the user's known_hosts file. If no gpg key is found for the host,
+nothing is done. If no hosts are specified, all hosts listed in the
+known_hosts file will be processed. This subcommand will exit with a
+status of 0 if at least one acceptable key was found for a specified
+host, 1 if no matching keys were found at all, and 2 if matching keys
+were found but none were acceptable. `k' may be used in place of
+`update-known_hosts'.
.TP
.B update-authorized_keys
-Update the authorized_keys file. For each user ID in the user's
-authorized_user_ids file, gpg will be queried for keys associated with
-that user ID, optionally querying a keyserver. If an acceptable key
-is found (see KEY ACCEPTABILITY in monkeysphere(5)), the key is added
-to the user's authorized_keys file. If a key is found but is
-unacceptable for the user ID, any matching keys are removed from the
-user's authorized_keys file. If no gpg key is found for the user ID,
-nothing is done. This subcommand will exit with a status of 0 if at
-least one acceptable key was found for a user ID, 1 if no matching
-keys were found at all, and 2 if matching keys were found but none
-were acceptable. `a' may be used in place of
+Update the authorized_keys file for the user executing the command
+(see MONKEYSPHERE_AUTHORIZED_KEYS in ENVIRONMENT, below). First all
+monkeysphere keys are cleared from the authorized_keys file. Then, or
+each user ID in the user's authorized_user_ids file, gpg will be
+queried for keys associated with that user ID, optionally querying a
+keyserver. If an acceptable key is found (see KEY ACCEPTABILITY in
+.BR monkeysphere (5)),
+the key is added to the user's authorized_keys file.
+If a key is found but is unacceptable for the user ID, any matching
+keys are removed from the user's authorized_keys file. If no gpg key
+is found for the user ID, nothing is done. This subcommand will exit
+with a status of 0 if at least one acceptable key was found for a user
+ID, 1 if no matching keys were found at all, and 2 if matching keys
+were found but none were acceptable. `a' may be used in place of
`update-authorized_keys'.
.TP
-.B gen-subkey KEYID
-Generate an authentication subkey. For the primary key with the
-specified key ID, generate a subkey with "authentication" capability
-that can be used for monkeysphere transactions. An expiration length
-can be specified with the `-e' or `--expire' option (prompt
-otherwise). `g' may be used in place of `gen-subkey'.
+.B gen-subkey [KEYID]
+Generate an authentication subkey for a private key in your GnuPG
+keyring. For the primary key with the specified key ID, generate a
+subkey with "authentication" capability that can be used for
+monkeysphere transactions. An expiration length can be specified with
+the `-e' or `--expire' option (prompt otherwise). If no key ID is
+specified, but only one key exists in the secret keyring, that key
+will be used. `g' may be used in place of `gen-subkey'.
+.TP
+.B subkey-to-ssh-agent [ssh-add arguments]
+Push all authentication-capable subkeys in your GnuPG secret keyring
+into your running ssh-agent. Additional arguments are passed through
+to
+.BR ssh-add (1).
+For example, to remove the authentication subkeys, pass an additional
+`-d' argument. To require confirmation on each use of the key, pass
+`-c'. `s' may be used in place of `subkey-to-ssh-agent'.
.TP
.B help
Output a brief usage summary. `h' or `?' may be used in place of
The following environment variables will override those specified in
the monkeysphere.conf configuration file (defaults in parentheses):
.TP
+MONKEYSPHERE_LOG_LEVEL
+Set the log level. Can be SILENT, ERROR, INFO, DEBUG, in increasing
+order of verbosity.
+.TP
MONKEYSPHERE_GNUPGHOME, GNUPGHOME
GnuPG home directory (~/.gnupg).
.TP
.BR monkeysphere-server (8),
.BR monkeysphere (5),
.BR ssh (1),
+.BR ssh-add (1),
.BR gpg (1)
projects / monkeysphere.git / blobdiff