xref: /dragonfly/usr.bin/mkdep/mkdep.1 (revision 0bb9290e)
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: src/usr.bin/mkdep/mkdep.1,v 1.7.2.7 2002/12/29 16:35:40 schweikh Exp $
34.\" $DragonFly: src/usr.bin/mkdep/mkdep.1,v 1.3 2006/02/17 19:39:09 swildner Exp $
35.\"
36.Dd June 6, 1993
37.Dt MKDEP 1
38.Os
39.Sh NAME
40.Nm mkdep
41.Nd construct Makefile dependency list
42.Sh SYNOPSIS
43.Nm
44.Op Fl ap
45.Op Fl f Ar file
46.Op Ar flags
47.Ar
48.Sh DESCRIPTION
49The
50.Nm
51utility takes a set of flags for the C compiler and a list
52of C source files as arguments and constructs a set of include
53file dependencies which are written into the file ``.depend''.
54An example of its use in a Makefile might be:
55.Bd -literal -offset indent
56CFLAGS= -O -I../include
57SRCS= file1.c file2.c
58
59depend:
60	mkdep ${CFLAGS} ${SRCS}
61.Ed
62.Pp
63where the macro SRCS is the list of C source files and the macro
64CFLAGS is the list of flags for the C compiler.
65.Pp
66The user has the ability to change the preprocessor and preprocessor options
67used.  For instance, to use gcc as the preprocessor and to ignore system
68headers, one would use
69.Bd -literal -offset indent
70depend:
71	env MKDEP_CPP="gcc -E" MKDEP_CPP_OPTS=-MM mkdep \\
72		${CFLAGS} ${SRCS}
73.Ed
74.Pp
75The options are as follows:
76.Bl -tag -width Ds
77.It Fl a
78Append to the output file,
79so that multiple
80.Nm Ns 's
81may be run from a single Makefile.
82.It Fl f
83Write the include file dependencies to
84.Ar file ,
85instead of the default ``.depend''.
86.It Fl p
87Cause
88.Nm
89to produce dependencies of the form:
90.Bd -literal -offset indent
91program: program.c
92.Ed
93.Pp
94so that subsequent makes will produce
95.Ar program
96directly from its C module rather than using an intermediate
97.Pa \&.o
98module.
99This is useful for programs whose source is contained in a single
100module.
101.El
102.Sh ENVIRONMENT
103.Bl -tag -width MKDEP_CPP_OPTS
104.It Ev CC
105Specifies the C compiler to use.  The specified compiler is expected to have
106options consistent with the GNU C compiler.
107.It Ev MKDEP_CPP
108Specifies the preprocessor to use.  The default is "${CC} -E".
109.It Ev MKDEP_CPP_OPTS
110Specifies the non-CFLAGS options for the preprocessor.  The 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