File: README.cabrillo

package info (click to toggle)
tlf 1.4.1-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 4,036 kB
  • sloc: ansic: 26,363; sh: 4,339; makefile: 132; perl: 92
file content (118 lines) | stat: -rw-r--r-- 4,590 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
New cabrillo handling
=====================

In last years the cabrillo format became the de facto standard to sent in your
contest results. It showed that the cabrillo implementation in TLF before 1.2.x
had some severe limitations:

- The old code supported only some fixed cabrillo formats for some selected
  contests. It was not always possible to use that code to support newer 
  contests.
- Only cabrillo v2.0 got supported.
- There were some bugs in formatting the QSO: line entries (e.g. formatting
  the qso number).
 

The new cabrillo code (in writecabrillo.c) tries to fix the problems. It is
based on a textual description of the cabrillo format to use, which can be
easily extended by the user to support newer contests. 


WORKING PRINCIPLE
=================

The format descriptions are contained in a file 'cabrillo.fmt' in the
/usr(/local)/share directory. It provides cabrillo format descriptions for
common contests. All descriptions are named and you have to specify which one
has to be used with a statement in logcfg.dat or (better) in the contest rule 
file with the following syntax:

CABRILLO=<formatname>

You can put your own format file 'cabrillo.fmt' in your actual working 
directory which gets precedence over the central one. <formatname> will 
be searched first in your local format file. If it is not found there the
search continues in the central file provided by TLF itself. If it is not
found at all TLF will complain with an error message.

CABILLO.FMT
===========

The format of cabrillo.fmt entries is as follows: 

* The file contains groups of lines which are interpreted as key-value pairs.
* Each group describes a possible cabrillo format and has to be started by a
  line containing the <formatname> in square brackets.
* At the moment only one keyword (QSO=...) is supported.
* Lines beginning with a '#' are interpreted as comments.
* The 'QSO=' key has to be followed by a list of string, number pairs
  separated by semicolons.
  Each pair specify one item to put into the QSO: line of the cabrillo file. 
  The name of the item has to be followed by a comma ',' and a number 
  specifying the character width of that field in the QSO: line. Items 
  which are to wide will be truncated to that width. 

  The following items names are supported:

  FREQ    The working frequency.
  MODE    Mode of operation ('CW', 'PH',...)
  DATE    Date of the QSO
  TIME    Logged time of the QSO
  MYCALL  Own call
  HISCALL Other sides call
  RST_S   RST sent
  RST_R   RST received
  EXC_S   Exchange sent (May contain a '#' character, which gets replaced by 
          the QSO number).
  EXCH    The complete received exchange line
  EXC1    First space separated word of the received exchange
  EXC2    Second word of the received exchange
  EXC3    Third word of the received exchange
  EXC4    Fourth word of the received exchange
  TX      Number of the TX (for cqww or other contests).

  All items represent one column in the resulting cabrillo log file. All 
  entries are separated by an additional space character.

Example
=======

The following entry

[cwo]
QSO=FREQ,5;MODE,2;DATE,10;TIME,4;MYCALL,13;EXC_S,14;HISCALL,13;EXC1,4;EXC2,9

will be selected if 

CABRILLO=cwo

is in the rules file for the CW Open contest. All QSO's will then be formatted
as in the following example:

QSO: 28000 CW 2012-09-23 0815 DL1JBE        0001 Tom       HB9XXX        0023 Joe
QSO: .....

IMPORT CABRILLO
===============

You can import the existing cabrillo file, when you pass the "-i" argument at
startup of Tlf. Logfile must be called YOURCALL.cbr, which is the standard name
convention of Tlf. In this case, Tlf reads the configuration and rule files, so
the scoring and multipliers will be used as your config describes. Your config also
describes the CABRILLO format, what Tlf uses to parses the log to handle the fields
as correctly.

The output file(s) will IMPORT_contest.log, where the contest is the name of
contest in your rule/config file. Eg. my cabrillo is HA2OS.cbr, which must be
exists in the current directory. After the import, the result is IMPORT_cqww.log
(if the contest name is cqww), so the Tlf doesn't write over the existing logfile.

If you want to use the new, imported file, you have to move the old one, and rename
the imported file.

When the contest is WAE, and the rule file contains a valid QTC setup, and cabrillo
contains lines with begin of "QTC:", then you will have the IMPORT_QTC_sent.log and
IMPORT_QTC_recv.log. In this case, the original files also kept, and you have to
archive and rename the files.