Annotation of src/usr.bin/fsplit/fsplit.1, Revision 1.11
1.11 ! millert 1: .\" $OpenBSD: fsplit.1,v 1.10 2002/11/14 02:57:27 deraadt Exp $
1.1 deraadt 2: .\" $NetBSD: fsplit.1,v 1.3 1995/09/28 05:15:06 perry Exp $
3: .\"
4: .\" Copyright (c) 1983, 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" This code is derived from software contributed to Berkeley by
8: .\" Asa Romberger and Jerry Berkman.
9: .\" Redistribution and use in source and binary forms, with or without
10: .\" modification, are permitted provided that the following conditions
11: .\" are met:
12: .\" 1. Redistributions of source code must retain the above copyright
13: .\" notice, this list of conditions and the following disclaimer.
14: .\" 2. Redistributions in binary form must reproduce the above copyright
15: .\" notice, this list of conditions and the following disclaimer in the
16: .\" documentation and/or other materials provided with the distribution.
1.11 ! millert 17: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 18: .\" may be used to endorse or promote products derived from this software
19: .\" without specific prior written permission.
20: .\"
21: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31: .\" SUCH DAMAGE.
32: .\"
33: .\" from: @(#)fsplit.1 8.1 (Berkeley) 6/6/93
34: .\"
35: .Dd June 6, 1993
36: .Dt FSPLIT 1
1.5 aaron 37: .Os
1.1 deraadt 38: .Sh NAME
39: .Nm fsplit
40: .Nd split a multi-routine Fortran file into individual files
41: .Sh SYNOPSIS
42: .Nm fsplit
1.3 aaron 43: .Op Fl e Ar efile Op Ar ...
1.1 deraadt 44: .Op Ar file
45: .Sh DESCRIPTION
1.6 aaron 46: .Nm
1.1 deraadt 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
1.7 aaron 53: is the name of the program unit (e.g., function, subroutine, block data or
54: program).
55: .Pp
56: The name for unnamed block data subprograms has the form
57: .Ar blkdtaNNN.f ,
1.1 deraadt 58: where NNN is three digits and a file of this name does not already exist.
59: For unnamed main programs the name has the form
60: .Ar mainNNN.f .
61: If there is an error in classifying a program unit, or if
62: .Ar name.f
63: already exists,
64: the program unit will be put in a file of the form
1.7 aaron 65: .Ar zzzNNN.f ,
1.1 deraadt 66: where
67: .Ar zzzNNN.f
68: does not already exist.
1.7 aaron 69: .Pp
70: The options are as follows:
1.8 aaron 71: .Bl -tag -width Ds
1.5 aaron 72: .It Fl e Ar efile
1.7 aaron 73: Normally each subprogram unit is split into a separate file.
74: When the
1.1 deraadt 75: .Fl e
76: option is used, only the specified subprogram units are split into separate
1.7 aaron 77: files. e.g.,
1.1 deraadt 78: .Pp
1.10 deraadt 79: .Dl $ fsplit -e readit -e doit prog.f
1.1 deraadt 80: .Pp
1.7 aaron 81: will split
82: .Dq readit
83: and
84: .Dq doit
85: into separate files.
1.1 deraadt 86: .El
87: .Sh DIAGNOSTICS
88: If names specified via the
89: .Fl e
90: option are not found, a diagnostic is written to
91: standard error.
1.9 aaron 92: .Sh AUTHORS
93: Asa Romberger and Jerry Berkman
1.1 deraadt 94: .Sh HISTORY
95: The
1.6 aaron 96: .Nm
1.9 aaron 97: command appeared in
1.1 deraadt 98: .Bx 4.2 .
99: .Sh BUGS
1.6 aaron 100: .Nm
1.1 deraadt 101: assumes the subprogram name is on the first noncomment line of the subprogram
1.7 aaron 102: unit.
103: Non-standard source formats may confuse
1.1 deraadt 104: .Nm fsplit .
105: .Pp
106: It is hard to use
107: .Fl e
108: for unnamed main programs and block data subprograms since you must
109: predict the created file name.