0.9.9e/doc/CmdLine.txt

;man    malete  1       $Date: 2004/06/15 12:06:32 $
Malete tool command line options.

* synopsis

The general format is
$
malete command [general and command options] [db0 opts [db1 opts ...]]
$
Every parameter not starting with a '-' becomes the main value
of a new field in the environment record.

Every option (a parameter starting with a '-') is turned into a subfield
of the field introduced by the last non-option. The first character
is the subfield identifier, the remainder is the subfields value.


Command and the options following it control the overall process behaviour,
other fields specify options for objects (i.e. databases,
in the future also other objects like remote servers).


Example:
$
malete rdump -vi cds -ftest/
$
dumps records of a database named cds in files test/cds.m[rq][dx]
to stdout and some informational messages to stderr.


*       general options

General environment options use lowercase subfield identifiers (see sys.c):
-       vn sets the logging level.
        n is a digit from 0 (off) to 9 (all). You may also use the first letter of
        off, fatal, syserr, err, warn, info, verbose, debug, trace or all.
-       wn sets the writing/sharing mode.
        default is exclusive write mode. n='0' selects shared read-only,
        n='s' selects shared writing (not supported on windows).

*       database options

When a database is opened, it scans the environment record for a field
with the database name as main value for options (see db.c):
-       b selects blocking.
        The process will wait for the shared or exclusive file lock.
        Without this option, it will complain immediatly.
-       fpath specifies db files.
        If path ends with /, it is used as directory, else as file basename (w/o ext).
-       qpn specifies the index type.
        A single q turns use of the index off (i.e. no index files are created).
        Else p is a letter in klpt, setting the keysize, let, pointer type
        or tree type, resp., to number n. Use only if you understood the
>       FileFormats
        . For example _-qk30_ will set the keysize to 30.
-       rn sets the record xref type
        to number n. A single r turns record file use off.
-       wm sets the write mode.
        m='0' selects read-only, m='a' selects asynchronous write
        (recommended only when importing databases).
        No effect in a read-only environment.

*       simple commands

A couple of simple commands have no specific options.
Most commands require one database to be specified as target.

-       dbinfo
        print database parameters
-       qdump
        dump index to stderr as lines of typ separated key,rid,tag,occ,pos.
-       qload
        load index from stdin in the same format
-       rdump
        dump records
-       rload
        load records

*       command options

The various commands use uppercase letters for command specific options.
-       server runs a server
        Without any options, reads from stdin and answers on stdout.
        The -S option specifies a TCP port or UNIX (absolute filename) socket.
        The TCP port may also be prefixed by "localhost:" to bind locally.
        Without any value, -S uses TCP port 2042 (registered by kchapman@isis.com).
-       cdsimp or cdsexp
        import or export from/to
>       CDS
        /ISIS databases.
-       iifimp or iifexp
        import or export from/to
>       IIF
        (ISO2709) files.


1	dpavlin	604	;man malete 1 $Date: 2004/06/15 12:06:32 $
2			Malete tool command line options.
3
4			* synopsis
5
6			The general format is
7			$
8			malete command [general and command options] [db0 opts [db1 opts ...]]
9			$
10			Every parameter not starting with a '-' becomes the main value
11			of a new field in the environment record.
12
13			Every option (a parameter starting with a '-') is turned into a subfield
14			of the field introduced by the last non-option. The first character
15			is the subfield identifier, the remainder is the subfields value.
16
17
18			Command and the options following it control the overall process behaviour,
19			other fields specify options for objects (i.e. databases,
20			in the future also other objects like remote servers).
21
22
23			Example:
24			$
25			malete rdump -vi cds -ftest/
26			$
27			dumps records of a database named cds in files test/cds.m[rq][dx]
28			to stdout and some informational messages to stderr.
29
30
31			* general options
32
33			General environment options use lowercase subfield identifiers (see sys.c):
34			- vn sets the logging level.
35			n is a digit from 0 (off) to 9 (all). You may also use the first letter of
36			off, fatal, syserr, err, warn, info, verbose, debug, trace or all.
37			- wn sets the writing/sharing mode.
38			default is exclusive write mode. n='0' selects shared read-only,
39			n='s' selects shared writing (not supported on windows).
40
41			* database options
42
43			When a database is opened, it scans the environment record for a field
44			with the database name as main value for options (see db.c):
45			- b selects blocking.
46			The process will wait for the shared or exclusive file lock.
47			Without this option, it will complain immediatly.
48			- fpath specifies db files.
49			If path ends with /, it is used as directory, else as file basename (w/o ext).
50			- qpn specifies the index type.
51			A single q turns use of the index off (i.e. no index files are created).
52			Else p is a letter in klpt, setting the keysize, let, pointer type
53			or tree type, resp., to number n. Use only if you understood the
54			> FileFormats
55			. For example _-qk30_ will set the keysize to 30.
56			- rn sets the record xref type
57			to number n. A single r turns record file use off.
58			- wm sets the write mode.
59			m='0' selects read-only, m='a' selects asynchronous write
60			(recommended only when importing databases).
61			No effect in a read-only environment.
62
63			* simple commands
64
65			A couple of simple commands have no specific options.
66			Most commands require one database to be specified as target.
67
68			- dbinfo
69			print database parameters
70			- qdump
71			dump index to stderr as lines of typ separated key,rid,tag,occ,pos.
72			- qload
73			load index from stdin in the same format
74			- rdump
75			dump records
76			- rload
77			load records
78
79			* command options
80
81			The various commands use uppercase letters for command specific options.
82			- server runs a server
83			Without any options, reads from stdin and answers on stdout.
84			The -S option specifies a TCP port or UNIX (absolute filename) socket.
85			The TCP port may also be prefixed by "localhost:" to bind locally.
86			Without any value, -S uses TCP port 2042 (registered by kchapman@isis.com).
87			- cdsimp or cdsexp
88			import or export from/to
89			> CDS
90			/ISIS databases.
91			- iifimp or iifexp
92			import or export from/to
93			> IIF
94			(ISO2709) files.
95
96