summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJameson Graef Rollins <jrollins@phys.columbia.edu>2008-06-11 12:00:36 -0400
committerJameson Graef Rollins <jrollins@phys.columbia.edu>2008-06-11 12:00:36 -0400
commitb489d119fc6c61e43c88efffb2ba4705ac4aeca8 (patch)
tree69fa8be52d19604b3b77ab81ef52b987f8b509e2 /man
parent6a278713cc9fd475acae6bb131a44fc9b26ddac6 (diff)
Fill out a little of the man pages.
Diffstat (limited to 'man')
-rw-r--r--man/man1/monkeysphere.176
-rw-r--r--man/man8/monkeysphere-server.854
2 files changed, 130 insertions, 0 deletions
diff --git a/man/man1/monkeysphere.1 b/man/man1/monkeysphere.1
index 4c3d483..fff16ba 100644
--- a/man/man1/monkeysphere.1
+++ b/man/man1/monkeysphere.1
@@ -4,3 +4,79 @@ monkeysphere \- monkeysphere client user interface
.SH SYNOPSIS
.B monkeysphere \fIcommand\fP [\fIargs\fP]
.SH DESCRIPTION
+.PP
+\fBmonkeysphere\fP is the client monkeysphere tool.
+.SH SUBCOMMANDS
+\fBmonkeysphere\fP takes various subcommands:
+.PD
+.TP
+.B update-known_hosts [HOST]...
+Update the known_hosts file. For every host listed, search for a gpg
+key for the host in the Web of Trust. If a key is found, any ssh keys
+for the host are removed from the known_hosts file. If the found key
+is acceptable (see KEY ACCEPTABILITY), then the gpg key is converted
+to an ssh key and added to the known_hosts file. If now gpg key is
+found for the host, then nothing is done. If no hosts are specified,
+all hosts listed in the known_hosts file will be processed. If they
+`k' may be used in place of `update-known_hosts'.
+.TP
+.B update-authorized_keys
+Update the authorized_keys file.
+.TP
+.B update-userids [USERID]...
+Update userid
+.TP
+.B gen-ae-subkey KEYID
+Generate an `ae` capable subkey
+.TP
+.B help
+Output a brief usage summary. `h' or `?' may be used in place of
+`help'.
+.PD
+.SH KEY ACCEPTABILITY
+GPG keys are considered acceptable if the following criteria are met:
+.PD
+.TP
+.B capability
+The key must have both the "authentication" and "encrypt" capability
+flags.
+.TP
+.B validity
+The key must be "fully" valid, and must not be expired or revoked.
+.PD
+.SH FILES
+.PD 1
+.TP
+~/.config/monkeysphere/monkeysphere.conf
+User monkeysphere config file.
+.TP
+/etc/monkeysphere/monkeysphere.conf
+System-wide monkeysphere config file.
+.TP
+~/.config/monkeysphere/authorized_user_ids
+GPG user IDs to validate for addition to the authorized_keys file.
+.TP
+~/.config/monkeysphere/authorized_keys
+Monkeysphere generated authorized_keys file.
+.TP
+~/.config/monkeysphere/user_keys
+User keys cache directory.
+.TP
+~/.config/monkeysphere/host_keys
+Host keys cache directory.
+.PD
+.SH AUTHOR
+Written by Jameson Rollins
+.SH "REPORTING BUGS"
+Report bugs to <???@???>.
+.SH COPYRIGHT
+Copyright \(co 2008 Jameson Graef Rollins and Daniel Kahn Gillmor
+.br
+This is free software. You may redistribute copies of it under the
+terms of the GNU General Public License
+<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the
+extent permitted by law.
+.SH "SEE ALSO"
+.BR ssh (1),
+.BR gpg (1),
+.BR monkeysphere-server (8)
diff --git a/man/man8/monkeysphere-server.8 b/man/man8/monkeysphere-server.8
index 302bffb..39a8e5c 100644
--- a/man/man8/monkeysphere-server.8
+++ b/man/man8/monkeysphere-server.8
@@ -4,3 +4,57 @@ monkeysphere-server \- monkeysphere server admin user interface
.SH SYNOPSIS
.B monkeysphere-server \fIcommand\fP [\fIargs\fP]
.SH DESCRIPTION
+.PP
+\fBmonkeysphere-server\fP is the server admin monkeysphere tool.
+.SH SUBCOMMANDS
+\fBmonkeysphere-server\fP takes various subcommands:
+.PD
+.TP
+.B update-users [HOST]...
+.TP
+.B gen-key
+.TP
+.B publish-key
+.TP
+.B trust-keys KEYID...
+.TP
+.B update-user-userids USER USERID...
+.TP
+.B help
+Output a brief usage summary. `h' or `?' may be used in place of
+`help'.
+.PD
+.SH FILES
+.PD 1
+.TP
+/etc/monkeysphere/monkeysphere-server.conf
+System monkeysphere-server config file.
+.TP
+/etc/monkeysphere/monkeysphere.conf
+System-wide monkeysphere config file.
+.TP
+/etc/monkeysphere/gnupg
+Monkeysphere GNUPG home directory.
+.TP
+/etc/monkeysphere/authorized_user_ids/USER
+Server maintained authorized_user_ids files for users.
+.TP
+/var/lib/monkeysphere/stage/USER
+Staging directory for user key caches.
+.PD
+.SH AUTHOR
+Written by Jameson Rollins
+.SH "REPORTING BUGS"
+Report bugs to <???@???>.
+.SH COPYRIGHT
+Copyright \(co 2008 Jameson Graef Rollins and Daniel Kahn Gillmor
+.br
+This is free software. You may redistribute copies of it under the
+terms of the GNU General Public License
+<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the
+extent permitted by law.
+.SH "SEE ALSO"
+.BR monkeysphere (1),
+.BR gpg (1),
+.BR ssh (1)
+