xref: /freebsd/usr.bin/mkdep/mkdep.1 (revision f247324df75b7f55b48b92acb3b42a5ae2deac8a)
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
48.Nm Mkdep
49takes a set of flags for the C compiler and a list
50of C source files as arguments and constructs a set of include
51file dependencies which are written into the file ``.depend''.
52An example of its use in a Makefile might be:
53.Bd -literal -offset indent
54CFLAGS= -O -I../include
55SRCS= file1.c file2.c
56
57depend:
58	mkdep ${CFLAGS} ${SRCS}
59.Ed
60.Pp
61where the macro SRCS is the list of C source files and the macro
62CFLAGS is the list of flags for the C compiler.
63.Pp
64The user has the ability to change the preprocessor and preprocessor options
65used.  For instance, to use gcc as the preprocessor and to ignore system
66headers, one would use
67.Bd -literal -offset indent
68depend:
69	env MKDEP_CPP="gcc -E" MKDEP_CPP_OPTS=-MM mkdep \\
70		${CFLAGS} ${SRCS}
71.Ed
72.Pp
73The options are as follows:
74.Bl -tag -width Ds
75.It Fl a
76Append to the output file,
77so that multiple
78.Nm Ns 's
79may be run from a single Makefile.
80.It Fl f
81Write the include file dependencies to
82.Ar file ,
83instead of the default ``.depend''.
84.It Fl p
85Cause
86.Nm
87to produce dependencies of the form:
88.Bd -literal -offset indent
89program: program.c
90.Ed
91.Pp
92so that subsequent makes will produce
93.Ar program
94directly from its C module rather than using an intermediate
95.Pa \&.o
96module.
97This is useful for programs whose source is contained in a single
98module.
99.El
100.Sh ENVIRONMENT
101.Bl -tag -width MKDEP_CPP_OPTS
102.It Ev CC
103Specifies the C compiler to use.  The specified compiler is expected to have
104options consistent with the GNU C compiler.
105.It Ev MKDEP_CPP
106Specifies the preprocessor to use.  The default is "${CC} -E".
107.It Ev MKDEP_CPP_OPTS
108Specifie the non-CFLAGS options for the preprocessor.  The default is
109"-M".
110.El
111.Sh SEE ALSO
112.Xr cc 1 ,
113.Xr cpp 1 ,
114.Xr make 1
115.Sh FILES
116.Bl -tag -width .depend -compact
117.It Pa .depend
118File containing list of dependencies.
119.El
120.Sh HISTORY
121The
122.Nm
123command appeared in
124.Bx 4.3 Tahoe .
125