From: Jonathan McDowell Date: Mon, 2 Aug 2004 22:06:59 +0000 (+0000) Subject: Add man pages for onak/splitkeys. X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/commitdiff_plain/3eae5368f1c625257a93a18bec49a5a500b3f78e Add man pages for onak/splitkeys. Add man pages for onak and splitkeys (thanks to lintian for prodding me into doing this). --- diff --git a/debian/onak.install b/debian/onak.install index aaef8e8..ce81ad5 100644 --- a/debian/onak.install +++ b/debian/onak.install @@ -2,3 +2,4 @@ onak.conf etc onak splitkeys usr/bin onak-mail.pl usr/lib/onak add lookup gpgwww usr/lib/cgi-bin/pks +onak.1 splitkeys.1 usr/share/man/man1 diff --git a/onak.1 b/onak.1 new file mode 100644 index 0000000..bc748dd --- /dev/null +++ b/onak.1 @@ -0,0 +1,79 @@ +.TH ONAK 1 +.SH NAME +onak \- an OpenPGP compatible keyserver +.SH SYNOPSIS +.PP +.B onak +[ +.B options +] +.I command +[ +.I parameters +] +.SH DESCRIPTION +.PP +Perform various keyserver actions. +.SS "Options" +.TP +\fB\-b\fR +Treat keys on stdin as binary rather than ASCII armoured. +.TP +\fB\-c \fIFILE\fR\fR +Use \fIFILE\fR as the config file instead of the default. +.TP +\fB\-f\fR +Display fingerprints when listing keys. +.TP +\fB\-u\fR +Update keys - output changes on stdout. +.TP +\fB\-v\fR +Verbose; increase loglevel. +.SS "Commands" +.TP +.B add +Read OpenPGP keys from stdin and add them to the keyserver database. +.TP +.B clean +Read OpenPGP keys from stdin, run the key cleaning routines against them and +dump to stdout. +.TP +.B delete +Delete a given key from the keyserver. +.TP +.B dump +Dump all the keys from the keyserver. +.TP +.B get +Retrieves the requested key from the keyserver. +.TP +.B getphoto +Retrieves the first photoid on the requested key and dumps to stdout. +.TP +.B index +Search for a key and list it. +.TP +.B vindex +Search for a key and list it and its signatures. +.SH EXAMPLES +.TP +.B onak index noodles +List all keys in the keyserver that contain the word \fInoodles\fR. +.TP +.B onak clean < dirty.key > clean.key +Clean up one or more PGP keys. Currently this will just dedupe UIDs. +.TP +.B gpg --export | onak -b add +Export all keys on your gnupg keyring and import them into the keyserver. +.SH FILES +.br +.nf +.\" set tabstop to longest possible filename, plus a wee bit +.ta \w'/usr/lib/perl/getopts.pl 'u +\fI/etc/onak.conf\fR default configuration file +.SH NOTES +This man page could probably do with some more details. +.SH AUTHOR +onak was written by Jonathan McDowell . It can be found at +http://www.earth.li/projectpurple/progs/onak.html diff --git a/splitkeys.1 b/splitkeys.1 new file mode 100644 index 0000000..f0c1b28 --- /dev/null +++ b/splitkeys.1 @@ -0,0 +1,24 @@ +.TH SPLITKEYS 1 +.SH NAME +splitkeys \- split an OpenPGP keyring +.SH SYNOPSIS +.PP +.B splitkeys +[ +.B maxkeys +] +.SH DESCRIPTION +.PP +Splits an OpenPGP keyring into a bunch of keyrings of the format +splitfile-%d.pgp, all of which contain no more than \fImaxkeys\fR keys +(or 10000 if not specified). +.SH EXAMPLES +.TP +.B splitkeys 1000 < keyring.gpg +Split keyring.gpg into a collection of keyrings all containing 1000 keys at +most. +.SH AUTHOR +splitkeys was written by Jonathan McDowell . It can be +found as part of onak at http://www.earth.li/projectpurple/progs/onak.html +.SH "SEE ALSO" +.BR onak (1)