Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

Subsections

• Synopsis
• Description
• Options
• Notes
• Diagnostics
• Examples
• See also
• Author

dox

Select and view AIPS++ documents online.

Synopsis

dox [-d directory | -directory=directory] [-D default | -default=default] [-r | -restrict-search] [document]

Description

dox provides a convenient user interface for selecting and viewing the documents stored in a specified directory and its subdirectories, $AIPSDOCS by default (§1.2).

If no document is specified on the command line then dox will produce a list of all available files and ask the user to pick one. Full minimum-match is applied to the user's response, including minimum-match on the subdirectory name. If a case-sensitive match fails, dox tries for a case-insensitive match.

If a document is specified on the command line then full minimum-match is applied to it (including matching on subdirectories). Likewise for any default specified.

dox recognizes DVI, HTML, POSTSCRIPT, and ASCII files, and also many standard unix file types (via their file suffix). It also handles compressed POSTSCRIPT and text files with .gz, .z, and .Z suffix extensions.

Documents produced by TEX/L^ATEX with a .dvi suffix will be displayed by xdvi (or as specified by the DVIVIEWER environment variable). POSTSCRIPT files with a .ps suffix will be displayed by ghostview (or as specified by the PSVIEWER environment variable). HTML files with a .html or .htm suffix will be displayed by netscape (or as specified by the HTMLVIEWER environment variable). Ordinary text files with a .text or .txt suffix are displayed with more (or as specified by the PAGER environment variable).

If dox does not recognize the file suffix it will check first to see whether the file contains POSTSCRIPT, then whether it is a printable ASCII file. If all else fails, dox resorts to using od.

Options

-d directory | -directory=directory

The documentation directory or directories to search. If not specified, the default is taken from the DOXPATH environment variable if defined, otherwise $AIPSROOT/docs.

-D default | -default=default

Default document when querying the user interactively. The default for the default is reference/Introaips.ps.

-r | -restrict-search

Restrict the search of the documentation directory and all subdirectories to .dvi, .ps*, .text*, and .txt* files when preparing the document list. The default is to list everything.

Whitespace is allowed between short-form options and their arguments.

Notes

• The matching algorithm gives more weight to the start of the filename than the middle or end. For example Foo matches FooBar before BarFoo. On the other hand, foo matches Barfoo before FooBar because it is a better case-sensitive match. The algorithm also gives more weight to the filename than directory name. For example, Foo matches Bar/Foo, or even Bar/FooBar, before Foo/Bar.

• dox starts appreciably faster if given a case-sensitive match for the start of the document name.

Diagnostics

Status return values
0: success
1: initialization error
2: error getting document name
3: error starting previewer

Examples

View the ``AIPS++ System manual'' (i.e. this manual):

   dox System

Select from all available AIPS++ documents:

   dox

See also

The manual page for dvips(1).
The GNU manual page for ghostview(1).
The GNU manual page for gzip(1).
The unix manual page for od(1).
The manual page for xdvi(1).
The GNU manual page for zcat(1).
The GNU manual page for zmore(1).

Author

Original: 1993/10/29 by Mark Calabretta, ATNF