Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / mail / USD.doc / mail7.nr
blob0b6837f3fea2f06a7b08175e941d85495fae21f2
1 .\"     $NetBSD: mail7.nr,v 1.2 1998/01/09 08:05:59 perry Exp $
2 .\"
3 .\" Copyright (c) 1980, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)mail7.nr    8.1 (Berkeley) 6/8/93
31 .\"
32 .sh 1 "Format of messages"
33 .pp
34 This section describes the format of messages.
35 Messages begin with a
36 .i from
37 line, which consists of the word
38 .q From
39 followed by a user name, followed by anything, followed by
40 a date in the format returned by the
41 .i ctime
42 library routine described in section 3 of the Unix Programmer's
43 Manual.  A possible
44 .i ctime
45 format date is:
46 .(l
47 Tue Dec  1 10:58:23 1981
48 .)l
49 The
50 .i ctime
51 date may be optionally followed by a single space and a
52 time zone indication, which
53 should be three capital letters, such as PDT.
54 .pp
55 Following the
56 .i from
57 line are zero or more
58 .i "header field"
59 lines.
60 Each header field line is of the form:
61 .(l
62 name: information
63 .)l
64 .i Name
65 can be anything, but only certain header fields are recognized as
66 having any meaning.  The recognized header fields are:
67 .i article-id ,
68 .i bcc ,
69 .i cc ,
70 .i from ,
71 .i reply-to ,
72 .i sender ,
73 .i subject ,
74 and
75 .i to .
76 Other header fields are also significant to other systems; see,
77 for example, the current Arpanet message standard for much more
78 information on this topic.
79 A header field can be continued onto following lines by making the
80 first character on the following line a space or tab character.
81 .pp
82 If any headers are present, they must be followed by a blank line.
83 The part that follows is called the
84 .i body
85 of the message, and must be ASCII text, not containing null characters.
86 Each line in the message body must be no longer than 512 characters and
87 terminated with an ASCII newline character.
88 If binary data must be passed through the mail system, it is suggested
89 that this data be encoded in a system which encodes six bits into
90 a printable character (i.e.: uuencode).
91 For example, one could use the upper and lower case letters, the digits,
92 and the characters comma and period to make up the 64 characters.
93 Then, one can send a 16-bit binary number
94 as three characters.  These characters should be packed into lines,
95 preferably lines about 70 characters long as long lines are transmitted
96 more efficiently.
97 .pp
98 The message delivery system always adds a blank line to the end of
99 each message.  This blank line must not be deleted.
101 The UUCP message delivery system sometimes adds a blank line to
102 the end of a message each time it is forwarded through a machine.
104 It should be noted that some network transport protocols enforce
105 limits to the lengths of messages.