path: root/dviware/dvichk/dvichk-en.txt

This file documents DVIChk, a program to extract the page numbers from
.DVI/.LOG files, which are created by means of the TeX formatter.

  Copyright (c) 1990-1993, 2000 Thomas Esken

  This edition is for DVIChk version 1.91.

  Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

  Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

  Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be stated in a
translation approved by the Free Software Foundation.

  Any suggestions, improvements, extensions, bug reports, donations,
proposals for contract work, and so forth are welcome!  Please send
them directly to my eMail address.  If you like my work, I'd appreciate
a postcard from you!

------------------------oOO      \\\_''/      OOo---------------------------
Thomas Esken               O     (/o-o\)     O  eMail: esken@gmx.net
Im Hagenfeld 84                 ((  ^  ))       Phone: +49 251 232585
D-48147 Muenster; Germany    \____) ~ (____/    MotD : 2old2live, 2young2die

DVIChk
******

  DVIChk is a program for extracting the page numbers from .DVI/.LOG
files, which are created by means of the TeX formatter.

  This is Edition 1.00 of the DVIChk documentation, 6 June 2000, for
DVIChk 1.91.

  Any suggestions, improvements, extensions, bug reports, donations,
proposals for contract work, and so forth are welcome!  Please send
them directly to my eMail address.  If you like my work, I'd appreciate
a postcard from you!

------------------------oOO      \\\_''/      OOo---------------------------
Thomas Esken               O     (/o-o\)     O  eMail: esken@gmx.net
Im Hagenfeld 84                 ((  ^  ))       Phone: +49 251 232585
D-48147 Muenster; Germany    \____) ~ (____/    MotD : 2old2live, 2young2die

DVIChk Introduction
*******************

  DVIChk is a program for extracting the page numbers from .DVI files,
which are created by means of the TeX formatter.  When DVIChk processes
.DVI files, it is also able to display information about the fonts used
in the file.  DVIChk is also able to extract the page numbers from .LOG
files, which are created by means of the TeX formatter.  But when DVIChk
processes .LOG files, it is unable to display information about fonts,
thus a possibly given `--font-info' option will be ignored. In case of
errors, all output of DVIChk is directed to the standard error device
channel, otherwise to the standard output device channel.

  The detected page numbers are printed as a table with 4 columns per
row by default.  The number of columns can be changed by using the
`--columns' option.  `--columns=0' displays the detected page numbers in
non-tabulated manner, i.e. they are displayed in one rown, only
separated from each other by using a space character.  The table of
page numbers is lead by an informational text, which contains, among
other things, the file name of the processed file and the total number
of pages found in the file.  This informational text can be extended
with information about the used fonts if the `--font-info' option is
selected.  If no informational text is wanted, the `--no-info' option
can be used to suppress it.  The output of DVIChk, as described above,
can be internally paginated each 24 rows in case the `--pager' option
is used.  If you only want to known how many pages are stored in the
.DVI or .LOG file, simply use the `--total-only' option.

Invoking `dvichk'
*****************

  DVIChk is a command line oriented program.  It is usually called from
the "shell" (1) and processes given arguments that are options and
commands, i.e. you must call DVIChk in this way:



     dvichk [ OPTION... ] FILE...



  If DVIChk is started with invalid options or without a FILE command,
it displays a help text and the program exits.  In case a FILE command
without a file extension is given, DVIChk first tries to process a file
by the name of `FILE.log' if both the files `FILE.dvi' and `FILE.log'
exist.

  An option is defined by a leading "switch" character; the `-' (dash)
character for traditional short-style options, or `--' for mnemonic
long-style options; a command may not have a leading switch character!

  DVIChk supports both short-style options and GNU long-style options.
Traditional short-style options are indicated by a single switch
character, and trailed by the option character itself and perhaps a
modifier or an argument.  The most single character options (2) can be
composed into a single command line word: `-Ax' is equivalent to `-A
-x'.  GNU long-style options are indicated with `--', and trailed by
the mnemonic option name itself and perhaps an argument.  Long-style
options and their arguments may be abbreviated if done unambiguously.
When a long-style option takes an argument, connect the option name and
the argument with `='.

DVIChk distinguishes two different types of long-style options:

  1. `--foo'
     Enables option `--foo'.

  2. `--foo=BAR'
     Enables option `--foo' with required argument BAR.

Traditional short-style options differ as follows:

  1. `-x'
     Enables option `-x'.

  2. `-x BAR'
     Enables option `-x' with required argument BAR.  The BAR argument
     may be separated by a leading _whitespace_ character from the
     short-style option character `x'.  This means, the following
     notations are valid for giving an argument, namely `-x BAR' or
     `-xBAR'.

DVIChk recognizes and processes the following options:

`-c 0...9'
`--columns=0...9'
     The page numbers found in the FILE are displayed by using 1...9
     columns per row, the default number of columns per row is 4.  When
     using `--columns=0', the page numbers found are displayed in
     non-tabulated manner, i.e. they are displayed in one rown, only
     separated from each other by using a space character.

`-i'
`--no-info'
     The output contains no further information, i.e. only the page
     numbers found in the FILE are displayed.

`-f'
`--font-info'
     The output is provided with information of the fonts found in the
     FILE.  But this is only possible in case the mode of operation is
     to process a .DVI file, which is created by means of the TeX
     formatter.

`-t'
`--total only'
     Display the total number of pages found in the FILE *only*.

`-p'
`--pager'
     The output is internally paginated each 24 rows.

`-?'
`-h'
`--help'
     Print a short usage message listing most of all available options,
     then exit successfully.

`-L'
`--license'
`--copyleft'
`--copyright'
     Print the software license message, then exit successfully.

`-V'
`--version'
     Print the version number and compilation options, then exit
     successfully.

  ---------- Footnotes ----------

  (1) This is an operating system program which interprets and runs
given command lines.

  (2) Unless they take an argument.

Environment Variables
*********************

Here is a table of all environment variables which are used by DVIChk:



`LANGUAGE'
     The national language and other cultural-specific conventions used
     by DVIChk at run-time.  Takes precedence over `LC_ALL',
     `LC_MESSAGES' and `LANG'.

`LC_ALL'
     The national language and other cultural-specific conventions used
     by DVIChk at run-time.  Takes precedence over `LC_MESSAGES' and
     `LANG'.

`LC_MESSAGES'
     The national language and other cultural-specific conventions used
     by DVIChk at run-time.  Takes precedence over `LANG'.

`LANG'
     The national language and other cultural-specific conventions used
     by DVIChk at run-time.

Error Codes
***********

DVIChk produces the following _exit_ codes:



`126'
     Invalid command line argument / option.

`110'
     No file name given.

`109'
     File not found.

`107'
     Error while reading file.

`106'
     Error while closing file.

`105'
     Corrupted file.

`104'
     Empty file.

`103'
     Irregular file.

`50'
     Virtual memory exhausted.

`49'
     Internal error, invalid value for the size of internal table
     occured.

`48'
     Internal error, C function failed.

`0'
     Normal program termination.

Concept Index
*************

- switch character:
          See ``Invoking `dvichk'''.
-- switch character:
          See ``Invoking `dvichk'''.
Arguments of command line:
          See ``Invoking `dvichk'''.
Columns, number:
          See ``Invoking `dvichk'''.
Command line interpreter:
          See ``Invoking `dvichk'''.
Command line options, dvichk:
          See ``Invoking `dvichk'''.
Command line, arguments:
          See ``Invoking `dvichk'''.
Commands:
          See ``Invoking `dvichk'''.
Copyleft:
          See ``Invoking `dvichk'''.
Copyright:
          See ``Invoking `dvichk'''.
DVIChk Introduction:
          See ``DVIChk Introduction''.
dvichk options:
          See ``Invoking `dvichk'''.
dvichk, options:
          See ``Invoking `dvichk'''.
EMail, error code:
          See ``Error Codes''.
Environment variable, LANG:
          See ``Environment Variables''.
Environment variable, LANGUAGE:
          See ``Environment Variables''.
Environment variable, LC_ALL:
          See ``Environment Variables''.
Environment variable, LC_MESSAGES:
          See ``Environment Variables''.
Environment variables, table:
          See ``Environment Variables''.
Error Codes, table:
          See ``Error Codes''.
Exit Codes, table:
          See ``Error Codes''.
Font information, output:
          See ``Invoking `dvichk'''.
GNU style options:
          See ``Invoking `dvichk'''.
Help text, online:
          See ``Invoking `dvichk'''.
Informations, output without further:
          See ``Invoking `dvichk'''.
Interal pager:
          See ``Invoking `dvichk'''.
Invoking dvichk:
          See ``Invoking `dvichk'''.
LANG environment variable:
          See ``Environment Variables''.
LANGUAGE environment variable:
          See ``Environment Variables''.
LC_ALL environment variable:
          See ``Environment Variables''.
LC_MESSAGES environment variable:
          See ``Environment Variables''.
Long-style options:
          See ``Invoking `dvichk'''.
Number of columns:
          See ``Invoking `dvichk'''.
Online help text:
          See ``Invoking `dvichk'''.
Options:
          See ``Invoking `dvichk'''.
Options of dvichk:
          See ``Invoking `dvichk'''.
Options, long-style:
          See ``Invoking `dvichk'''.
Options, short-style:
          See ``Invoking `dvichk'''.
Output of total number of pages only:
          See ``Invoking `dvichk'''.
Output with font information:
          See ``Invoking `dvichk'''.
Output without further information:
          See ``Invoking `dvichk'''.
Pager, interal:
          See ``Invoking `dvichk'''.
Program exit states, table:
          See ``Error Codes''.
Respected environment variables, table:
          See ``Environment Variables''.
Run-time error codes, table:
          See ``Error Codes''.
Separator character, whitespace:
          See ``Invoking `dvichk'''.
Shell:
          See ``Invoking `dvichk'''.
Short-style options:
          See ``Invoking `dvichk'''.
Single character options:
          See ``Invoking `dvichk'''.
Single command line word:
          See ``Invoking `dvichk'''.
Software license, finding:
          See ``Invoking `dvichk'''.
Switch character, -:
          See ``Invoking `dvichk'''.
Switch character, --:
          See ``Invoking `dvichk'''.
Table of all environment variables:
          See ``Environment Variables''.
Table of all error codes:
          See ``Error Codes''.
Table of all exit codes:
          See ``Error Codes''.
Total number of pages, output:
          See ``Invoking `dvichk'''.
Version number, finding:
          See ``Invoking `dvichk'''.
Whitespace character:
          See ``Error Codes''.
Whitespace separator character:
          See ``Invoking `dvichk'''.
Inhaltsverzeichnis
******************


DVIChk

DVIChk Introduction

Invoking `dvichk'

Environment Variables

Error Codes

Concept Index