diff --git a/tlf.1.in b/tlf.1.in index fe0a5b92..181bced7 100644 --- a/tlf.1.in +++ b/tlf.1.in @@ -35,7 +35,7 @@ . . .\" Update the date when this page is committed. -.TH TLF 1 "@PACKAGE_NAME@ @VERSION@, 2025-01-23" TLF "Ham radio" +.TH TLF 1 "@PACKAGE_NAME@ @VERSION@, 2026-08-10" TLF "Ham radio" . . .SH NAME @@ -2783,7 +2783,65 @@ Auto Exchange call digi message in S&P mode (TR-Log mode) . .SS Scoring . -The following parameters configure @PACKAGE_NAME@'s scoring calculations. +The following parameters configure @PACKAGE_NAME@'s scoring calculations for +points and multipliers. +. +.P +.B Points +.P +Not all parameters can be combined arbitrarily. +To use them correctly one should be aware of the +evaluation order, in order of precedence, discussed below. +. +.P +\(bu Any contact which is evaluated as \fIdupe\fR gets zero points. +. +.P +\(bu If a python plugin module is used for the contest (see +\fBPYTHON PLUGIN\fR) with a defined \fI score() \fR function it will take +absolute preference. The value returned by the function will be used as +point value. All other point related parameters are ignored. +. +.P +\(bu Otherwise if you are running one of the predefined contests (see output +from the \fI tlf -l \fR command) the points are hardcoded into @PACKAGE_NAME@ +and cannot be modified by any of the parameters below. +. +.P +\(bu Using one of \fBONE|TWO|THREE_POINT\fR parameters gives exactly that +point value for any contact without further modification. +. +.P +\(bu If \fBSSBPOINTS\fR and \fBCWPOINTS\fR both are set to a non null value +they will come to action for any contact. The points given depend on the mode +used. Further modifications according to band used (see \fBLOWBAND_DOUBLE\fR +and \fBBANDWEIGHT_POINTS\fR - can be used both) will be applied. Finally +contacts with portable stations can be honored (see \fBPORTABLE_MULT_2\fR). +. +.P +\(bu Finally the default scoring is performed by evaluating the country prefix +of the other station. It is controlled by the following parameters, in order +of precedence: +. +.RS +\(bu MY_COUNTRY_POINTS +.RE +.RS +\(bu COUNTRY_LIST_POINTS +.RE +.RS +\(bu MY_CONTINENT_POINTS +.RE +.RS +\(bu CONTINENT_LIST_POINTS +.RE +.RS +\(bu DX_POINTS +.RE +. +Keywords not set will be ignored. +Working band and contacts to portable stations may be honored as discussed +in the paragraph above. . .TP .B ONE_POINT @@ -2822,27 +2880,16 @@ Points for working countries in your own continent. Points for working a station in other continents. . .TP -.B 2EU3DX_POINTS -Deprecated. -. -.IP -Use -.B MY_CONTINENT_POINTS -and -.B DX_POINTS -instead. -. -.TP \fBCOUNTRY_LIST_POINTS\fR=\fId\fR -Points for countries in country list. +Points for countries in COUNTRYLIST. . .TP -\fUSE_COUNTRYLIST_ONLY\fR -Deprecated. Please do not use any longer. +\fBCONTINENT_LIST_POINTS\fR=\fId\fR +Points for stations from continents in CONTINENTLIST . .TP \fBCOUNTRYLIST\fR=\fI"comma separated list of prefixes"\fR -e.g. SM,LA,OZ,OH. +E.g. SM,LA,OZ,OH . .TP \fBCOUNTRYLIST\fR=\fIfile_name\fR @@ -2855,6 +2902,24 @@ E.g. Scandinavia:SM,LA,OZ,OH. Not to be confused with so-called "country" files maintained by AD1C. . .TP +\fBCONTINENTLIST\fR=\fI"comma separated list of continents"\fR +Valid values are: SA, NA, EU, AF, AS and OC. +. +.IP +.BR Note : +.B COUNTRYLIST +and +.B CONTINENTLIST +can be used for point scoring (see above) +or to exclude some multipliers (see +.B EXCLUDE_MULTILIST +below). +. +.TP +\fBUSE_COUNTRYLIST_ONLY\fR +Deprecated, has no effect. Please do not use any longer. +. +.TP \fBPORTABLE_MULT_2\fR[=<\fION\fR|\fIOFF\fR>] Multiply points x2 for portable stations (e.g. R1 field day). . @@ -2867,6 +2932,23 @@ any other value). (Will be deprecated in future! Use BANDWEIGHT_POINTS instead.) . .TP +.B BANDWEIGHT_POINTS +Define a point weighting factor for different bands. +. +.IP +For example, setting: +. +.IP + \fBBANDWEIGHT_POINTS\fR=\fI160:3,80:2,40:1,20:1,15:1,10:2\fR +. +.IP +for use in the All Asia DX (AADX) contest will multiply all QSO points by 3 on +160m, by 2 on 80m and 10m and on all other bands only by 1. +. +.IP +Bands not in the list are weighted by 1. +. +.TP \fBPOWERMULT\fR=\fIpower_multiplier\fR Use this value to multiply the final points. @@ -2884,6 +2966,11 @@ rounded by the C library function, which gives the largest integer value that is not greater than multiplied score. . +.P +.B Multipliers +.P +Evaluation of multipliers gets controlled by the following parameters. +. .TP \fBWYSIWYG_MULTIBAND\fR[=<\fION\fR|\fIOFF\fR>] Exchange is the multiplier, per band, whatever you enter. @@ -2981,33 +3068,8 @@ Multiplier is section from multipliers file. Counts once per contest, not per band. . .TP -\fBCONTINENTLIST\fR=\fI"comma separated list of continents"\fR -Valid values are: SA, NA, EU, AF, AS and OC. -. -.TP -\fBCONTINENT_LIST_POINTS\fR=\fId\fR -Points for stations from continents in CONTINENTLIST -. -.TP .B USE_CONTINENTLIST_ONLY -Score zero points for station from continents not in the list. -. -.TP -.B BANDWEIGHT_POINTS -Define a point weighting factor for different bands. -. -.IP -For example, setting: -. -.IP - \fBBANDWEIGHT_POINTS\fR=\fI160:3,80:2,40:1,20:1,15:1,10:2\fR -. -.IP -for use in the All Asia DX (AADX) contest will multiply all QSO points by 3 on -160m, by 2 on 80m and 10m and on all other bands only by 1. -. -.IP -Bands not in the list are weighted by 1. +Count as multiplier only if worked stations continent is in CONTINENTLIST. . .TP .B BANDWEIGHT_MULTIS @@ -3776,7 +3838,7 @@ GitHub contains some more information. . .P -An FAQ and other useful tips are installed +An FAQ and other useful tips are installed in .IR @prefix@/share/doc/@PACKAGE@ . . .P