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