X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=man%2Fman1%2Fmonkeysphere.1;h=1d1c0e574f1a16216724d4465a00779a30ba7379;hb=8e1439bc18f8203d71c1237a25c21374ca17c38c;hp=07cd3ea80e82d385093c8338e880a449ef69178a;hpb=56e8fa26a4ce594f2c5c71b600df11fc9f255956;p=monkeysphere.git diff --git a/man/man1/monkeysphere.1 b/man/man1/monkeysphere.1 index 07cd3ea..1d1c0e5 100644 --- a/man/man1/monkeysphere.1 +++ b/man/man1/monkeysphere.1 @@ -2,7 +2,7 @@ .SH NAME -monkeysphere \- MonkeySphere client user interface +monkeysphere \- Monkeysphere client user interface .SH SYNOPSIS @@ -10,12 +10,12 @@ monkeysphere \- MonkeySphere client user interface .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 @@ -37,29 +37,53 @@ 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 monkeysphere 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 add 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 wer 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 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-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. `g' may be used in -place of `gen-subkey'. +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'. .TP .B help Output a brief usage summary. `h' or `?' may be used in place of `help'. +.SH ENVIRONMENT + +The following environment variables will override those specified in +the monkeysphere.conf configuration file (defaults in parentheses): +.TP +MONKEYSPHERE_GNUPGHOME, GNUPGHOME +GnuPG home directory (~/.gnupg). +.TP +MONKEYSPHERE_KEYSERVER +OpenPGP keyserver to use (subkeys.pgp.net). +.TP +MONKEYSPHERE_CHECK_KEYSERVER +Whether or not to check keyserver when making gpg queries (`true'). +.TP +MONKEYSPHERE_KNOWN_HOSTS +Path to ssh known_hosts file (~/.ssh/known_hosts). +.TP +MONKEYSPHERE_HASH_KNOWN_HOSTS +Whether or not to hash to the known_hosts file entries (`true'). +.TP +MONKEYSPHERE_AUTHORIZED_KEYS +Path to ssh authorized_keys file (~/.ssh/authorized_keys). + .SH FILES .TP