Browse Source

[Minor] Reformat Pod documents

tags/1.8.2
Alexander Moisseev 5 years ago
parent
commit
23d3e85dc3
4 changed files with 24 additions and 29 deletions
  1. 3
    3
      .tidyallrc
  2. 4
    7
      utils/cgp_rspamd.pl
  3. 2
    3
      utils/classifier_test.pl
  4. 15
    16
      utils/rspamd_stats.pl

+ 3
- 3
.tidyallrc View File

@@ -17,9 +17,9 @@ select = **/*.{pl,pl.in,pm,pod}
;[PodSpell]
;select = **/*.{pl,pl.in,pm,pod}

;[PodTidy]
;select = **/*.{pl,pl.in,pm,pod}
;argv = --columns=120
[PodTidy]
select = **/*.{pl,pl.in,pm,pod}
columns = 120

[Test::Vars]
select = **/*.{pl,pl.in,pm,t}

+ 4
- 7
utils/cgp_rspamd.pl View File

@@ -324,8 +324,7 @@ Specifies Rspamd host to use for scanning

=item B<--header>

Specifies the header that should be added when Rspamd action is B<add header>
or B<rewrite subject>.
Specifies the header that should be added when Rspamd action is B<add header> or B<rewrite subject>.

=item B<--reject-message>

@@ -351,10 +350,8 @@ Prints the manual page and exits.

=head1 DESCRIPTION

B<cgp_rspamd> is intended to scan messages processed with B<CommunigatePro> MTA
on some Rspamd scanner. It reads standard input and parses CGP helpers
protocol. On scan requests, this filter can query Rspamd to process a message.
B<cgp_rspamd> can tell CGP to add header or reject SPAM messages depending on
Rspamd scan result.
B<cgp_rspamd> is intended to scan messages processed with B<CommunigatePro> MTA on some Rspamd scanner. It reads
standard input and parses CGP helpers protocol. On scan requests, this filter can query Rspamd to process a message.
B<cgp_rspamd> can tell CGP to add header or reject SPAM messages depending on Rspamd scan result.

=cut

+ 2
- 3
utils/classifier_test.pl View File

@@ -533,8 +533,7 @@ Prints the manual page and exits.

=head1 DESCRIPTION

B<classifier_test.pl> is intended to test Rspamd classifier for false positives,
false negatives and other parameters. It uses half of the corpus for training
and half for cross-validation.
B<classifier_test.pl> is intended to test Rspamd classifier for false positives, false negatives and other parameters.
It uses half of the corpus for training and half for cross-validation.

=cut

+ 15
- 16
utils/rspamd_stats.pl View File

@@ -873,13 +873,11 @@ rspamd_stats [options] [--symbol=SYM1 [--symbol=SYM2...]] [--log file]

=item B<--log>

Specifies log file or directory to read data from.
If a directory is specified B<rspamd_stats> analyses files in the directory
including known compressed file types. Number of log files can be limited using
B<--num-logs> and B<--exclude-logs> options. This assumes that files in the log
directory have B<newsyslog(8)>- or B<logrotate(8)>-like name format with numeric
indexes. Files without indexes (generally it is merely one file) are considered
the most recent and files with lower indexes are considered newer.
Specifies log file or directory to read data from. If a directory is specified B<rspamd_stats> analyses files in the
directory including known compressed file types. Number of log files can be limited using B<--num-logs> and
B<--exclude-logs> options. This assumes that files in the log directory have B<newsyslog(8)>- or B<logrotate(8)>-like
name format with numeric indexes. Files without indexes (generally it is merely one file) are considered the most
recent and files with lower indexes are considered newer.

=item B<--reject-score>

@@ -907,7 +905,8 @@ Number of latest logs to exclude (0 by default).

=item B<--correlations>

Additionally print correlation rate for each symbol displayed. This routine calculates merely paired correlations between symbols.
Additionally print correlation rate for each symbol displayed. This routine calculates merely paired correlations
between symbols.

=item B<--search-pattern>

@@ -915,20 +914,19 @@ Do not process input unless finding the specified regular expression. Useful to

=item B<--exclude>

Exclude log lines if certain symbols are fired (e.g. GTUBE). You may specify this option multiple time to skip multiple symbols.
Exclude log lines if certain symbols are fired (e.g. GTUBE). You may specify this option multiple time to skip multiple
symbols.

=item B<--start>

Select log entries after this time. Format: C<YYYY-MM-DD HH:MM:SS> (can be
truncated to any desired accuracy). If used with B<--end> select entries between
B<--start> and B<--end>. The omitted date defaults to the current date if you
Select log entries after this time. Format: C<YYYY-MM-DD HH:MM:SS> (can be truncated to any desired accuracy). If used
with B<--end> select entries between B<--start> and B<--end>. The omitted date defaults to the current date if you
supply the time.

=item B<--end>

Select log entries before this time. Format: C<YYYY-MM-DD HH:MM:SS> (can be
truncated to any desired accuracy). If used with B<--start> select entries between
B<--start> and B<--end>. The omitted date defaults to the current date if you
Select log entries before this time. Format: C<YYYY-MM-DD HH:MM:SS> (can be truncated to any desired accuracy). If used
with B<--start> select entries between B<--start> and B<--end>. The omitted date defaults to the current date if you
supply the time.

=item B<--help>
@@ -984,7 +982,8 @@ B<total ham hits>: overall number of B<HAM> messages

=item 4.

B<ham with symbol percentage>: percentage of number of hits with specified symbol in B<HAM> messages divided by total number of B<HAM> messages.
B<ham with symbol percentage>: percentage of number of hits with specified symbol in B<HAM> messages divided by total
number of B<HAM> messages.

=back


Loading…
Cancel
Save