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