File: README

package info (click to toggle)
troffcvt 1.04%2Brepack1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,416 kB
  • sloc: ansic: 13,110; makefile: 6,847; perl: 1,583; cpp: 333; sh: 215
file content (89 lines) | stat: -rw-r--r-- 2,758 bytes parent folder | download
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
87
88
89
The troffcvt distribution contains tools for processing troff files and
turning them into other formats.  The sample converters included in the
distribution are:

troff2html	troff to HTML
troff2rtf	troff to RTF
unroff		troff to text (like deroff, but often better)
troff2null	troff to nothing (null converter)

The distribution also includes tblcvt, a preprocessor for files containing
tbl-format table specifications.  It turns files into a form that's
friendlier to troffcvt than raw tbl output.

The pic, eqn, and grap preprocessors are NOT supported (and likely never
will be).

troffcvt tools are used much like tbl and troff.  Suppose you'd normally
format a document like this:

	% troff -ms mydoc.ms > mydoc.out

To turn your document into HTML instead, you'd use this command:

	% troff2html -ms mydoc.ms > mydoc.html

Substitute troff2rtf or unroff for troff2html to turn the document into RTF
or plain text:

	% troff2rtf -ms mydoc.ms > mydoc.rtf
	% unroff -ms mydoc.ms > mydoc.txt

If your document contains tables, you might normally format it like this:

	% tbl mydoc.ms | troff -ms > mydoc.out

To produce HTML instead, do this:

	% tblcvt mydoc.ms | troff2html -ms > mydoc.html

troffcvt supports the -ms and -man macro packages best.  It supports
-me, -mdoc, and -mm less well.

The quality of troffcvt conversions is often acceptable, but not
always.  If you want to find out whether or not troffcvt produces
output that is good enough for your purposes, you can use the
troffcvt-server mail server to convert some sample documents by mail.
Check the following location for instructions:

	http://www.primate.wisc.edu/software/troffcvt/

In any case, troffcvt should process your documents without crashing.
If your documents cause a crash, I'd be interested in finding out why.
(Note however that I'll want a copy of your input files.  If you are
formatting proprietary information and won't let me see it, I can't
help you.)

-----------------------------------------------------------------------------

What to read:

README - this file
Prereq.* - installation prerequisites
INSTALL - installation instructions
Changes-* - summary of release-specific major changes
Log - more detailed log of changes

Manual pages available (in the man directory):
	troffcvt.man
	tblcvt.man
	troff2html.man
	troff2rtf.man
	tc2html.man
	tc2html-toc.man
	unroff.man

Documents available (in the doc directory):
	troffcvt.ms	overview
	tblcvt.ms	tblcvt notes
	bugs.ms		bug list
	actions.ms	action reference
	output.ms	output format, postprocessor writing
	tc2html.ms	tc2html notes
	tc2rtf.ms	tc2rtf notes
	groff.ms	groff support notes
	frontend.ms	front end writing

Questions and comments to: dubois@primate.wisc.edu

If you find bugs, please report them.