var/da/makedepf90-2.8.8/makedepf90.1

   1 .\"
   2 .\"    Copyright (C) 2000--2003 Erik Edelmann <eedelman@acclab.helsinki.fi>
   3 .\"
   4 .\"    This program is free software;  you  can  redistribute  it
   5 .\"    and/or modify it under the terms of the GNU General Public
   6 .\"    License version as published  by  the  Free  Software
   7 .\"    Foundation.
   8 .\"
   9 .\"    This program is distributed in the hope that  it  will  be
  10 .\"    useful, but WITHOUT ANY WARRANTY; without even the implied
  11 .\"    warranty of MERCHANTABILITY or FITNESS  FOR  A  PARTICULAR
  12 .\"    PURPOSE.   See  the  GNU  General  Public License for more
  13 .\"    details.
  14 .\"
  15 .\"    You should have received a copy of the GNU General  Public
  16 .\"    License along with this program; if not, write to the Free
  17 .\"    Software Foundation, Inc., 59  Temple  Place,  Suite  330,
  18 .\"    Boston, MA  02111-1307  USA
  19 .\"
  20 .\" $Format: ".TH makedepf90 1 \"$Date$\""$
  21 .TH makedepf90 1 "Thu, 06 Dec 2001 23:28:54 +0200"
  22
  23 .SH NAME
  24 makedepf90 \- creates Makefile dependency list for Fortran source files.
  25
  26 .SH SYNOPSIS
  27 .B makedepf90
  28 .RB [ \-h ]
  29 .RB [ \-V ]
  30 .RB [ \-W | -Wmissing ]
  31 .RB [ \-Wconfused ]
  32 .RB [ \-m
  33 .IR fmt ]
  34 .RB [ \-u
  35 .IR modulename ]
  36 .RB [ \-d
  37 .IR file ]
  38 .RB [ \-r
  39 .IR rule ]
  40 .RB [ \-R
  41 .IR "file rule" ]
  42 .RB [ \-fixed | \-free ]
  43 .RB [ \-o
  44 .IR "name-of-executable" ]
  45 .RB [ \-coco ]
  46 .RB [ \-D
  47 .IR NAME ]
  48 .RB [ \-b
  49 .IR "path" ]
  50 .RB [ \-I
  51 .IR "PATH1:PATH2:..." ]
  52 .RB [ \-nosrc ]
  53 .I sourcefile(s)
  54
  55 .SH DESCRIPTION
  56 .PP
  57 \fImakedepf90\fP is a program for automatic creation of dependency lists
  58 and compilation rules for Makefiles.
  59 .PP
  60 The original idea was to provide the same functionality for Fortran as
  61 .RS
  62 .PP
  63 .ft CW
  64 gcc -MM *.c
  65 .ft R
  66 .RE
  67 .PP
  68 does for C.  Nowadays makedepf90 actually supersedes this functionality,
  69 making me wonder if I should extend makedepf90 to support C and C++ too
  70 ;-).
  71 .PP
  72 \fImakedepf90\fP supports both \fBmodules\fP, \fBinclude\fP:s,
  73 \fBcpp\fP(1) \fB#include\fP:s, \fBf90ppr\fP(1) \fB$include\fP:s and
  74 \fBcoco\fP(1) \fB??includes\fP and set-files.
  75 .PP
  76 \fImakedepf90\fP reads Fortran source files given on the command line, and
  77 writes a dependency list to stdout; for every file it writes a line
  78 with the following format:
  79 .RS
  80 .PP
  81 .IR targets " : " prerequisites
  82 .RE
  83 .PP
  84 \fITargets\fP are the files that will be the result of compiling the file
  85 with the \fB-c\fP option, and \fIprerequisites\fP are files that are needed
  86 to compile the file.
  87 In addition, \fImakedepf90\fP can optionally create the dependency line and
  88 make-rule needed to link the final executable.
  89 .SS "Fortran dependencies"
  90 .PP
  91 The files needed to compile a file, i.e the \fIprerequisites\fP of the file
  92 are:
  93 .TP
  94 .B \(em
  95 The source file itself
  96 .TP
  97 .B \(em
  98 Files with interface information about USEd modules, created by the
  99 compiler while compiling the modules (often named \fImodulename\fP.mod or
 100 something similar, hereafter called \fImod-files\fP).
 101 .TP
 102 .B \(em
 103 Include-files (including files included and mod-files of modules USEd from
 104 these include-files).
 105 .TP
 106 .B \(em
 107 \fBCoco\fP set-files, if \fBcoco\fP(1) is being used and set-files exist.
 108 .PP
 109 Since different compilers use different naming conventions for the
 110 mod-files, listing them in the dependency list results in non-portable
 111 makefiles.  Therefore it's common practise to list the object file
 112 (\fIfilename\fP.o) corresponding to the sourcefile containing the USEd
 113 modules instead.  This is the default behaviour of
 114 \fImakedepf90\fP.  To change this, use the \fB\-m\fP option (e.g \fB\-m
 115 "%m.mod"\fP if your compiler names the mod files \fImodulename\fP.mod)
 116 .PP
 117 Include files not found in the working directory will not be listed in the
 118 dependency list, assuming they are part of a (seldom changing) library not
 119 part of the program.  Neither will mod-files of modules whose definitions
 120 aren't found be listed by the same reason.
 121
 122 .SH OPTIONS
 123 .PP
 124 These options may be given anywhere, in any order, on the command line.
 125 Space between an option and its argument is optional.  Options may not be
 126 grouped (\fB\-hW\fP is not the same thing as \fB\-h \-W\fP).
 127 .TP
 128 .BR \-h " or " \-\-help
 129 Print a short help message to stdout and quit.
 130 .TP
 131 .BR \-V " or " \-\-version
 132 Print version and copyright information to stdout and quit
 133 .TP
 134 .BR \-W " or " \-Wmissing
 135 Print warnings about missing modules and include files
 136 .TP
 137 .B \-Wconfused
 138 Print warnings when confused (either because of bugs in makedepf90 itself,
 139 or because of wierd things in your source files).  If makedepf90 misses
 140 some dependencies, or do other wierd things, this option might give some
 141 idea on whats going on.
 142 .TP
 143 .BI \-m " fmt"
 144 Tell \fImakedepf90\fP that mod-files will have names of the format
 145 \fIfmt\fP.  \fIfmt\fP may contain the modifiers \fB%f\fP for
 146 \fIfilename\fP (without file name .suffix), \fB%m\fP for \fImodulename\fP
 147 (in lowercase), \fB%M\fP for \fIMODULENAME\fP (in uppercase) and \fB%%\fP
 148 for '%'.  Default is "%f.o".
 149 .TP
 150 .BI \-u " modulename"
 151 Ignore all modules named \fImodulename\fP.
 152 .TP
 153 .BI \-d " file"
 154 Make all targets dependent on \fIfile\fP.
 155 .TP
 156 .BI \-r " rule"
 157 Add \fIrule\fP (indented by a tab) to all dependency lines except lines
 158 given rule(s) with the \fB\-R\fP option.
 159 .PP
 160 .RS +7
 161 \fIrule\fP may contains the following modifiers: \fB%f\fP for the name of
 162 the source file (without suffix) the dependency line is created for, and \fB%%\fP for '%'.
 163 .RS -7
 164 .TP
 165 .BI \-R " 'pattern' 'rule'"
 166 Compile files matching the shell pattern \fIpattern\fP using the rule \fIrule\fP.
 167 In \fIpattern\fP, the following wildcards can be used: \fB*\fP = any number
 168 of any characters, \fB?\fP = any character and \fB[abc]\fP = any of
 169 \fBa\fP, \fBb\fP or \fBc\fP.  Note that the patter-matching is to be
 170 performed by \fImakedepf90\fP, not the shell.  Therefore \fIpattern\fP
 171 should be enclosed in quotes (\fB"\fP or \fB'\fP).  For \fIrule\fP applies
 172 the same rules as for \fB\-r\fP above.
 173 .PP
 174 .RS +7
 175 Note that there is a subtle difference between "\fB\-r\fP \fIrule\fP" and
 176 "\fB\-R\fP '*' \fIrule\fP".  In the former case \fIrule\fP will be applied
 177 only to lines not given any rule using \fB\-R\fP, while in the latter case,
 178 \fIrule\fP will be applied to \fIall\fP lines.
 179 .RS -7
 180 .TP
 181 .BR \-fixed " / " \-free
 182 Treat the files as fixed/free source format.  If both options are given,
 183 the latter is used.  Default: Files with suffixes
 184 .BR ".f, .F, .for, .FOR " or " .ftn"
 185 are treated as fixed format and
 186 .BR ".f90, .F90, .f95 " or " .F95"
 187 are treated as free format.
 188 .TP
 189 .BI \-o " name"
 190 This option will cause \fImakedepf90\fP to define the Makefile macro
 191 \fBFOBJ\fP=\fIobjectfiles\fP, and a dependency line + rule for the final linking
 192 process to create the executable \fIname\fP.  To set the linking rule, use
 193 the option \fB\-l\fP.
 194 .TP
 195 .BI \-l " rule"
 196 Use \fIrule\fP when linking the executable.  The default is
 197 .br
 198 \fB$(FC) -o $@ $(FFLAGS) $(LDFLAGS) $(FOBJ) $(LIBS)\fP.
 199 .br
 200 This option has no effect unless \fB\-o\fP is used.
 201 .TP
 202 .B \-coco
 203 Look for \fBcoco\fP(1) set-files (\fBcoco\fP ??include:s are supported
 204 automatically).  This option implies \fB\-free\fP.
 205 .TP
 206 .BI \-D " NAME"
 207 Define the pre-processor symbol \fINAME\fP.
 208 .TP
 209 .BI \-b " path"
 210 Dependency tree and link rule will assume objects are placed in \fIpath\fP.
 211 This is useful if the build places object files in a different directory than
 212 the source files.
 213 .TP
 214 .BI \-I " list-of-paths"
 215 Look for source/include files in the \fIlist-of-paths\fP, if not found in
 216 current working directory.  Here, \fIlist-of-paths\fP is a colon separated
 217 list of path names.
 218 .TP
 219 .B \-nosrc
 220 Don't list the source file among the prerequisites.
 221
 222 .SH "EXAMPLES"
 223 .SS "Basic Usage"
 224 Here's an example of basic \fImakedepf90\fP usage together with
 225 \fBmake\fP(1).  Create a file named \fBMakefile\fP with the following
 226 contents:
 227 .PP
 228 .ft CW
 229 ----------------------
 230
 231  # FC = the compiler to use
 232  FC=f90
 233 .br
 234
 235  # Compiler options
 236  FFLAGS=\-O
 237 .br
 238
 239  # List libraries used by the program here
 240  LIBS=
 241
 242  # Suffix-rules:  Begin by throwing away all old suffix-
 243  # rules, and then create new ones for compiling
 244  # *.f90-files.
 245  .SUFFIXES:
 246  .SUFFIXES: .f90 .o
 247
 248  .f90.o:
 249 .br
 250         $(FC) \-c $(FFLAGS) $<
 251
 252  # Include the dependency-list created by makedepf90 below
 253  include .depend
 254
 255  # target 'clean' for deleting object- *.mod- and other
 256  # unwanted files
 257  clean:
 258 .br
 259         rm \-f *.o *.mod core
 260 .br
 261
 262  # Create a dependency list using makedepf90.  All files
 263  # that needs to be compiled to build the program,
 264  # i.e all source files except include files, should
 265  # be given on the command line to makedepf90.
 266  #
 267  # The argument to the '\-o' option will be the name of the
 268  # resulting program when running 'make', in this case
 269  # 'foobar'
 270  depend .depend:
 271 .br
 272         makedepf90 \-o foobar *.f90 > .depend
 273
 274 -----------------------
 275 .ft R
 276 .PP
 277 (Note that all the indented lines should be indented with tabs, not spaces)
 278 .PP
 279 With this makefile, the command \fBmake\fP should perform all the commands
 280 needed to compile and link the program \fIfoobar\fP out of all *.f90 files
 281 in the working directory.
 282 .PP
 283 The dependency list \fI.depend\fP will be (re)created if \fI.depend\fP
 284 doesn't exist, or if the command \fBmake depend\fP is run.
 285 This should be done every time changes has been made to the program that
 286 affect the dependencies of the files (e.g if new source files has been
 287 added to the project).
 288 .SS "Example With Coco"
 289 If you are using a pre-processor, things might get more complicated.  If
 290 you are lucky, your compiler supports your pre-processor and runs it on
 291 your code automatically, but if it doesn't, you have to give the commands
 292 to run the pre-processor yourself.  Below is an example of an Makefile for
 293 \fBcoco\fP(1)-users.
 294 .PP
 295 .ft CW
 296 -----------------------
 297  FC=f90
 298 .br
 299  FFLAGS=\-O
 300 .br
 301  PREPROCESSOR=coco
 302 .br
 303
 304  .SUFFIXES:
 305  .SUFFIXES: .f .f90 .o
 306
 307  # Files ending in .f90 are compiled directly ...
 308  .f90.o:
 309 .br
 310         $(FC) \-c $(FFLAGS) $<
 311
 312  # ... while those ending in .f are preprocessed first.
 313  .f.o:
 314 .br
 315         $(PREPROCESSOR) $*; $(FC) \-c $(FFLAGS) $*.f90
 316
 317
 318  include .depend
 319
 320  clean:
 321 .br
 322         rm \-f *.o *.mod core
 323
 324  depend .depend:
 325 .br
 326         makedepf90 \-coco \-o foobar *.f90 *.f > .depend
 327
 328 -----------------------
 329 .ft R
 330 .PP
 331 .B NOTE:
 332 Some implementations of
 333 .BR make (1)
 334 will not execute any commands \(em not even \fBmake depend\fP \(em with the
 335 Makefiles above unless there exists a file named \fI.depend\fP. To overcome
 336 this problem, either run \fImakedepf90\fP manually, or begin by creating an
 337 empty
 338 .I .depend
 339 file with the command \fBtouch .depend\fP.
 340
 341 .SH DIAGNOSTICS
 342 .PP
 343 Most error and warning messages are self explanatory, but some of them might
 344 need some further explanations:
 345 .TP
 346 .BI "WARNING: recursion limit reached in file " filename
 347 When recursively parsing include files, makedepf90 has reached the
 348 recursion limit.  Possible reasons are: either you have some
 349 \fIreally\fP complicated systems of include files, or you have
 350 recursive includes (e.g an include file that includes itself).  In the
 351 latter case; fix it, your Fortran compiler will not like it either.
 352
 353 .SH "BUGS AND LIMITATIONS"
 354 .PP
 355 Makedepf90's support for pre processor conditionals and macro expension
 356 (#if:s, #define:s etc) is rather weak, but should work well enough for most
 357 cases.
 358
 359 The include file search algorithm is broken.  I may fix it some day.
 360
 361 .SH "SEE ALSO"
 362 .BR make (1),
 363 .BR f90 (1),
 364 .BR cpp (1),
 365 .BR fpp (1),
 366 .BR f90ppr (1),
 367 .BR coco (1)
 368 .PP
 369 The makedepf90 web site is found at
 370 .br
 371 .UR
 372 http://www.iki.fi/erik.edelmann/makedepf90
 373 .UE
 374
 375
 376 .SH COPYING
 377 .PP
 378 This program is free software; you can redistribute it and/or
 379 modify it under the terms of the GNU General Public License version 2 as
 380 published by the Free Software Foundation.
 381 .PP
 382 This program is distributed in the hope that it will be useful, but
 383 WITHOUT ANY WARRANTY; without even the implied warranty of
 384 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 385 General Public License for more details.
 386 .PP
 387 You should have received a copy of the GNU General Public License
 388 along with this program; if not, write to the Free Software
 389 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 390
 391 .SH AUTHOR
 392 Erik Edelmann <Erik.Edelmann@iki.fi>