]> git.sommitrealweird.co.uk Git - onak.git/blob - onak.1
Add Depends on adduser for Debian
[onak.git] / onak.1
1 .TH ONAK 1
2 .SH NAME
3 onak \- an OpenPGP compatible keyserver
4 .SH SYNOPSIS
5 .PP
6 .B onak
7 [
8 .B options
9 ]
10 .I command
11 [
12 .I parameters
13 ]
14 .SH DESCRIPTION
15 .PP
16 Perform various keyserver actions.
17 .SS "Options"
18 .TP
19 \fB\-b\fR
20 Treat keys on stdin as binary rather than ASCII armoured.
21 .TP
22 \fB\-c \fIFILE\fR\fR
23 Use \fIFILE\fR as the config file instead of the default.
24 .TP
25 \fB\-f\fR
26 Display fingerprints when listing keys.
27 .TP
28 \fB\-u\fR
29 Update keys - output changes on stdout.
30 .TP
31 \fB\-v\fR
32 Verbose; increase loglevel.
33 .SS "Commands"
34 .TP
35 .B add
36 Read OpenPGP keys from stdin and add them to the keyserver database.
37 .TP
38 .B clean
39 Read OpenPGP keys from stdin, run the key cleaning routines against them and
40 dump to stdout.
41 .TP
42 .B delete
43 Delete a given key from the keyserver.
44 .TP
45 .B dump
46 Dump all the keys from the keyserver.
47 .TP
48 .B get
49 Retrieves the requested key from the keyserver.
50 .TP
51 .B getphoto
52 Retrieves the first photoid on the requested key and dumps to stdout.
53 .TP
54 .B index
55 Search for a key and list it.
56 .TP
57 .B vindex
58 Search for a key and list it and its signatures.
59 .SH EXAMPLES
60 .TP
61 .B onak index noodles
62 List all keys in the keyserver that contain the word \fInoodles\fR.
63 .TP
64 .B onak clean < dirty.key > clean.key
65 Clean up one or more PGP keys. Currently this will just dedupe UIDs.
66 .TP
67 .B gpg --export | onak -b add
68 Export all keys on your gnupg keyring and import them into the keyserver.
69 .SH FILES
70 .br
71 .nf
72 .\" set tabstop to longest possible filename, plus a wee bit
73 .ta \w'/usr/lib/perl/getopts.pl   'u
74 \fI/etc/onak.conf\fR    default configuration file
75 .SH NOTES
76 This man page could probably do with some more details.
77 .SH AUTHOR
78 onak was written by Jonathan McDowell <noodles@earth.li>. It can be found at
79 http://www.earth.li/projectpurple/progs/onak.html