bug fix when transfering fields with multiple values (e.g. checkboxes) to
[webpac] / openisis / doc / mx.txt
1 mx overview
2
3 running mx with no params yields:
4 =========
5 CISIS Interface v3.33/GC/M/30000/10/30/I - Utility MX
6 Copyright (c) BIREME/PAHO 1997. All rights reserved.
7
8 mx [cipar=<file>] [{mfrl|fmtl}=<n>] 
9    {<dbn>|{in|cgi|seq|iso[=<n>]}=<file>|tmp} [<option> [...]]
10  
11 options: 
12  
13    [bool=]{<bool_expr_spec>|@<file>} 
14    text[/show]=<text> 
15    {from|to|loop|count|tell|load}=<n> [now]
16  
17    gizmo=<gizmo_dbn>[,<taglist>] [gizp=<dbnx>] [decod=<decod_dbn>]  
18    join=<join_dbn>[,<tags>]={<key_fmt_spec>|@<file>} [jmax=<n>]
19    jchk=<join_dbn>[+<file>]={<key_fmt_spec>|@<file>}  [actab=<file>] 
20    proc={<fldupdat_fmt_spec>|@<file>} 
21    fst={<fst_spec>|@[<file>]} [stw=@[<file>]] [ln{1|2}=<file> [+fix[/m]]] 
22  
23    {+|-}{control|leader|xref|dir|fields|all} 
24    pft={<prt_fmt_spec>|@[<file>]} [lw=<n>] 
25    sys[/show]={<sys_fmt_spec>|@<file>} 
26  
27    [mono|mast|full] {create|copy|append|merge|updatf}=<out_dbn> 
28    ifupd[/create][/dict]=<out_ifn> 
29    {iso[=<n>]|fix}=<out_file> 
30 =========
31
32 *       db to use
33 <dbn>   basename of dbfiles, e.g. db/cds/cds
34         tmp or null denotes a pseudo-db with an unlimited no of empty records
35 iso=<file>      full name of iso2709-file, e.g. db/cds/cds.iso
36 seq=<file>[<c>] plaintext input, fields separated by char <c> (default |)
37
38 *       general options
39 now     proceed without prompting (nowait)
40 -all    suppress printing record contents (but print errors and tell=<n>)
41 tell=<n>        print notice every <n> records (usually with -all)
42 in=<file>       read params, one per line, from textfile <file>
43
44 *       record selection
45 from=<n>        start at MFN <n> (default 1)
46 to=<n>  run up to MFN <n> (default last)
47 loop=<n>        select every <n>th record (default 1)
48 count=<n>       select <n> records (default all or as by to)
49 [bool=]<query>  select by <query>, e.g. bool='water*plants'
50 [bool=]@<file>  read query from <file>
51 text[/show]=<phrase>    fulltext scan for <phrase> (more output with /show)
52
53 *       processing options
54 gizmo=<file>[,tags]     apply gizmo translation to all or given fields
55         tag numbers are seperated by , tagrange by / (e.g. n/m is n to m)
56 join=<spec>     join additional db by key (.... TODO)
57 proc=<cmd>      process records according to <cmd> (see below)
58 proc=@<file>    read processing cmd from <file>
59
60 *       key generation
61 fst=<spec>      use field selection table <spec>
62 fst=@[<file>]   read fst from <file> (default <dbn>.fst)
63 stw=@[<file>]   read stopwords from <file> (default <dbn>.stw)
64 ln<i>=<file>    create linkfile <i> (1 or 2) as <file> (see below)
65 +fix[/m]        select linkfile format suitable for sorting (see below)
66
67 *       controlling output format
68 pft=<fmt>       use printformat string <fmt>, e.g. mfn/v24/v70
69 pft=@<file>     use printformat from <file>
70 lw=<n>  set linewidth to <n> (default 78)
71
72 *       linkfile format
73 linkfiles are textfiles with one line per posting,
74 containing the key, mfn, tag, occ and cnt.
75 standard format: mfn tag occ cnt key (blank separated)
76 +fix: key mfn tag occ cnt (blank padded to max len)
77 +fix/m: key mfn (blank padded to max len)
78