diff options
author | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2011-03-15 16:32:58 +0300 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2011-03-15 16:32:58 +0300 |
commit | e7ec4dc4dcc484973957c69d15ca8f7aa41aa73e (patch) | |
tree | 0e44f307e79f537a14b2cc0c6710790c4be788e3 /doc | |
parent | 66f91e9ce180f82f11f3256dbd05127fe27de893 (diff) | |
download | rspamd-e7ec4dc4dcc484973957c69d15ca8f7aa41aa73e.tar.gz rspamd-e7ec4dc4dcc484973957c69d15ca8f7aa41aa73e.zip |
Add support of uptime command to rspamc.0.3.8
Update manpages.
Add script for generating manpages from pod.
Diffstat (limited to 'doc')
-rwxr-xr-x | doc/makeman.sh | 17 | ||||
-rw-r--r-- | doc/rspamc.1 | 20 | ||||
-rw-r--r-- | doc/rspamc.pod | 19 | ||||
-rw-r--r-- | doc/rspamd.8 | 2 |
4 files changed, 49 insertions, 9 deletions
diff --git a/doc/makeman.sh b/doc/makeman.sh new file mode 100755 index 000000000..176f37b25 --- /dev/null +++ b/doc/makeman.sh @@ -0,0 +1,17 @@ +#!/bin/sh +# Makes manual pages from pods + +POD2MAN="pod2man" +VERSION="unknown" +CMAKEFILE="../CMakeLists.txt" + +# Extract release version +if [ -f ${CMAKEFILE} ] ; then + _mjver=`fgrep 'SET(RSPAMD_VERSION_MAJOR' ${CMAKEFILE} | sed -e 's/^.*RSPAMD_VERSION_MAJOR \([0-9]\).*/\1/'` + _miver=`fgrep 'SET(RSPAMD_VERSION_MINOR' ${CMAKEFILE} | sed -e 's/^.*RSPAMD_VERSION_MINOR \([0-9]\).*/\1/'` + _pver=`fgrep 'SET(RSPAMD_VERSION_PATCH' ${CMAKEFILE} | sed -e 's/^.*RSPAMD_VERSION_PATCH \([0-9]\).*/\1/'` + VERSION="${_mjver}.${_miver}.${_pver}" +fi + +pod2man -c "Rspamd documentation" -n rspamd -s 8 -r "rspamd-${VERSION}" < rspamd.pod > rspamd.8 +pod2man -c "Rspamd documentation" -n rspamc -s 1 -r "rspamd-${VERSION}" < rspamc.pod > rspamc.1 diff --git a/doc/rspamc.1 b/doc/rspamc.1 index f4e5cf2ef..549899c91 100644 --- a/doc/rspamc.1 +++ b/doc/rspamc.1 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "rspamc 1" -.TH rspamc 1 "2011-02-25" "rspamd-0.3.7_1" "Rspamd documentation" +.TH rspamc 1 "2011-03-15" "rspamd-0.3.8" "Rspamd documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -134,9 +134,9 @@ rspamc \- a simple client for rspamd spam filtering system .SH "SYNOPSIS" .IX Header "SYNOPSIS" -rspamc [\fB\-h\fR \fIhost[:port]\fR] [\fB\-p\fR] +rspamc [\fB\-h\fR \fIhost[:port]\fR] [\fB\-p\fR] [\fB\-v\fR] [\fB\-i\fR \fIip\fR] [\fB\-s\fR \fIstatfile\fR] [\fB\-w\fR \fIweight\fR] -[\fB\-P\fR \fIpassword\fR] [\fB\-f\fR \fIflag\fR] [command] [file [file ...]] +[\fB\-P\fR \fIpassword\fR] [\fB\-f\fR \fIflag\fR] [\fB\-t\fR \fItimeout\fR] [command] [file [file ...]] .PP rspamc [\fB\-\-help\fR] .SH "DESCRIPTION" @@ -152,6 +152,9 @@ default port is \fI11333\fR for checking messages and \fI11334\fR for learning a .IP "\fB\-p\fR, \fB\-\-pass\-all\fR" 4 .IX Item "-p, --pass-all" Pass all filters when checking messages. Ignored in case of learning. +.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 +.IX Item "-v, --verbose" +Be more verbose while displaying results. For example show descriptions of symbols. .IP "\fB\-P\fR \fIpassword\fR, \fB\-\-password\fR \fIpassword\fR" 4 .IX Item "-P password, --password password" Specify controller's password. Mandatory option for learning. @@ -167,7 +170,10 @@ specific \s-1IP\s0 address. Weight of message for fuzzy operations. .IP "\fB\-f\fR \fIflag\fR, \fB\-\-flag\fR \fIflag\fR" 4 .IX Item "-f flag, --flag flag" -Weight of message for fuzzy operations. +Flag of list for fuzzy operations. +.IP "\fB\-t\fR \fItimeout\fR, \fB\-\-timeout\fR \fItimeout\fR" 4 +.IX Item "-t timeout, --timeout timeout" +Timeout in seconds for all operations. Default value is 5 seconds. .SH "RETURN VALUE" .IX Header "RETURN VALUE" On exit \fBrspamc\fR returns 0 if operation was successfull and error code otherwise. @@ -208,6 +214,12 @@ Get statistics: .Vb 1 \& rspamc stat .Ve +.PP +Get uptime: +.PP +.Vb 1 +\& rspamc uptime +.Ve .SH "AUTHOR" .IX Header "AUTHOR" Vsevolod Stakhov <vsevolod@highsecure.ru> diff --git a/doc/rspamc.pod b/doc/rspamc.pod index 14de89b92..ebb452b4d 100644 --- a/doc/rspamc.pod +++ b/doc/rspamc.pod @@ -4,9 +4,9 @@ rspamc - a simple client for rspamd spam filtering system =head1 SYNOPSIS -rspamc [B<-h> I<host[:port]>] [B<-p>] +rspamc [B<-h> I<host[:port]>] [B<-p>] [B<-v>] [B<-i> I<ip>] [B<-s> I<statfile>] [B<-w> I<weight>] -[B<-P> I<password>] [B<-f> I<flag>] [command] [file [file ...]] +[B<-P> I<password>] [B<-f> I<flag>] [B<-t> I<timeout>] [command] [file [file ...]] rspamc [B<--help>] @@ -28,6 +28,10 @@ default port is I<11333> for checking messages and I<11334> for learning and sta Pass all filters when checking messages. Ignored in case of learning. +=item B<-v>, B<--verbose> + +Be more verbose while displaying results. For example show descriptions of symbols. + =item B<-P> I<password>, B<--password> I<password> Specify controller's password. Mandatory option for learning. @@ -47,8 +51,11 @@ Weight of message for fuzzy operations. =item B<-f> I<flag>, B<--flag> I<flag> -Weight of message for fuzzy operations. +Flag of list for fuzzy operations. +=item B<-t> I<timeout>, B<--timeout> I<timeout> + +Timeout in seconds for all operations. Default value is 5 seconds. =back @@ -82,6 +89,10 @@ Get statistics: rspamc stat +Get uptime: + + rspamc uptime + =head1 AUTHOR Vsevolod Stakhov <vsevolod@highsecure.ru> @@ -93,4 +104,4 @@ Copyright 2011 by Vsevolod Stakhov <vsevolod@highsecure.ru>. This program is free software; you may redistribute it and/or modify it under the terms of BSD license. -=cut
\ No newline at end of file +=cut diff --git a/doc/rspamd.8 b/doc/rspamd.8 index 6e7e6e6f7..ea8e0b2b5 100644 --- a/doc/rspamd.8 +++ b/doc/rspamd.8 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "rspamd 8" -.TH rspamd 8 "2011-02-25" "rspamd-0.3.7_1" "Rspamd documentation" +.TH rspamd 8 "2011-03-15" "rspamd-0.3.8" "Rspamd documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l |