File: textchk.1

package info (click to toggle)
textchk 2002.01.10
  • links: PTS
  • area: main
  • in suites: sarge, woody
  • size: 284 kB
  • ctags: 22
  • sloc: perl: 590; makefile: 134
file content (86 lines) | stat: -rw-r--r-- 1,645 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
.TH TEXTCHK "1" "" "Textchk"
.SH NAME
Textchk \- manual page for Textchk
.SH SYNOPSIS
.B /opt/textchk/bin/textchk
\fI--input-type=TYPE FILE_TO_BE_ANALYZED \fR[\fIREPORT_FILE \fR[\fIDIAG_FILE\fR]]
.br
.B /opt/textchk/bin/textchk
\fI--help\fR
.br
.B /opt/textchk/bin/textchk
\fI--version\fR
.SH DESCRIPTION
Check for common syntax and style mistakes inside a text.
.SH OPTIONS
\fB\-\-help\fR
.IP
display this help and exit.
.PP
\fB\-\-version\fR
.IP
display version information and exit.
.PP
\fB\-\-input\-type\fR=\fITYPE\fR
.IP
define the input type:

\fBstandard\fR
.IP
input is a text file where every paragraph
is on a single line;
.PP
\fBman\fR
.IP
input is a man page file;
.PP
\fBhtml\fR
.IP
input is an HTML file;
.PP
\fBtexi\fR, \fBtexinfo\fR
.IP
input is a Texinfo source file.
.PP
.PP
.PP
.SH ARGUMENTS
.PP
\fIFILE_TO_BE_ANALYZED\fR
.IP
the input file.
.PP
\fIREPORT_FILE\fR
.IP
summary file of reported errors.
.PP
\fIDIAG_FILE\fR
.IP
processing information output file.

It helps to find troubles with the declared
rules.
.PP
.PP
.SH AUTHOR
Written by Daniele Giacomini <daniele@swlibero.org>
.SH "REPORTING BUGS"
Report bugs to <daniele@swlibero.org>
.SH COPYRIGHT
Copyright \(co 2000-2001 Daniele Giacomini <daniele@swlibero.org>
.br
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
The full documentation for
.B Textchk
is maintained as a Texinfo manual.  If the
.B info
and
.B Textchk
programs are properly installed at your site, the command
.IP
.B info textchk
.PP
should give you access to the complete manual.