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 dumpconfig
  43 Dump the running config in new .ini format to stdout, or the provided file.
  44 Intended to help with migration from old style configuration files - onak can
  45 read and parse the old style file and this command will output the equivalent
  46 new style configuration.
  47 .TP
  48 .B delete
  49 Delete a given key from the keyserver.
  50 .TP
  51 .B dump
  52 Dump all the keys from the keyserver.
  53 .TP
  54 .B get
  55 Retrieves the requested key from the keyserver.
  56 .TP
  57 .B getphoto
  58 Retrieves the first photoid on the requested key and dumps to stdout.
  59 .TP
  60 .B index
  61 Search for a key and list it.
  62 .TP
  63 .B vindex
  64 Search for a key and list it and its signatures.
  65 .SH EXAMPLES
  66 .TP
  67 .B onak index noodles
  68 List all keys in the keyserver that contain the word \fInoodles\fR.
  69 .TP
  70 .B onak clean < dirty.key > clean.key
  71 Clean up one or more PGP keys. Currently this will just dedupe UIDs.
  72 .TP
  73 .B gpg --export | onak -b add
  74 Export all keys on your gnupg keyring and import them into the keyserver.
  75 .SH FILES
  76 .br
  77 .nf
  78 .\" set tabstop to longest possible filename, plus a wee bit
  79 .ta \w'/usr/lib/perl/getopts.pl   'u
  80 \fI/etc/onak.ini\fR     default configuration file
  81 .SH NOTES
  82 This man page could probably do with some more details.
  83 .SH AUTHOR
  84 onak was written by Jonathan McDowell <noodles@earth.li>. It can be found at
  85 http://www.earth.li/projectpurple/progs/onak.html