1falconeer.fal(1)              Falcon User Manuals             falconeer.fal(1)
2
3
4

NAME

6       falconeer.fal - Falcon skeleton module startup configurator script
7
8

SYNOPSIS

10       falconeer.fal -n moduleName [options]
11
12

DESCRIPTION

14       The  falconeer.fal  script configures a directory containing the Falcon
15       Skeleton Module so that it becomes ready for compilation under all  the
16       systems supported by Falcon.
17
18       Although not mandatory, a developer willing to write native modules for
19       Falcon may use this facility to speed up the startup  phase  and  begin
20       with an already compilable module.
21
22       The configuration consists in the renaming of the module files into the
23       module name specified in the command line, and in  the  update  of  the
24       makefiles  and project files provided for the various development plat‐
25       form Falcon can be built on.
26
27       Other than the project name,  the  script  allows  to  configure  other
28       options,  that  will affect the template variables that will be substi‐
29       tuted in the modified files.
30
31       Once configured and built,  the  skeleton  module  provides  already  a
32       skeleton()  symbol  that  is  exported  to  the  VM, and a service that
33       exports that function (defined in the  fskelmod_mod.cpp  file)  to  C++
34       applications.
35
36

OPTIONS

38       -a <author>
39              Specifies the author name.
40
41
42       -c "<copyright owner>"
43              Indicates  the copyright owner, if different from the author, to
44              be set on the copyright line, right beside the copyright year.
45
46
47       -d <Description>
48              Sets a brief description of the project.
49
50
51       -l <File>
52              Loads a license plate (a long statement indicating  the  license
53              under  which the files are distributed) from a template file. If
54              not given, the standard FPLL license plate  is  applied  to  the
55              generated files.
56
57
58       -n <name>
59              Sets  the  (short)  name  of  the project. Files will be renamed
60              accordingly to this value, and also the final module  name  will
61              be configured using this setting.
62
63
64       -p <name>
65              Sets  the  main  project  hood  under which the file is created.
66              Usually, modules are part of wider projects, or can be  distrib‐
67              uted  as sets. If not set, the text "The Falcon Programming Lan‐
68              guage" will be used instead.
69
70

BUGS

72       The file version.h cannot currently be properly configured. Edit it  by
73       hand.
74
75

NOTES

77       On some systems, falconeer.fal script can be "proxied" with a falconeer
78       pseudo command (shell script, batch file and so on).
79
80

AUTHOR

82       Giancarlo Niccolai <gc@falconpl.org>
83
84

SEE ALSO

86       falcon(1)
87
88

LICENSE

90       This document is released under the "GNU  Free  Documentation  License,
91       version  1.2".   On Debian systems, the complete text of the Free Docu‐
92       mentation  License,  version  1.2,  can  be  found  in  /usr/share/com‐
93       mon-licenses/.
94
95
96
97
98Falcon toolset                     July 2007                  falconeer.fal(1)
Impressum