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