VCIF
Section: User Commands (1)
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- BUGS
-
- AUTHOR
-
- SEE ALSO
-
NAME
vcif - validate syntax of Crystallographic Information File
SYNOPSIS
vcif
[-option ...] file-name
DESCRIPTION
Vcif
reads a file in CIF(5) format, and writes to standard output any syntax errors
it finds. Unlike a strict CIF parser, which will exit on encountering the
first syntax error in a file,
vcif
attempts to recover and report further errors. However, certain errors
(such as unterminated text fields) can confuse the program.
If file-name is "-", vcif will read from standard input.
OPTIONS
- -l nn
-
Maximum line length. Report lines exceeding
nn
characters in length (the default is the CIF standard value of 80).
- -w nn
-
Maximum length of datanames or data_ block headers. Report any exceeding
nn
characters in length (the default is the CIF standard value of 32).
- -q
-
Quiet. Report no errors. The return value of the program is a count of
the number of errors encountered.
- -v
-
Verbose. Give a more complete account of each error on its first occurrence.
This mode will only report the first 20 errors, unless this is over-ridden
by the -e option.
- -s
-
Do not flag extra STAR(5) file syntax features, such as global_ and
save_ frames, as errors. Useful for checking the syntax of CIF dictionary
files, which have these additional features.
- -e nn
-
Number of errors to report. The default is 20 in verbose mode, and unlimited
otherwise.
- -D debug-file-name
-
Write (copious) debugging output to the named file.
BUGS
Embedded nulls in an input file will confuse the program.
AUTHOR
B. McMahon
SEE ALSO
quasar(1), sb(1), CIF(5), STAR(5)