xref: /freebsd/usr.bin/mkdep/mkdep.1 (revision 0957b409)
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.\" $FreeBSD$
30.\"
31.Dd October 23, 2015
32.Dt MKDEP 1
33.Os
34.Sh NAME
35.Nm mkdep
36.Nd construct Makefile dependency list
37.Sh SYNOPSIS
38.Nm
39.Op Fl ap
40.Op Fl f Ar file
41.Op Ar flags
42.Ar
43.Sh DESCRIPTION
44The
45.Nm
46utility takes a set of flags for the C compiler and a list
47of C source files as arguments and constructs a set of include
48file dependencies which are written into the file ``.depend''.
49An example of its use in a Makefile might be:
50.Bd -literal -offset indent
51CFLAGS= -O -I../include
52SRCS= file1.c file2.c
53
54depend:
55	mkdep ${CFLAGS} ${SRCS}
56.Ed
57.Pp
58where the macro SRCS is the list of C source files and the macro
59CFLAGS is the list of flags for the C compiler.
60.Pp
61The user has the ability to change the preprocessor and preprocessor options
62used.
63For instance, to use
64.Sy cc
65as the preprocessor and to ignore system
66headers, one would use
67.Bd -literal -offset indent
68depend:
69	env MKDEP_CPP="cc -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.
104The specified compiler is expected to have
105options consistent with the GNU C compiler.
106The default is
107.Sy cc .
108.It Ev MKDEP_CPP
109Specifies the preprocessor to use.
110The default is "${CC} -E".
111.It Ev MKDEP_CPP_OPTS
112Specifies the non-CFLAGS options for the preprocessor.
113The default is
114"-M".
115.El
116.Sh FILES
117.Bl -tag -width .depend -compact
118.It Pa .depend
119File containing list of dependencies.
120.El
121.Sh SEE ALSO
122.Xr cc 1 ,
123.Xr cpp 1 ,
124.Xr make 1
125.Sh HISTORY
126The
127.Nm
128command appeared in
129.Bx 4.3 Tahoe .
130