.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "PINGD 1" .TH PINGD 1 "2014-10-23" "2.1.9" "Echolot" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" pingd \- echolot ping daemon .SH "SYNOPSIS" .IX Header "SYNOPSIS" .IP "\fBpingd\fR \fBstart\fR" 4 .IX Item "pingd start" .PD 0 .IP "\fBpingd\fR \fBstop\fR" 4 .IX Item "pingd stop" .IP "\fBpingd\fR \fBprocess\fR" 4 .IX Item "pingd process" .IP "\fBpingd\fR \fBadd\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "pingd add address [address ...]" .IP "\fBpingd\fR \fBdelete\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "pingd delete address [address ...]" .IP "\fBpingd\fR \fBdisable\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "pingd disable address [address ...]" .IP "\fBpingd\fR \fBenable\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "pingd enable address [address ...]" .IP "\fBpingd\fR \fBset\fR option=value [option=value..] \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "pingd set option=value [option=value..] address [address ...]" .IP "\fBpingd\fR \fBsetremailercaps\fR \fIcapsstring\fR" 4 .IX Item "pingd setremailercaps capsstring" .IP "\fBpingd\fR \fBdeleteremailercaps\fR \fIaddress\fR" 4 .IX Item "pingd deleteremailercaps address" .IP "\fBpingd\fR \fBgetkeyconf\fR [\fIaddress\fR [\fIaddress\fR ...]]" 4 .IX Item "pingd getkeyconf [address [address ...]]" .IP "\fBpingd\fR \fBsendpings\fR [\fIaddress\fR [\fIaddress\fR ...]]" 4 .IX Item "pingd sendpings [address [address ...]]" .IP "\fBpingd\fR \fBsendchainpings\fR \fIaddress\fR\fB:\fR\fIaddress\fR [\fIaddress\fR\fB:\fR\fIaddress\fR ...]" 4 .IX Item "pingd sendchainpings address:address [address:address ...]" .IP "\fBpingd\fR \fBbuildstats\fR" 4 .IX Item "pingd buildstats" .IP "\fBpingd\fR \fBbuildkeys\fR" 4 .IX Item "pingd buildkeys" .IP "\fBpingd\fR \fBbuildthesaurus\fR" 4 .IX Item "pingd buildthesaurus" .IP "\fBpingd\fR \fBbuildfromlines\fR" 4 .IX Item "pingd buildfromlines" .IP "\fBpingd\fR \fBsummary\fR" 4 .IX Item "pingd summary" .IP "\fBpingd\fR \fBdumpconf\fR" 4 .IX Item "pingd dumpconf" .PD .SH "DESCRIPTION" .IX Header "DESCRIPTION" pingd is the heart of echolot. Echolot is a pinger for anonymous remailers. .PP A Pinger in the context of anonymous remailers is a program that regularily sends messages through remailers to check their reliability. It then calculates reliability statistics which are used by remailer clients to choose the chain of remailers to use. .PP Additionally it collects configuration parameters and keys of all remailers and offers them in a format readable by remailer clients. .PP When called without parameters pingd schedules tasks like sending pings, processing incoming mail and requesting remailer-xxx data and runs them at configurable intervalls. .SH "COMMANDS" .IX Header "COMMANDS" .IP "\fBstart\fR" 4 .IX Item "start" Start the ping daemon. .IP "\fBstop\fR" 4 .IX Item "stop" Send the running pingd process a \s-1SIGTERM.\s0 .IP "\fBprocess\fR" 4 .IX Item "process" Sends a \s-1HUP\s0 signal to the daemon which instructs it to process the commands. .Sp For other effects of sending the \s-1HUP\s0 Signal see the \s-1SIGNALS\s0 section below. .IP "\fBadd\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "add address [address ...]" Add \fIaddress\fR to the list of remailers to query for keys and confs. .IP "\fBdelete\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "delete address [address ...]" Delete \fIaddress\fR from the list of remailers to query for keys and confs. Delete all statistics and keys for that remailer. .Sp Note that echolot will add back this remailer if it learns of it from other remailers again. If you do not want that, use the disable command. .IP "\fBdisable\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "disable address [address ...]" Shorthand for \fBset showit=off\fR \fBpingit=off\fR \fBfetch=off\fR. This makes echolot completely ignore that remailer, until you enable it again. .IP "\fBenable\fR \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "enable address [address ...]" Shorthand for \fBset showit=on\fR \fBpingit=on\fR \fBfetch=on\fR. .IP "\fBset\fR option=value [option=value..] \fIaddress\fR [\fIaddress\fR ...]" 4 .IX Item "set option=value [option=value..] address [address ...]" Possible options and values: .RS 4 .IP "\fBshowit=\fR{\fBon\fR,\fBoff\fR}" 4 .IX Item "showit={on,off}" Set \fBshowit\fR (show remailer in mlist, rlist etc.) for remailer \fIaddress\fR to either \fBon\fR or \fBoff\fR. .IP "\fBpingit=\fR{\fBon\fR,\fBoff\fR}" 4 .IX Item "pingit={on,off}" Set \fBpingit\fR (send out pings to that remailer) for remailer \fIaddress\fR to either \fBon\fR or \fBoff\fR. .IP "\fBfetch=\fR{\fBon\fR,\fBoff\fR}" 4 .IX Item "fetch={on,off}" Set \fBfetch\fR (fetch remailer-key and remailer-conf) for remailer \fIaddress\fR to either \fBon\fR or \fBoff\fR. .RE .RS 4 .RE .IP "\fBsetremailercaps\fR \fIcapsstring\fR" 4 .IX Item "setremailercaps capsstring" Some remailers (Mixmaster V2 \- currently lcs and passthru2) don't return a useable remailer-conf message. For such remailers you need to set it manually. .Sp For instance: .Sp .Vb 2 \& ./pingd setremailercaps \*(Aq$remailer{"passthru2"} = " mix middle";\*(Aq \& ./pingd setremailercaps \*(Aq$remailer{"lcs"} = " mix klen1000";\*(Aq .Ve .IP "\fBdeleteremailercaps\fR \fIaddress\fR" 4 .IX Item "deleteremailercaps address" Delete remailer-conf data for \fIaddress\fR. The config data will be reset from the next valid remailer-conf reply by the remailer. .IP "\fBgetkeyconf\fR [\fIaddress\fR [\fIaddress\fR ...]]" 4 .IX Item "getkeyconf [address [address ...]]" Send a command to immediatly request keys and configuration from remailers. If no addresses are given requests will be sent to all remailers. .IP "\fBsendpings\fR [\fIaddress\fR [\fIaddress\fR ...]]" 4 .IX Item "sendpings [address [address ...]]" Send a command to immediatly send pings to the given remailers. If no addresses are given requests will be sent to all remailers. .IP "\fBsendchainpings\fR \fIaddress\fR\fB:\fR\fIaddress\fR [\fIaddress\fR\fB:\fR\fIaddress\fR ...]" 4 .IX Item "sendchainpings address:address [address:address ...]" Send a command to immediatly send chain pings to the given chains. A chain is two remailer addresses seperated by a colon. .IP "\fBbuildstats\fR" 4 .IX Item "buildstats" Send a command to immediatly rebuild stats. .IP "\fBbuildkeys\fR" 4 .IX Item "buildkeys" Send a command to immediatly rebuild the keyrings. .IP "\fBbuildthesaurus\fR" 4 .IX Item "buildthesaurus" Send a command to immediatly rebuild the Thesaurus. .IP "\fBbuildfromlines\fR" 4 .IX Item "buildfromlines" Send a command to immediatly rebuild the From Header lines page. .IP "\fBsummary\fR" 4 .IX Item "summary" Print a status summary of all known addresses to the log (level notice). .IP "\fBdumpconf\fR" 4 .IX Item "dumpconf" Dumps the current configuration to standard output. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-basedir\fR" 4 .IX Item "--basedir" The home directory to which everything else is relative. See the \s-1BASE DIRECTORY\s0 section below. .IP "\fB\-\-verbose\fR" 4 .IX Item "--verbose" Verbose mode. Causes \fBpingd\fR to print debugging messages about its progress. .IP "\fB\-\-quiet\fR" 4 .IX Item "--quiet" Quiet mode. Be even quieter than normal. .IP "\fB\-\-help\fR" 4 .IX Item "--help" Print a short help message and exit sucessfully. .IP "\fB\-\-version\fR" 4 .IX Item "--version" Print version number and exit sucessfully. .IP "\fB\-\-nohup\fR" 4 .IX Item "--nohup" Usefull only with the \fBadd\fR, \fBset\fR, \fBsetremailercaps\fR, \&\fBdeleteremailercaps\fR, \fBgetkeyconf\fR, \fBsendpings\fR, \fBsendchainpings\fR, \&\fBbuildstats\fR, \fBbuildkeys\fR, \fBbuildthesaurus\fR, \fBbuildfromlines\fR, or \fBsummary\fR command. .Sp Don't send a \s-1HUP\s0 signal to the daemon which instructs it to process the commands after adding the command to the task list. .Sp By default such a signal is sent. .IP "\fB\-\-process\fR" 4 .IX Item "--process" Usefull only with the \fBstart\fR command. .Sp Read and process the commands file on startup. .IP "\fB\-\-detach\fR" 4 .IX Item "--detach" Usefull only with the \fBstart\fR command. .Sp Tell \fBpingd\fR to detach. .SH "BASE DIRECTORY" .IX Header "BASE DIRECTORY" The home directory to which everything else is relative. .PP Basedir defaults to whatever directory the \fBpingd\fR binary is located. It can be overridden by the \fB\s-1ECHOLOT_HOME\s0\fR environment variable which in turn is weaker than the \fB\-\-basedir\fR setting. .PP This directory is then used to locate the configuration file \fBpingd.conf\fR (see \&\s-1FILES\s0 below). .PP The \fBhomedir\fR setting in \fBpingd.conf\fR finally sets the base directory. .SH "FILES" .IX Header "FILES" The configuration file is searched in these places in this order: .IP "the file pointed to by the \fB\s-1ECHOLOT_CONF\s0\fR environment variable" 4 .IX Item "the file pointed to by the ECHOLOT_CONF environment variable" .PD 0 .IP "/pingd.conf" 4 .IX Item "/pingd.conf" .ie n .IP "$HOME/echolot/pingd.conf" 4 .el .IP "\f(CW$HOME\fR/echolot/pingd.conf" 4 .IX Item "$HOME/echolot/pingd.conf" .ie n .IP "$HOME/pingd.conf" 4 .el .IP "\f(CW$HOME\fR/pingd.conf" 4 .IX Item "$HOME/pingd.conf" .ie n .IP "$HOME/.pingd.conf" 4 .el .IP "\f(CW$HOME\fR/.pingd.conf" 4 .IX Item "$HOME/.pingd.conf" .IP "/etc/echolot/pingd.conf" 4 .IX Item "/etc/echolot/pingd.conf" .IP "/etc/pingd.conf" 4 .IX Item "/etc/pingd.conf" .PD .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\s-1ECHOLOT_CONF\s0 echolot config file (see section \s-1FILES\s0)" 4 .IX Item "ECHOLOT_CONF echolot config file (see section FILES)" .PD 0 .IP "\s-1ECHOLOT_HOME\s0 echolot base directory (see section \s-1BASE DIRECTORY\s0)" 4 .IX Item "ECHOLOT_HOME echolot base directory (see section BASE DIRECTORY)" .PD .SH "SIGNALS" .IX Header "SIGNALS" On \fB\s-1SIGINT\s0\fR, \fB\s-1SIGQUIT\s0\fR, and \fB\s-1SIGTERM\s0\fR \fBpingd\fR will schedule a shutdown for as soon as the current actions are finished or immediatly if no actions are currently being processed. It will then write all metadata and pingdata to disk and close all files cleanly before exiting. .PP On \fB\s-1SIGHUP\s0\fR will execute any pending commands from the commands file (\fBcommands.txt\fR by default). It also closes and reopens the file 'output' which is used for stdout and stderr when the daemon is running detached. This can be used if you want to rotate that file. .SH "AUTHOR" .IX Header "AUTHOR" Peter Palfrader .SH "BUGS" .IX Header "BUGS" Please report them at