releasing package fullquottel version 0.1.5-1 into distribution unstable
[debian/fullquottel.git] / fullquottel.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.2.
2 .TH FULLQUOTTEL "1" "March 2021" "fullquottel 0.1.5" "User Commands"
3 .SH NAME
4 fullquottel \- tool for detecting full quotes in mails or postings
5 .SH SYNOPSIS
6 .B fullquottel
7 [\fI\,OPTION\/\fR...] \fI\,< infile > outfile\/\fR
8 .SH DESCRIPTION
9 fullquottel \- tool for detecting full quotes in mails or postings
10 .TP
11 \fB\-t\fR, \fB\-\-scorethreshold\fR=\fI\,NUMBER\/\fR
12 Threshold for final score that discriminates
13 between Goodquottel and Fullquottel (default:
14 1.5)
15 .TP
16 \fB\-\-quotechars\fR=\fI\,CHARS\/\fR
17 Chars used for quoting (default: >|#)
18 .TP
19 \fB\-d\fR, \fB\-\-debug\fR
20 Debug option (prints single test results; default:
21 off)
22 .TP
23 \fB\-\-ownsigtest\fR=\fI\,1\/\fR|0
24 Turn on/off ownSigTest (default: on)
25 .TP
26 \fB\-\-ownsigtestscore\fR=\fI\,NUMBER\/\fR
27 Score for ownSigTest (default: 1.0)
28 .TP
29 \fB\-f\fR, \fB\-\-ownsigtestfile\fR=\fI\,SIGFILE\/\fR
30 Signature file to test against (default:
31 ~/.signature)
32 .TP
33 \fB\-\-mstest\fR=\fI\,1\/\fR|0
34 Turn on/off msTest (Microsoft attribution lines;
35 default: on)
36 .TP
37 \fB\-\-mstestscore\fR=\fI\,NUMBER\/\fR
38 Score for msTest (default: 1.0)
39 .TP
40 \fB\-\-mstestthreshold\fR=\fI\,NUMBER\/\fR
41 Threshold for msTest (at or below which line a
42 Microsoft attribution line ist found; default: 2)
43 .TP
44 \fB\-\-quotedtoalltest\fR=\fI\,1\/\fR|0
45 Turn on/off quotedToAllTest (ratio quoted lines to
46 all; default: on)
47 .TP
48 \fB\-\-quotedtoalltestscore\fR=\fI\,NUMBER\/\fR
49 Score for quotedToAllTest (default: 1.0)
50 .TP
51 \fB\-\-quotedtoalltestfactor\fR=\fI\,NUMBER\/\fR
52 Result = score + ratio * FACTOR (default: 0)
53 .TP
54 \fB\-\-quotedtoalltestthreshold\fR=\fI\,NUMBER\/\fR
55 Ratio threshold for activating quotedToAllTest
56 (default: 0.5)
57 .TP
58 \fB\-\-bottomquotedtoalltest\fR=\fI\,1\/\fR|0
59 Turn on/off bottomQuotedToAllTest (ratio quoted
60 lines at bottom to all; default: on)
61 .TP
62 \fB\-\-bottomquotedtoalltestscore\fR=\fI\,NUMBER\/\fR
63 Score for bottomQuotedToAllTest (default: 1.0)
64 .TP
65 \fB\-\-bottomquotedtoalltestfactor\fR=\fI\,NUMBER\/\fR
66 Result = score + ratio * FACTOR (default: 0)
67 .TP
68 \fB\-\-bottomquotedtoalltestthreshold\fR=\fI\,NUMBER\/\fR
69 Ratio threshold for activating
70 bottomQuotedToAllTest (default: 0.5)
71 .TP
72 \fB\-\-bottomquotedtoquotedtest\fR=\fI\,1\/\fR|0
73 Turn on/off bottomQuotedToQuotedTest (ratio quoted
74 lines at bottom to all quoted lines; default: on)
75 .TP
76 \fB\-\-bottomquotedtoquotedtestscore\fR=\fI\,NUMBER\/\fR
77 Score for bottomQuotedToQuotedTest (default: 1.0)
78 .TP
79 \fB\-\-bottomquotedtoquotedtestfactor\fR=\fI\,NUMBER\/\fR
80 Result = score + ratio * FACTOR (default: 0)
81 .TP
82 \fB\-\-bottomquotedtoquotedtestthreshold\fR=\fI\,NUMBER\/\fR
83 Ratio threshold for activating
84 bottomQuotedToQuotedTest (default: 0.5)
85 .TP
86 \fB\-\-singlebottomquotetest\fR=\fI\,1\/\fR|0
87 Turn on/off singleBottomQuoteTest (only one quote
88 block, and at the bottom; default: on)
89 .TP
90 \fB\-\-singlebottomquotetestscore\fR=\fI\,NUMBER\/\fR
91 Score for singleBottomQuoteTest (default: 1.0)
92 .PP
93 HINT: All long options (without leading \fB\-\-\fR) can be used in ~/.fullquottelrc
94 .TP
95 \-?, \fB\-\-help\fR
96 Give this help list
97 .TP
98 \fB\-\-usage\fR
99 Give a short usage message
100 .TP
101 \fB\-V\fR, \fB\-\-version\fR
102 Print program version
103 .PP
104 Mandatory or optional arguments to long options are also mandatory or optional
105 for any corresponding short options.
106 .SH "REPORTING BUGS"
107 Report bugs to <toast@toastfreeware.priv.at>.