xref: /netbsd/usr.bin/fsplit/fsplit.1 (revision bf9ec67e)
1.\"	$NetBSD: fsplit.1,v 1.6 2001/12/01 16:43:14 wiz 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. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"	from: @(#)fsplit.1	8.1 (Berkeley) 6/6/93
37.\"
38.Dd June 6, 1993
39.Dt FSPLIT 1
40.Os
41.Sh NAME
42.Nm fsplit
43.Nd split a multi-routine Fortran file into individual files
44.Sh SYNOPSIS
45.Nm
46.Op Fl e Ar efile
47\&...
48.Op Ar file
49.Sh DESCRIPTION
50.Nm
51takes as input either a file or standard input containing Fortran source code.
52It attempts to split the input into separate routine files of the
53form
54.Ar name.f ,
55where
56.Ar name
57is the name of the program unit (e.g. function, subroutine, block data or
58program).  The name for unnamed block data subprograms has the form
59.Ar blkdtaNNN.f
60where NNN is three digits and a file of this name does not already exist.
61For unnamed main programs the name has the form
62.Ar mainNNN.f .
63If there is an error in classifying a program unit, or if
64.Ar name.f
65already exists,
66the program unit will be put in a file of the form
67.Ar zzzNNN.f
68where
69.Ar zzzNNN.f
70does not already exist.
71.Pp
72.Bl -tag -width Fl
73.It Fl e Ar efile
74Normally each subprogram unit is split into a separate file.  When the
75.Fl e
76option is used, only the specified subprogram units are split into separate
77files.  E.g.:
78.Pp
79.Dl fsplit -e readit -e doit prog.f
80.Pp
81will split readit and doit into separate files.
82.El
83.Sh DIAGNOSTICS
84If names specified via the
85.Fl e
86option are not found, a diagnostic is written to
87standard error.
88.Sh HISTORY
89The
90.Nm
91command
92appeared in
93.Bx 4.2 .
94.Sh AUTHORS
95Asa Romberger and Jerry Berkman
96.Sh BUGS
97.Nm
98assumes the subprogram name is on the first noncomment line of the subprogram
99unit.  Nonstandard source formats may confuse
100.Nm "" .
101.Pp
102It is hard to use
103.Fl e
104for unnamed main programs and block data subprograms since you must
105predict the created file name.
106