BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / mkdep / mkdep.1

diff --git a/usr/src/usr.bin/mkdep/mkdep.1 b/usr/src/usr.bin/mkdep/mkdep.1
index 99d8569..2c45968 100644 (file)
--- a/usr/src/usr.bin/mkdep/mkdep.1
+++ b/usr/src/usr.bin/mkdep/mkdep.1
@@ -1,32 +1,103 @@
-.\" Copyright (c) 1987 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1987, 1990 The Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)mkdep.1     5.3 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH MKDEP 1 ""
-.UC 5
-.SH NAME
-mkdep \- construct Makefile dependency list
-.SH SYNOPSIS
-.B mkdep
-flags file ...
-.SH DESCRIPTION
-\fIMkdep\fP takes a set of flags for the C compiler and a list of C
-sources as arguments and constructs a set of include file dependencies.
-It attaches this dependency list to the end of the file \fIMakefile\fP.
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)mkdep.1    5.13 (Berkeley) 6/2/91
+.\"
+.Dd June 2, 1991
+.Dt MKDEP 1
+.Os BSD 4.2
+.Sh NAME
+.Nm mkdep
+.Nd construct Makefile dependency list
+.Sh SYNOPSIS
+.Nm mkdep
+.Op Fl ap
+.Op Fl f Ar file
+.Op Ar flags
+.Ar file ...
+.Sh DESCRIPTION
+.Nm Mkdep
+takes a set of flags for the C compiler and a list
+of C source files as arguments and constructs a set of include
+file dependencies which are written into the file ``.depend''.

 An example of its use in a Makefile might be:
 An example of its use in a Makefile might be:

-.nf
-.RS
-
-CFLAGS= -I../include -I.
+.Bd -literal -offset indent
+CFLAGS= -O -I../include

 SRCS= file1.c file2.c
 
 depend:
        mkdep ${CFLAGS} ${SRCS}
 SRCS= file1.c file2.c
 
 depend:
        mkdep ${CFLAGS} ${SRCS}

-.RE
-.PP
+.Ed
+.Pp

 where the macro SRCS is the list of C source files and the macro
 CFLAGS is the list of flags for the C compiler.
 where the macro SRCS is the list of C source files and the macro
 CFLAGS is the list of flags for the C compiler.

-.SH "SEE ALSO"
-cc(1), make(1)
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl a
+Append to the output file,
+so that multiple
+.Nm mkdep Ns 's
+may be run from a single Makefile.
+.It Fl f
+Write the include file dependencies to 
+.Ar file ,
+instead of the default ``.depend''.
+.It Fl p
+Cause
+.Nm mkdep
+to produce dependencies of the form:
+.Bd -literal -offset indent
+program: program.c
+.Ed
+.Pp
+so that subsequent makes will produce
+.Ar program
+directly from its C module rather than using an intermediate
+.Pa \&.o
+module.
+This is useful for programs whose source is contained in a single
+module.
+.El
+.Sh SEE ALSO
+.Xr cc 1 ,
+.Xr cpp 1 ,
+.Xr make 1
+.Sh FILES
+.Bl -tag -width .depend -compact
+.It Pa .depend
+File containing list of dependencies.
+.El
+.Sh HISTORY
+The
+.Nm mkdep
+command appeared in
+.Bx 4.3 Tahoe .