summaryrefslogtreecommitdiff
path: root/support/vvcode/doc/vvcode.tex
blob: 8a0ac20b6b3f78f808e68122116c8ef02faf11be (plain)
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
\input texinfo.tex @c -*-texinfo-*-
@tableindent=0.9in

@comment %**start of header
@setfilename vve-port.info
@settitle VVcode
@node Porting Guide, Porting Guide, Top, Top
@comment %**end of header

@iftex
@finalout
@end iftex

@c -------------------------------------------------------------------------
@c Note: Please update the edition number, month, and year 
@c Edition number is set at: settitle, subtitle and top node
@c Month or date is set at: subtitle and top node; 
@c Search for:  !!set
@c -------------------------------------------------------------------------

@ifinfo
This file documents Vvcode, a superior replacement for UUcode to allow the
documentation system that uses a single source file to produce both on-line
information and a printed manual.

This is the first edition of the VVcode documentation, 
@w{May 1992,} for VVcode version 1.00.

Copyright (C) 1992 Niel Kempson

This is the first edition of the VVcode documentation,@* 
and is consistent with version 1.00 of VVcode.

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).

@end ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Free Software Foundation.
@end ifinfo



@c
@c *************************************************************************
@c TITLE PAGE
@c *************************************************************************
@setchapternewpage odd
@titlepage

@c !!set Set the month and edition here.
@title{VVcode}
@subtitle{Last revised May 1992}
@subtitle{for VVcode version 1.00}
@author{Niel Kempson}     
@page

@vskip 1in
This is the first edition of the VVcode documentation and should be
consistent with the following versions of VVcode:

@itemize @bullet
  @item VVcode system v1.00
  @item MS-DOS port v1.00-001
  @item OS/2 port v1.00-001
  @item Unix port v1.00-001
  @item VAX/VMS port v1.00-001
  @item VM/CMS port v1.00-001
@end itemize

As VVcode is ported to new environments this documentation should be
updated.

@vskip 0pt plus 1filll
Copyright @copyright{} 1992 Niel Kempson

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that
the entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
@end titlepage
@page



@c *************************************************************************
@c NODE: the top
@c *************************************************************************
@ifinfo
@node Top, Copying, (dir), (dir)
@top VVcode

VVcode is a superior replacement for UUcode to enable the reliable
transmission of data over the world's e-mail networks.

@c !!set Set the date and edition here.
This is the first edition of the VVcode documentation, 
@w{May 1992,} for VVcode version 1.00.
@end ifinfo

@menu
* Copying::                     VVcode copying conditions
* Introduction::                Introduction to VVcode
* User Manual::                 Guide to using VVcode
* Porting Guide::               How to port VVcode to a new environment
* Testing Guide::               How to test VVcode
* File Formats::                Definition of VVcode-related file formats
@end menu



@c *************************************************************************
@c CHAPTER: VVcode copying conditions
@c *************************************************************************
@c    node-name, next, previous,  up
@node Copying, Copying, Top, Top
@unnumbered VVcode copying conditions

The programs currently being distributed that relate to VVcode are
@dfn{free}; this means that everyone is free to use them and free to
redistribute them freely.  The VVcode-related programs are not in the
public domain; they are copyrighted and there are restrictions on their
distribution, but these restrictions are designed to permit everything that
a good cooperating citizen would want to do.  What is not allowed is to try
to prevent others from further sharing any version of these programs that
they might get from you.@refill

  Specifically, we want to make sure that you have the right to give away
copies of the programs that relate to VVcode, that you receive source code
or else can get it if you want it, that you can change these programs or
use pieces of them in new free programs, and that you know you can do these
things.@refill

  To make sure that everyone has such rights, we have to forbid you to
deprive anyone else of these rights.  For example, if you distribute copies
of the VVcode related programs, you must give the recipients all the rights
that you have.  You must make sure that they, too, receive or can get the
source code.  And you must tell them their rights.@refill

  Also, for our own protection, we must make certain that everyone finds
out that there is no warranty for the programs that relate to VVcode.  If
these programs are modified by someone else and passed on, we want their
recipients to know that what they have is not what we distributed, so that
any problems introduced by others will not reflect on our
reputation.@refill

  The precise conditions of the licenses for the programs currently being
distributed that relate to VVcode are found in the General Public Licenses
that accompany them.@refill



@c *************************************************************************
@c CHAPTER: Contributors to VVcode
@c *************************************************************************
@c    node-name, next, previous,  up
@node Contributors, Contributors, Top, Top
@unnumbered Contributors to VVcode

In addition to Niel Kempson, several people have contributed to the
development of VVcode.

@itemize @bullet
  @item Rainer Sch@"opf @code{<schoepf@@sc.ZIB-Berlin.de>} wrote the VM/CMS
        implementation and has been very helpful during the testing of
        VVcode.
  @item Brian Hamilton Kelly @code{<TeX@@rmcs.cranfield.ac.uk>} for
        encouragement and testing of the VAX/VMS implementation.
  @item Konrad Bernlohr @code{<bern@@dhdmpi50.bitnet>} made some helpful
        suggestions for improvements to the original version.
  @item The Aston University @TeX{} archive group for help and
        encouragement during the long gestation period.  In alphabetical
        order:
    @itemize @bullet
        @item Adrian Clark @code{<alien@@essex.ac.uk>}
        @item Brian Hamilton Kelly @code{<tex@@rmcs.cranfield.ac.uk>}
        @item Dave Osborne @code{<d.osborne@@mips.nottingham.ac.uk>}
        @item Max Calvini @code{<m_calvini@@TeX.ac.uk>}
        @item Peter Abbott @code{<p.abbott@@aston.ac.uk>}
        @item Phil Taylor @code{<chaa006@@vax.rhbnc.ac.uk>}
        @item Rainer Sch@"opf @code{<schoepf@@sc.ZIB-Berlin.de>}
        @item Sebastian Rahtz @code{<s_rahtz@@TeX.ac.uk>}
    @end itemize
@end itemize



@c *************************************************************************
@c CHAPTER: Introduction to VVcode
@c *************************************************************************
@include vvintro.texinfo



@c *************************************************************************
@c CHAPTER: Guide to using VVcode
@c *************************************************************************
@include vvuser.texinfo



@c *************************************************************************
@c CHAPTER: Installing VVcode
@c *************************************************************************
@include vvinstal.texinfo



@c *************************************************************************
@c CHAPTER: How to port VVcode to a new environment
@c *************************************************************************
@include vvport.texinfo



@c *************************************************************************
@c CHAPTER: How to test VVcode
@c *************************************************************************
@include vvtest.texinfo



@c *************************************************************************
@c CHAPTER: Definition of VVcode-related file formats
@c *************************************************************************
@include vvfiles.texinfo



@c *************************************************************************
@c Table of Contents
@c *************************************************************************
@contents
@bye