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