mh-gen.8

早期freebsd实现

.\" @(#)$Id: mh-gen.8,v 2.115 1993/12/01 00:44:23 jromine Exp $
.\" uneven inter-word spacing (nroff line adjusting) hampers readability
.if n .na
.TH MH-GEN 8 MH.6.8.3 [mh.6]
.SH NAME
mh-gen \- generating the MH system
.SH "READ THIS"
This documentation describes how to configure, generate, and install
the UCI version of the RAND \fIMH\fR system.  \fBBe certain\fP to 
read this document completely before you begin.  You probably will
also want to familiarize yourself with the \fIMH\fP Administrator's
Guide before you install \fIMH\fP.  A copy can be found in the
file \fBdoc/ADMIN.doc\fP is the \fIMH\fP sources.
.SH DISCLAIMER
Although the \fIMH\fR system was originally developed by the RAND Corporation,
and is now in the public domain,
the RAND Corporation assumes no responsibility for \fIMH\fR
or this particular modification of \fIMH\fR.
.PP
In addition,
the Regents of the University of California issue the following
\fBdisclaimer\fR in regard to the UCI version of \fIMH\fR:
.in +.5i
\*(lqAlthough each program has been tested by its contributor,
no warranty, express or implied,
is made by the contributor or the University of California,
as to the accuracy and functioning of the program
and related program material,
nor shall the fact of distribution constitute any such warranty,
and no responsibility is assumed by the contributor
or the University of California in connection herewith.\*(rq
.in -.5i
.PP
This version of \fIMH\fR is in the public domain,
and as such,
there are no real restrictions on its use.
The \fIMH\fR source code and documentation have no licensing restrictions
whatsoever.
As a courtesy,
the authors ask only that you provide appropriate credit to the RAND
Corporation and
the University of California for having developed the software.
.SH "GETTING HELP"
\fIMH\fR is a software package that is neither supported by the RAND
Corporation nor the University of California.
However,
since we do use the software ourselves and plan to continue using (and
improving) \fIMH\fR,
bug reports and their associated fixes should be reported back to us so that
we may include them in future releases.
The current computer mailbox for \fIMH\fR is \fBBug\[e-mail]\fR
(in the ARPA Internet),
and \fB...!ucbvax!ucivax!bug\-mh\fR (UUCP).
.PP
Presently,
there are two Internet discussion groups, \fBMH\[e-mail]\fR
and \fBMH\[e-mail]\fR.  \fBMH\-Workers\fP is for people
discussing code changes to \fIMH\fP.  \fBMH-Users\fP is for general
discussion about how to use \fIMH\fP.
\fBMH\-Users\fR is bi-directionally 
gatewayed into USENET as \fBcomp.mail.mh\fR.
.SH "HOW TO GET MH"
Since you probably already have \fIMH\fP,
you may not need to read this unless you suspect you have an old version.
There are two ways to get the latest release:
.PP
1.  If you can FTP to the ARPA Internet, use anonymous FTP to
ftp.ics.uci.edu [128.195.1.1] and retrieve the file pub/mh/mh-6.8.tar.Z.
This is a tar image after being run through the compress program
(approximately 1.8MB).  There should also be a \fBREADME\fR file in
that directory which tells what the current release of \fIMH\fP
is, and how to get updates.
.PP
This tar file is also available on louie.udel.edu 
[128.175.1.3] in portal/mh-6.8.tar.Z.  You may also find MH on
various other hosts; to make sure you get the latest version and
don't waste your time re-fixing bugs, it's best to get it from
either ftp.ics.uci.edu or louie.udel.edu.
.PP
2.  You can send $75 US to the address below.
This covers the cost of a 6250 BPI 9-track magtape,
handling, and shipping.  In addition, you'll get a
laser-printed hard-copy of the entire MH documentation set.  Be
sure to include your USPS address with your check.  Checks 
must be drawn on U.S\&. funds and should be made payable to:

.ti +1i
Regents of the University of California

The distribution address is:  

.nf
.RS 1i
Univeristy of California at Irvine
Office of Academic Computing
360 Computer Science
Irvine, CA  92717  USA

[phone]
.fi
.RE
.PP
Sadly, if you just want the hard-copies of the documentation, you
still have to pay the $75.  The tar image has the documentation
source (the manual is in roff format, but the rest are in TeX
format).  Postscript formatted versions of the TeX papers are 
available, as are crude tty-conversions of those papers.
.SH SYNOPSIS
MAKE
.SH DESCRIPTION
This is a description of how one can bring up an \fIMH\fR system.
It is assumed that you have super-user privileges in order to
(re\-)install \fIMH\fR.
Super-user privileges are not required to configure or generate \fIMH\fR.
.PP
Become the super-user and cd to /usr/src/local/
(or whatever you keep your local sources).
The distribution tape contains the hierarchy for the mh.6-8/ directory.
Bring the sources on-line:
.sp 1
.nf
# cd /usr/src/local
% tar xv
% cd mh-6.8
.fi
.SH CONFIGURATION
First, go to the conf/ directory.
.sp 1
.nf
% cd conf/
.fi
.sp 1
This directory contains files that will produce source files tailored
for your choice of \fIMH\fR configuration.
You should edit only the file \fBMH\fR.
This file contains configuration directives.
These configuration directives are read by the \fImhconfig\fR program to
produce customized files.
.sp
For examples of various configurations,
look in the directory \fBconf/examples/\fR.
The file \fBMH\fR provided in \fBconf/\fR is a reasonable default.
Lines beginning with `#' are comments, and are not otherwise interpreted.
.PP
Here are the \fIMH\fP configuration directives available.  Be sure
to read through this list completely before attempting to decide
what directives are appropriate for your system.  
.sp
More information on some of these options is available in the
the \fIAdministrator's Guide\fR.  If you do not have a printed
copy, you should configure your system with the default
configuration file, \fBMH\fP, then generate and print a copy
of the guide (as described below).
.in +.5i

.de Uh
.ti -.75i
.B "\\$1"
.ne 4
..
.Uh "Installation paths"
.ti -.5i
bin: /usr/local
.br
The directory where user\-invoked programs go (see manual section 1).

.ti -.5i
etc: /usr/local/lib/mh
.br
The directory where pgm\-invoked programs go (see manual section 8).

.ti -.5i
mail: /usr/spool/mail
.br
The directory where the maildrops are stored.
If this pathname is absolute (i.e., begins with a \fB/\fR\0),
then the user's maildrop is a file called \fB$USER\fR in this directory.
If the pathname is not absolute,
then the user's maildrop is in the user's home directory under the given name.

.ti -.5i
mandir: /usr/man
.br
The parent directory of the manual entries.

.ti -.5i
manuals: standard
.br
Where manual entries should be installed,
relative to the directory given with \*(lqmandir\*(rq.
Either \*(lqlocal\*(rq to install manual entries under \fBmanl/\fR,
or \*(lqnew\*(rq to install manual entries under \fBmann/\fR,
or \*(lqold\*(rq to install manual entries under \fBmano/\fR,
or \*(lqstandard\*(rq to install manual entries under \fBman?/\fR,
or \*(lqbsd44\*(rq to install manual entries as \fBman?/\fIpage\fP.0\fR,
or \*(lqgen\*(rq to generate but not install them,
or \*(lqnone\*(rq to neither generate nor install them.

Any of these values may have the suffix \*(lq/cat\*(rq appended 
to it.   In that case, the manual entries will be formatted
with \*(lqnroff -man\*(rq and they will be installed in the
corresponding \*(lqcat?\*(rq directories.

For example,
to install manual entries under \fB/usr/man/u_man/man?\fR,
use \*(lqstandard\*(rq and \fB/usr/man/u_man\fR for \*(lqmandir\*(rq.
To install formatted manual entires under \fB/usr/contrib/man/cat?\fR,
use \*(lqstandard/cat\*(rq and \fB/usr/contrib/man\fR for \*(lqmandir\*(rq.
To install formatted manual entries using the BSD44 convention,
use \*(lqbsd44/cat\*(rq.

.ti -.5i
chown: /etc/chown
.br
The location of the \fIchown\fR\|(8) on your system.
If \fIchown\fR is in your search path,
just use the value of \*(lqchown\*(rq.
On SYS5 systems,
this should probably be \*(lq/bin/chown\*(rq.

.ti -.5i
cp: cp
.br
The command to copy files when installing, if not \*(lqcp\*(rq.
(Some sites use \*(lqcp\0\-p\*(rq.)

.ti -.5i
ln: ln
.br
The command to link files together in the source tree, if not \*(lqln\*(rq.
If you're using something like \fBlndir\fP to keep
your compile tree separate from your source tree,
set this to \*(lqln\0\-s\*(rq or \*(lqcp\*(rq.

.ti -.5i
remove: mv \-f
.br
How \fIMH\fR should make backup copies
of existing files when installing new files.
To simply remove the old files, use \*(lqrm\0\-f\*(rq.

.Uh "Compiler/loader"
.ti -.5i
cc: cc
.br
The name of your C compiler, if not \*(lqcc\*(rq.

.ti -.5i
ccoptions: \-O
.br
Options given directly to \fIcc\fR\|(1).
The most common is \*(lq\-M\*(rq if you're running \fIMH\fR on an ALTOS.
This defaults to \*(lq\-O\*(rq.  If you define this and want to 
keep \*(lq\-O\*(rq, be sure to include it explicitly.
If you're using the \fIGNU\fP C compiler, it should
include `\-traditional'.  See \*(lqoptions:\*(rq for `\-D' options.

.ti -.5i
curses: \-lcurses\0\-ltermlib
.br
This should be the loader option required to load the \fItermcap\fR\|(3)
and \fIcurses\fR\|(3) libraries on your system.
On SYS5 systems, it probably should be just \*(lq\-lcurses\*(rq.
Some sites have reported that both \*(lq\-lcurses\*(rq and
\*(lq\-ltermlib\*(rq are necessary.

.ti -.5i
ldoptions: \-s
.br
Options given directly to \fIld\fR\|(1) (via \fIcc\fR\|) at the beginning
of the command line.
Useful for machines which require arguments to tell \fIld\fR to increase the
stack space (e.g. the Gould, which uses \*(lq\-m\08\*(rq).
Usually, \*(lq\-s\*(rq is a good choice in any event.

.ti -.5i
ldoptlibs:
.br
Options given directly to \fIld\fR\|(1) (via \fIcc\fR\|) at the end of the
command line.
The two most common are:
\*(lq\-ldbm\*(rq if you're running MMDF with the \fIdbm\fR package;
and, \*(lq\-lndir\*(rq if you are generating \fIMH\fR on a system
which does not load the new directory access mechanism by default
(e.g., 4.1BSD, SYS5).
If you don't have \fIlibndir\fR on your system,
the sources are in \fBmiscellany/libndir/\fR.

.ti -.5i
lex: lex \-nt
.br
Alternative version of \fIlex\fR.  Used in \fBzotnet/tws/\fR.

.ti -.5i
oldload: off
.br
This controls how \fIMH\fP will try to process library object files to
eliminate local symbols.
Support for the ALTOS loader if \*(lqon\*(rq.
Support for loaders not handling `\-x\0\-r' correctly if \*(lqnone\*(rq.

.ti -.5i
ranlib: on
.br
Support for systems with \fIranlib\fR\|(1).
For SYSTEM 5 systems,
this should be \*(lqoff\*(rq which tells \fIMH\fR to use \fIlorder\fR and
\fItsort\fR instead.
Some SYSTEM 5 sites reported that running this isn't always sufficient.
If this is the case,
then you should edit \fBconf/makefiles/uip\fR to include
\fB\&../sbr/libmh.a\fR and \fB../zotnet/libzot.a\fR twice in the LIBES
variable.

.Uh "Message Transport System"
.ti -.5i
mts: sendmail
.br
Which message transport system to use.
Either \*(lqmmdf\*(rq to use \fIMMDF\fR as the transport system,
\*(lqmmdf2\*(rq to use \fIMMDF\-II\fR as the transport system,
\*(lqsendmail\*(rq to have \fISendMail\fR as the transport system,
\*(lqzmailer\*(rq to have \fIZMAILER\fP as the transport system,
or, \*(lqmh\*(rq to have \fIMH\fR as the transport system.

On UNIX systems supporting TCP/IP networking via sockets
you can add the suffix \*(lq/smtp\*(rq to the mts setting.
This often yields a superior interface as \fIMH\fR will post mail with the
local \fISMTP\fR server instead of interacting directly with \fIMMDF\fR or
\fISendMail\fR.
Hence, for TCP/IP UNIX systems,
the \*(lq/smtp\*(rq suffix to either \*(lqsendmail\*(rq or \*(lqmmdf2\*(rq is
the preferred MTS configuration.
The \*(lq/smtp\*(rq suffix is described in detail in the \fIAdministrator's
Guide\fR; be sure to set \*(lqservers:\*(rq as described in
\fImh\-tailor\fR\|(8) if you use this option.

.ti -.5i
mf: off
.br
Support for mail filtering on those systems in which the message transport
system isn't integrated with \fIUUCP\fR 
This option is strictly for an \fIMH\fR system using either \fIMMDF\-I\fR
as its transport system or one using \*(lqstand\-alone delivery\*(rq.

.Uh "UCI BBoards Facility"
.ti -.5i
bboards: off
.br
If \*(lqon\*(rq, include support for the UCI BBoards facility.
BBoards may be enabled with any mts setting.
If \*(lqoff\*(rq, the BBoard reading program \fIbbc\fR will not be installed.
If \*(lqnntp\*(rq,
include support for the UCI BBoards facility to read the Network News
via the NNTP.
If \*(lqpop\*(rq (formerly \*(lqpopbboards:\0on\*(rq),
include support for the UCI BBoards facility via the POP3 service;
this setting requires \*(lqpop:\0on\*(rq.

.ti -.5i
bbdelivery: off
.br
If \*(lqoff\*(rq,
the BBoards delivery agent and library files will not be installed.
If 
\*(lqon\*(rq,
and you set \*(lqbboards:\*(rq to something besides \*(lqoff\*(rq,
then 
the BBoards delivery agent and library files will be installed
in the \fIbbhome\fR directory (see below).
To read remote BBoards,
the usual configuration would have \fIbbc\fR talk to a \fIPOP3\fR or
\fINNTP\fR server.
However, it may be useful to set this to \*(lqoff\*(rq if 
you NFS mount the \fIbbhome\fR directory from another host
and want to use \fIbbc\fR to read those files directly.

.ti -.5i
bbhome: /usr/spool/bboards
.br
The home directory for the BBoards user.

.Uh "Post Office Protocol"
.ti -.5i
pop: off
.br
Support for POP service.
This allows local delivery for non\-local users
(a major win).
See \fBsupport/pop/pop.rfc\fR for more information on the POP.
This option currently works only on UNIX systems with TCP/IP sockets.
(It doesn't hurt to enable this option regardless of whether or not
you intend to use POP.)  See also \*(lqbboards: pop\*(rq to enable
reading bboards with the POP.

.ti -.5i
popdir: /usr/etc
.br
The directory where the POP daemon (\fBpopd\fP) will be installed.

.ne 5
.ti -.5i
options:
.br
\&`\-D' options to \fIcc\fR\|(1).
.sp
.in +.25i
.ti -.5i
APOP='\*(lq/etc/pop.auth\*(rq'
.br
This option indicates that the POP daemon will
support the non-standard \fBAPOP\fP command,
and specifies the name of \fBAPOP\fP authorization database.
The \fBAPOP\fP
command provides a challenge-based authentication system using
the \fBMD5\fP message digest algorithm.
This facility is documented in 
\fIThe Internet Message\fR (ISBN 0\-13\-092941\-7), a book by Marshall T. Rose.
.sp
This option also causes the
\fBpopauth\fP program to be installed, which
allows the administrator to manipulate the \fBAPOP\fP
authorization database.
For more details, see \fBsupport/pop/pop-more.txt\fR
and the \fIAdministrator's Guide\fP.

.ti -.5i
DPOP
.br
This option indicates that POP subscribers do not have
entries in the \fIpasswd\fR\|(5) file,
and instead have their own separate database (a win).

.ti -.5i
KPOP
.br
Support for KERBEROS with POP.
This code builds
\fIpopd\fP, \fIinc\fP and \fImsgchk\fP to support only the 
\*(lqkpop\*(rq protocol.
This code is still experimental, but is available for 
those sites wishing to test it.

.ti -.5i
MPOP
.br
This option indicates that the POP daemon will
support the non-standard
\fBXTND SCAN\fP command which provides performance
enhancements when using the POP over low-speed connections.
This option also causes an interactive POP
client program, \fBpopi\fP, to be compiled and installed.
A man page for the \fBpopi\fP program is also provided.
.sp
These extensions are described in 
\fIThe Internet Message\fR, a book by Marshall T. Rose.
For more details, see \fBsupport/pop/pop-more.txt\fR.
\fBNote:\fP this option requires \*(lqbboards: pop\*(rq.

.ti -.5i
POP2
.br
Have the POP daemon understand the older
POP2 protocol as well as the \fIMH\fP POP3 protocol \- a major win.
The POP daemon auto-magically
determines which POP protocol your client is using.
If you're enabling POP service,
there's no reason not to enable this option as well.
See also \fIPOPSERVICE\fR.

.ti -.5i
POPSERVICE
.br
The port name the \fIMH\fP POP will use.  For historical reasons,
this defaults to \*(lqpop\*(rq.
.sp
In 1987, the \fIMH\fP POP protocol
(POP version 3) was published as RFC1081 and
was assigned its own port number (110),
which differs from the original POP (version 1 and 2) port number (109).