5 .\" (c) 2015 Straylight/Edgeware
8 .\"----- Licensing notice ---------------------------------------------------
10 .\" This file is part of the Sensible Object Design, an object system for C.
12 .\" SOD is free software; you can redistribute it and/or modify
13 .\" it under the terms of the GNU General Public License as published by
14 .\" the Free Software Foundation; either version 2 of the License, or
15 .\" (at your option) any later version.
17 .\" SOD is distributed in the hope that it will be useful,
18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 .\" GNU General Public License for more details.
22 .\" You should have received a copy of the GNU General Public License
23 .\" along with SOD; if not, write to the Free Software Foundation,
24 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 .\"--------------------------------------------------------------------------
27 .so ../common/defs.man \" @@@PRE@@@
29 .\"--------------------------------------------------------------------------
30 .TH sod 1 "11 October 2015" "Straylight/Edgeware" "Sensible Object Design"
33 sod \- Sensible Object Design translator
35 .\"--------------------------------------------------------------------------
48 .\"--------------------------------------------------------------------------
53 program reads input files describing Sod modules,
54 containing class definitions and other items,
55 and generates output files,
56 such as C source and header files.
59 The following command-line options are recognized.
62 Write command-line help text to standard output,
63 and exit successfully.
66 Write Sod's version number to standard output,
67 and exit successfully.
70 Write a brief usage message to standard output,
71 and exit successfully.
74 Generate a Lisp stack backtrace if an error is encountered.
75 This is useful when debugging,
78 reports unusual errors, or
79 is complaining unjustifiably about something.
82 Generate output for to the built-in module,
83 which defines the root classes
87 For the purpose of naming output files,
88 the built-in module is named
91 .BI "\-I, \-\-include=" dir
92 Look for imported modules and extension files in directory
94 This option may be repeated:
95 directories are searched in the order they were named.
97 .BI "\-d, \-\-directory=" dir
98 Write output files to directory
100 instead of the current directory.
103 Write output to standard output,
106 .BI "\-t, \-\-type=" out-type
107 Produce output of type
109 Output types can be defined by extensions.
110 The built-in output types are described below.
114 file named on the command-line
115 is read and parsed as a Sod module:
118 for the built-in syntax.
119 An output file is written for each module read,
120 and the built-in module if the
123 and for each output type requested using the
126 At least one output type must be provided.
129 If a module is read from a file named
133 doesn't contain a dot
135 or if the file has a simple
137 which doesn't contain a dot
138 (except possibly an initial one),
139 then the module's name is
141 It is conventional for module files to be named
143 Output file names are determined by the module name,
145 and the output directory
151 The following output types are defined.
155 suitable for standalone compilation,
156 defining the necessary direct and effective method functions
158 for the classes defined in the module.
159 The output file is named
160 .IB dir / name .c \fR.
163 Write a C header file,
164 suitable for inclusion using
166 declaring the necessary data structures and functions
167 for the classes defined in the module.
168 The output file is named
169 .IB dir / name .h \fR.
171 .\"--------------------------------------------------------------------------
177 .\"--------------------------------------------------------------------------
179 Mark Wooding, <mdw@distorted.org.uk>
181 .\"----- That's all, folks --------------------------------------------------