usr.bin/fsplit/fsplit.1

   1 .\"     $NetBSD: fsplit.1,v 1.9 2003/08/07 11:13:50 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" Asa Romberger and Jerry Berkman.
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. 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 .\"     from: @(#)fsplit.1      8.1 (Berkeley) 6/6/93
  33 .\"
  34 .Dd June 6, 1993
  35 .Dt FSPLIT 1
  36 .Os
  37 .Sh NAME
  38 .Nm fsplit
  39 .Nd split a multi-routine Fortran file into individual files
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl e Ar efile
  43 \&...
  44 .Op Ar file
  45 .Sh DESCRIPTION
  46 .Nm
  47 takes as input either a file or standard input containing Fortran source code.
  48 It attempts to split the input into separate routine files of the
  49 form
  50 .Ar name.f ,
  51 where
  52 .Ar name
  53 is the name of the program unit (e.g. function, subroutine, block data or
  54 program).
  55 The name for unnamed block data subprograms has the form
  56 .Ar blkdtaNNN.f
  57 where NNN is three digits and a file of this name does not already exist.
  58 For unnamed main programs the name has the form
  59 .Ar mainNNN.f .
  60 If there is an error in classifying a program unit, or if
  61 .Ar name.f
  62 already exists,
  63 the program unit will be put in a file of the form
  64 .Ar zzzNNN.f
  65 where
  66 .Ar zzzNNN.f
  67 does not already exist.
  68 .Pp
  69 .Bl -tag -width Fl
  70 .It Fl e Ar efile
  71 Normally each subprogram unit is split into a separate file.
  72 When the
  73 .Fl e
  74 option is used, only the specified subprogram units are split into separate
  75 files.
  76 E.g.:
  77 .Pp
  78 .Dl fsplit -e readit -e doit prog.f
  79 .Pp
  80 will split readit and doit into separate files.
  81 .El
  82 .Sh DIAGNOSTICS
  83 If names specified via the
  84 .Fl e
  85 option are not found, a diagnostic is written to
  86 standard error.
  87 .Sh HISTORY
  88 The
  89 .Nm
  90 command
  91 appeared in
  92 .Bx 4.2 .
  93 .Sh AUTHORS
  94 Asa Romberger and Jerry Berkman
  95 .Sh BUGS
  96 .Nm
  97 assumes the subprogram name is on the first noncomment line of the subprogram
  98 unit.
  99 Nonstandard source formats may confuse
 100 .Nm .
 101 .Pp
 102 It is hard to use
 103 .Fl e
 104 for unnamed main programs and block data subprograms since you must
 105 predict the created file name.