Merge commit 'jrollins/master'
[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 no 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
22 `k' may be used in place of `update-known_hosts'.
23 .TP
24 .B update-authorized_keys
25 Update the authorized_keys file.
26 .TP
27 .B update-userids [USERID]...
28 Update userid
29 .TP
30 .B gen-ae-subkey KEYID
31 Generate an `ae` capable subkey
32 .TP
33 .B help
34 Output a brief usage summary.  `h' or `?' may be used in place of
35 `help'.
36 .PD
37 .SH KEY ACCEPTABILITY
38 GPG keys are considered acceptable if the following criteria are met:
39 .PD
40 .TP
41 .B capability
42 The key must have both the "authentication" and "encrypt" capability
43 flags.
44 .TP
45 .B validity
46 The key must be "fully" valid, and must not be expired or revoked.
47 .PD
48 .SH FILES
49 .PD 1
50 .TP
51 ~/.config/monkeysphere/monkeysphere.conf
52 User monkeysphere config file.
53 .TP
54 /etc/monkeysphere/monkeysphere.conf
55 System-wide monkeysphere config file.
56 .TP
57 ~/.config/monkeysphere/authorized_user_ids
58 GPG user IDs to validate for addition to the authorized_keys file.
59 .TP
60 ~/.config/monkeysphere/authorized_keys
61 Monkeysphere generated authorized_keys file.
62 .TP
63 ~/.config/monkeysphere/user_keys
64 User keys cache directory.
65 .TP
66 ~/.config/monkeysphere/host_keys
67 Host keys cache directory.
68 .PD
69 .SH AUTHOR
70 Written by Jameson Rollins
71 .SH "REPORTING BUGS"
72 Report bugs to <???@???>.
73 .SH COPYRIGHT
74 Copyright \(co 2008 Jameson Graef Rollins and Daniel Kahn Gillmor
75 .br
76 This is free software.  You may redistribute copies of it under the
77 terms of the GNU General Public License
78 <http://www.gnu.org/licenses/gpl.html>.  There is NO WARRANTY, to the
79 extent permitted by law.
80 .SH "SEE ALSO"
81 .BR ssh (1),
82 .BR gpg (1),
83 .BR monkeysphere-server (8)