~ubuntu-branches/ubuntu/maverick/ncbi-tools6/maverick

« back to all changes in this revision

Viewing changes to debian/man/errhdr.1

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2005-03-27 12:00:15 UTC
  • mfrom: (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050327120015-embhesp32nj73p9r
Tags: 6.1.20041020-3
* Fix FTBFS under GCC 4.0 caused by inconsistent use of "static" on
  functions.  (Closes: #295110.)
* Add a watch file, now that we can.  (Upstream's layout needs version=3.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH ERRHDR 1 2001-10-05 NCBI "NCBI Tools User's Manual"
2
 
.SH NAME
3
 
errhdr \- produce a C header file from a set of messages
4
 
.SH SYNOPSIS
5
 
.B errhdr
6
 
[\|\fB-2\fP\|]
7
 
[\|\fB-s\fP\|]
8
 
\fImsgfile\fP
9
 
[\|\fIhdrfile\fP\|]
10
 
.SH DESCRIPTION
11
 
This manual page documents briefly the \fBerrhdr\fP command.
12
 
This manual page was written for the Debian GNU/Linux distribution
13
 
because the original program does not have a manual page.
14
 
.PP
15
 
\fBerrhdr\fP reads a file describing error codes and corresponding
16
 
messages and produces a C header file, either on standard output or in
17
 
\fIhdrfile\fP.
18
 
.PP
19
 
The input file has a simple text-based format; one file
20
 
(errmsg/valid.msg in the source tree) starts
21
 
.PP
22
 
.nf
23
 
MODULE valid
24
 
$$ SEQ_INST, 1
25
 
$^   ExtNotAllowed, 1
26
 
# This is a comment
27
 
A Bioseq "extension" is used for special classes of Bioseq. This class of
28
 
Bioseq should not have one but it does. This is probably a software error.
29
 
 
30
 
$^   ExtBadOrMissing, 2
31
 
This class of Bioseq requires an "extension" but it is missing or of the
32
 
wrong type. This is probably a software error.
33
 
.fi
34
 
.PP
35
 
(Detailed descriptions are optional, and no "end" lines of any sort
36
 
are necessary.)
37
 
.SH OPTIONS
38
 
A summary of options is included below.
39
 
.TP
40
 
\fB-2\fP
41
 
Code, subcode tuples
42
 
.TP
43
 
\fB-s\fP
44
 
Short subcode defines
45
 
.SH AUTHOR
46
 
This manual page was written by Aaron M. Ucko <ucko@debian.org>,
47
 
for the Debian GNU/Linux system (but may be used by others).