-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
214 lines (152 loc) · 6.34 KB
/
README
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
Texinfo Publisher.
Copyright (C) 2012 A. Bradford
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
See file 'COPYING' for more information.
You will need specific GNU/Linux packages installed.
Run the command './configure' for more information.
After configuration run the command 'make'
This will build:
index.html, indexNoSplit.html and associated HTML files.
This file has relative links to the .pdf, .txt, .epub and .zip files.
indexNoSplit.html has all HTML content on one page.
Website_frame.html has all HTML content in a frame.
Website.pdf - Your PDF manual
Website.txt - Text version of your manual with ASCII graphics.
Website_PlainText.txt - Plain text version of your manual with no ASCII graphics.
Website.info - Info version of your manual
Website.epub - EPUB Book of your manual. This will only be created if your
system has the package dbtoepub installed.
Website.dbk - DocBook version of your manual
Website.zip - Zip files of HTML, PDF, .txt and EPUB files. This Zip file can
be un-zipped in a public_html web server space to make a website.
Website.tar.gz - Gzipped tar file to recreate all content.
Individual builds
-----------------
Run the command 'make pdf'.
Builds: Website.pdf
Run the command 'make docbook'.
Builds: Website.dbk
Run the command 'make xml'.
Builds: Website.xml
Run the command 'make epub'.
Builds: Website.epub
Run the command 'make frames'.
Builds: Website_frame.html
Run the command 'make html2'.
Builds index.html and associated HTML files. This HTML is different
from the HTML generated by 'make all'
Run the command 'make pdf2'.
Builds: Website.pdf. This PDF is different style from the PDF
generated by 'make all'.
Run the command 'make djvu'
Builds: Website.djvu
Run the command 'make dvi'.
Builds: Website.dvi
Run the command 'make ps'.
Builds: Website.ps
Run the command 'make text'.
Builds: Website.txt
Images are converted to ASCII.
Run the command 'make plaintext'.
Builds: Website_PlainText.txt
Images are not converted to ASCII.
Run the command 'make textsplit'.
Builds directory textsplit
Chapters are split into separate files.
Images are converted to ASCII.
Run the command 'make plaintextsplit'.
Builds directory plaintextsplit
Chapters are split into separate files.
Images are not converted to ASCII.
Run the command 'make info'.
Builds: Website.info
Run the command 'make htmlhelp'.
This will create the file Website.hhp which can be made into a
Microsoft HTML Helper file (.chm) with the utility hhc.exe
Run the command 'make distclean ; make zip'
This will build the compressed Website.zip
Backup directories are deleted by distclean.
Run the command 'make resize'.
This will resize JPG and PNG images in directory images to 960x576,
640x480 and 320x240 sizes.
Run the command 'make clean'.
To delete all Makefile generated files. All source files are kept.
Run the command 'make distclean ; make dist'
This will build the compressed gzipped .tar.gz distribution.
Backup directories are deleted by distclean.
More commands
-------------
make clean; make TEXI2DVI_FLAGS=''
Do nothing.
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT'
Generate index.html
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D NOSPLIT'
Generate index.html and indexNoSplit.html
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D NOSPLIT -D ZIP'
Generate index.html, indexNoSplit.html and Zip file content.
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D NOSPLIT -D PDF'
Generate index.html, indexNoSplit.html and PDF.
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D NOSPLIT -D PDF -D EPUB'
Generate index.html, indexNoSplit.html, PDF and EPUB.
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D POSTSCRIPT -DVI'
Generate index.html, PostScript and TeX DVI.
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D PDF'
Generate index.html and PDF.
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D EPUB'
Generate index.html and EPUB.
make clean; make 'TEXI2DVI_FLAGS=-D SPLIT -D PDF -D EPUB'
Generate index.html, PDF and EPUB.
HTML output always has links to non-HTML formats. 'make' and 'make all'
are equivalent to command
make 'TEXI2DVI_FLAGS=-D SPLIT -D NOSPLIT -D PDF -D TEXT -D EPUB -D ZIP'
The variable TEXI2DVI_FLAGS can also be customized by editing the Makefile.
make CSS=css/janix-texinfo.css
Generate HTML using the Cascading Style Sheet (CSS) css/janix-texinfo.css
make CSS=css/bright-colors.css
Generate HTML using the Cascading Style Sheet (CSS) css/bright-colors.css
make CSS=css/datamash-texinfo.css
Generate HTML using the Cascading Style Sheet (CSS) css/datamash-texinfo.css
make CSS=css/infodoc-styles.css
Generate HTML using the Cascading Style Sheet (CSS) css/infodoc-styles.css
make CSS=css/sirgazil-document-1.0.1.css
Generate HTML using the Cascading Style Sheet (CSS) css/sirgazil-document-1.0.1.css
Graphics Commands
-----------------
Run the command 'png2eps'.
In the images/ directory convert all .png files to .eps format.
Run the command 'jpg2eps'.
In the images/ directory convert all .jpg files to .eps format.
Run the command 'gif2eps'.
In the images/ directory convert all .gif files to .eps format.
Run the command 'jpg2txt'.
In the images/ directory convert all .jpg files to .txt format.
Run the command 'png2txt'.
In the images/ directory convert all .png files to .txt format.
Run the command 'gif2png'.
In the images/ directory convert all .gif files to .png format.
Run the command 'gif2jpg'.
In the images/ directory convert all .gif files to .jpg format.
Run the command 'jpg2png'.
In the images/ directory convert all .jpg files to .png format.
Run the command 'eps2pdf'.
In the images/ directory convert all .eps files to .pdf format.
Misc
----
Run the command 'linkchecker'.
Run linkchecker on the document.
See 'linkchecker'.
Run the command 'style'.
Run style command on the document.
See 'man style'.
Run the command 'diction'.
Run diction command on the document.
See 'man diction'.