cleanup and documentation updates
[webpac] / openisis / doc / mx.txt
diff --git a/openisis/doc/mx.txt b/openisis/doc/mx.txt
deleted file mode 100644 (file)
index 1a09d76..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
-mx overview
-
-running mx with no params yields:
-=========
-CISIS Interface v3.33/GC/M/30000/10/30/I - Utility MX
-Copyright (c) BIREME/PAHO 1997. All rights reserved.
-
-mx [cipar=<file>] [{mfrl|fmtl}=<n>] 
-   {<dbn>|{in|cgi|seq|iso[=<n>]}=<file>|tmp} [<option> [...]]
-options: 
-   [bool=]{<bool_expr_spec>|@<file>} 
-   text[/show]=<text> 
-   {from|to|loop|count|tell|load}=<n> [now]
-   gizmo=<gizmo_dbn>[,<taglist>] [gizp=<dbnx>] [decod=<decod_dbn>]  
-   join=<join_dbn>[,<tags>]={<key_fmt_spec>|@<file>} [jmax=<n>]
-   jchk=<join_dbn>[+<file>]={<key_fmt_spec>|@<file>}  [actab=<file>] 
-   proc={<fldupdat_fmt_spec>|@<file>} 
-   fst={<fst_spec>|@[<file>]} [stw=@[<file>]] [ln{1|2}=<file> [+fix[/m]]] 
-   {+|-}{control|leader|xref|dir|fields|all} 
-   pft={<prt_fmt_spec>|@[<file>]} [lw=<n>] 
-   sys[/show]={<sys_fmt_spec>|@<file>} 
-   [mono|mast|full] {create|copy|append|merge|updatf}=<out_dbn> 
-   ifupd[/create][/dict]=<out_ifn> 
-   {iso[=<n>]|fix}=<out_file> 
-=========
-
-*      db to use
-<dbn>  basename of dbfiles, e.g. db/cds/cds
-       tmp or null denotes a pseudo-db with an unlimited no of empty records
-iso=<file>     full name of iso2709-file, e.g. db/cds/cds.iso
-seq=<file>[<c>]        plaintext input, fields separated by char <c> (default |)
-
-*      general options
-now    proceed without prompting (nowait)
--all   suppress printing record contents (but print errors and tell=<n>)
-tell=<n>       print notice every <n> records (usually with -all)
-in=<file>      read params, one per line, from textfile <file>
-
-*      record selection
-from=<n>       start at MFN <n> (default 1)
-to=<n> run up to MFN <n> (default last)
-loop=<n>       select every <n>th record (default 1)
-count=<n>      select <n> records (default all or as by to)
-[bool=]<query> select by <query>, e.g. bool='water*plants'
-[bool=]@<file> read query from <file>
-text[/show]=<phrase>   fulltext scan for <phrase> (more output with /show)
-
-*      processing options
-gizmo=<file>[,tags]    apply gizmo translation to all or given fields
-       tag numbers are seperated by , tagrange by / (e.g. n/m is n to m)
-join=<spec>    join additional db by key (.... TODO)
-proc=<cmd>     process records according to <cmd> (see below)
-proc=@<file>   read processing cmd from <file>
-
-*      key generation
-fst=<spec>     use field selection table <spec>
-fst=@[<file>]  read fst from <file> (default <dbn>.fst)
-stw=@[<file>]  read stopwords from <file> (default <dbn>.stw)
-ln<i>=<file>   create linkfile <i> (1 or 2) as <file> (see below)
-+fix[/m]       select linkfile format suitable for sorting (see below)
-
-*      controlling output format
-pft=<fmt>      use printformat string <fmt>, e.g. mfn/v24/v70
-pft=@<file>    use printformat from <file>
-lw=<n> set linewidth to <n> (default 78)
-
-*      linkfile format
-linkfiles are textfiles with one line per posting,
-containing the key, mfn, tag, occ and cnt.
-standard format: mfn tag occ cnt key (blank separated)
-+fix: key mfn tag occ cnt (blank padded to max len)
-+fix/m: key mfn (blank padded to max len)
-