Fill out a little of the man pages.
[monkeysphere.git] / man / man1 / monkeysphere.1
1 .TH MONKEYSPHERE "1" "June 2008" "monkeysphere 0.1" "User Commands"
2 .SH NAME
3 monkeysphere \- monkeysphere client user interface
4 .SH SYNOPSIS
5 .B monkeysphere \fIcommand\fP [\fIargs\fP]
6 .SH DESCRIPTION
7 .PP
8 \fBmonkeysphere\fP is the client monkeysphere tool.
9 .SH SUBCOMMANDS
10 \fBmonkeysphere\fP takes various subcommands:
11 .PD
12 .TP
13 .B update-known_hosts [HOST]...
14 Update the known_hosts file.  For every host listed, search for a gpg
15 key for the host in the Web of Trust.  If a key is found, any ssh keys
16 for the host are removed from the known_hosts file.  If the found key
17 is acceptable (see KEY ACCEPTABILITY), then the gpg key is converted
18 to an ssh key and added to the known_hosts file.  If now gpg key is
19 found for the host, then nothing is done.  If no hosts are specified,
20 all hosts listed in the known_hosts file will be processed.  If they
21 `k' may be used in place of `update-known_hosts'.
22 .TP
23 .B update-authorized_keys
24 Update the authorized_keys file.
25 .TP
26 .B update-userids [USERID]...
27 Update userid
28 .TP
29 .B gen-ae-subkey KEYID
30 Generate an `ae` capable subkey
31 .TP
32 .B help
33 Output a brief usage summary.  `h' or `?' may be used in place of
34 `help'.
35 .PD
36 .SH KEY ACCEPTABILITY
37 GPG keys are considered acceptable if the following criteria are met:
38 .PD
39 .TP
40 .B capability
41 The key must have both the "authentication" and "encrypt" capability
42 flags.
43 .TP
44 .B validity
45 The key must be "fully" valid, and must not be expired or revoked.
46 .PD
47 .SH FILES
48 .PD 1
49 .TP
50 ~/.config/monkeysphere/monkeysphere.conf
51 User monkeysphere config file.
52 .TP
53 /etc/monkeysphere/monkeysphere.conf
54 System-wide monkeysphere config file.
55 .TP
56 ~/.config/monkeysphere/authorized_user_ids
57 GPG user IDs to validate for addition to the authorized_keys file.
58 .TP
59 ~/.config/monkeysphere/authorized_keys
60 Monkeysphere generated authorized_keys file.
61 .TP
62 ~/.config/monkeysphere/user_keys
63 User keys cache directory.
64 .TP
65 ~/.config/monkeysphere/host_keys
66 Host keys cache directory.
67 .PD
68 .SH AUTHOR
69 Written by Jameson Rollins
70 .SH "REPORTING BUGS"
71 Report bugs to <???@???>.
72 .SH COPYRIGHT
73 Copyright \(co 2008 Jameson Graef Rollins and Daniel Kahn Gillmor
74 .br
75 This is free software.  You may redistribute copies of it under the
76 terms of the GNU General Public License
77 <http://www.gnu.org/licenses/gpl.html>.  There is NO WARRANTY, to the
78 extent permitted by law.
79 .SH "SEE ALSO"
80 .BR ssh (1),
81 .BR gpg (1),
82 .BR monkeysphere-server (8)