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