xref: /openbsd/usr.bin/mkdep/mkdep.1 (revision 78b63d65)
1.\"	$OpenBSD: mkdep.1,v 1.5 2000/11/10 05:10:36 aaron Exp $
2.\"	$NetBSD: mkdep.1,v 1.3 1994/12/23 07:34:56 jtc Exp $
3.\"
4.\" Copyright (c) 1987, 1990, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     @(#)mkdep.1	8.1 (Berkeley) 6/6/93
36.\"
37.Dd June 6, 1993
38.Dt MKDEP 1
39.Os
40.Sh NAME
41.Nm mkdep
42.Nd construct Makefile dependency list
43.Sh SYNOPSIS
44.Nm mkdep
45.Op Fl ap
46.Op Fl f Ar file
47.Op Ar flags
48.Ar file Op Ar ...
49.Sh DESCRIPTION
50.Nm
51takes a set of flags for the C compiler and a list
52of C source files as arguments and constructs a set of include
53file dependencies which are written into the file
54.Pa .depend .
55An example of its use in a Makefile might be:
56.Bd -literal -offset indent
57CFLAGS= -O -I../include
58SRCS= file1.c file2.c
59
60depend:
61	mkdep ${CFLAGS} ${SRCS}
62.Ed
63.Pp
64where the macro SRCS is the list of C source files and the macro
65CFLAGS is the list of flags for the C compiler.
66.Pp
67The options are as follows:
68.Bl -tag -width Ds
69.It Fl a
70Append to the output file,
71so that multiple
72.Nm mkdep Ns 's
73may be run from a single Makefile.
74.It Fl f Ar file
75Write the include file dependencies to
76.Ar file ,
77instead of the default
78.Pa .depend .
79.It Fl p
80Cause
81.Nm
82to produce dependencies of the form:
83.Bd -literal -offset indent
84program: program.c
85.Ed
86.Pp
87so that subsequent makes will produce
88.Ar program
89directly from its C module rather than using an intermediate
90.Pa \&.o
91module.
92This is useful for programs whose source is contained in a single
93module.
94.El
95.Sh FILES
96.Bl -tag -width .depend -compact
97.It Pa .depend
98file containing list of dependencies
99.El
100.Sh SEE ALSO
101.Xr cc 1 ,
102.Xr cpp 1 ,
103.Xr make 1
104.Sh HISTORY
105The
106.Nm
107command appeared in
108.Bx 4.3 Tahoe .
109