2011-08-04 21:30:37 +00:00
|
|
|
|
FCC(1) C++ Development Tools FCC(1)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[1mNAME[0m
|
|
|
|
|
fcc is a tool to rapidly generate the basic framework of C++ class and
|
|
|
|
|
components. fcc can generate inline files, testing components, and
|
|
|
|
|
basic copyright notices.
|
|
|
|
|
|
|
|
|
|
[1mSYNOPSIS[0m
|
|
|
|
|
fcc [1m-class [4m[22mlist[24m [4mof[24m [4mclass[24m [4mnames[24m [1m-author [4m[22mauthor's[24m [4mname[24m [[1m-namespace [4m[22mnames-[0m
|
|
|
|
|
[4mpace_name[24m] [[1m-overwrite[22m] [[1m-verbose[22m] [[1m-no_unit_test[22m] [[1m-no_makefile[22m]
|
|
|
|
|
[[1m-project [4m[22mproject_name[24m] [[1m-sccs_keywords[22m] [[1m-continuus_keywords[22m]
|
|
|
|
|
[[1m-open_source_notice[22m] [[1m-copyright [22m[[4mcopyright[24m]] [[1m-base_filename[0m
|
|
|
|
|
[4mbase_filename[24m] [[1m-no_copy_ctor[22m] [[1m-no_assignment_operator[22m] [[1m-no_ctor[22m]
|
|
|
|
|
[[1m-no_dtor[22m] [[1m-public_copy_ctor[22m] [[1m-public_assignment_operator[22m]
|
|
|
|
|
[[1m-no_dump_diagnostics[22m] [[1m-no_check_valid[22m] [[1m-no_icc[22m] [[1m-settings_file[0m
|
|
|
|
|
[4mfilename[24m]
|
|
|
|
|
|
|
|
|
|
[1mDESCRIPTION[0m
|
|
|
|
|
fcc takes the name of one or more classes and generates the appropriate
|
|
|
|
|
code and header files for those classes. By default, it includes a con-
|
|
|
|
|
structor, destructor, private copy constructor, private assignment
|
|
|
|
|
operator, unit testing, and appropriate inlines. It also generates a
|
|
|
|
|
raw BSD-style makefile.
|
|
|
|
|
|
|
|
|
|
[1mOPTIONS[0m
|
|
|
|
|
[1m-class [4m[22mlist[24m [4mof[24m [4mclass[24m [4mnames[0m
|
|
|
|
|
Names of classes to be generated. The files will be named after
|
|
|
|
|
the first class name on the list. Class names must be separated
|
|
|
|
|
by whitespace.
|
|
|
|
|
|
|
|
|
|
[1m-author [4m[22mauthor's[24m [4mname[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Your name here.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-namespace [4m[22mnamespace[24m [4mname[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Wrap the output in a specified namespace.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-verbose[0m
|
|
|
|
|
Explain in excruciating detail what the program is doing.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_unit_test[0m
|
|
|
|
|
Do not generate unit-testing definitions in the source files.
|
|
|
|
|
This is an empty method; it's up to the user to define appropri-
|
|
|
|
|
ate tests.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_makefile[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Do not generate a makefile for this code.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-project [4m[22mproject_name[0m
|
|
|
|
|
Define a project for this makefile. Right now this option does
|
|
|
|
|
nothing.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-sccs_keywords[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Generate IDs appropriate to SCCS.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-continuus_keywords[0m
|
|
|
|
|
Generate keywords for the Continuus Version System.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-open_source_notice[0m
|
|
|
|
|
Add some comments about how this code is open source and per-
|
|
|
|
|
mission to copy in granted yadda yadda...
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-copyright [22m[[4mcopyright[24m]
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Adds your copyright notice to the code.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-base_filename [4m[22mbase_filename[0m
|
|
|
|
|
Set the name of the files output. Defaults to first class name
|
|
|
|
|
listed if not set.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_copy_ctor[0m
|
|
|
|
|
Do not provide a copy constructor in the output code.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_assignment_operator[0m
|
|
|
|
|
Do not provide an assignment operator in the output code.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_ctor[0m
|
|
|
|
|
Do not provide a default constructor in the output code.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_dtor[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Do not provide a destructor in the output code.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-public_copy_ctor[0m
|
|
|
|
|
Put the copy constructor in the public section instead of the
|
|
|
|
|
private section.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-public_assignment_operator[0m
|
|
|
|
|
Put the assignment operator in the public section instead of
|
|
|
|
|
the private section.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_dump_diagnostics[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Do not provide a debugging method.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_check_valid[0m
|
|
|
|
|
Do not provide a Programming By Contract style method to check
|
|
|
|
|
for invariants.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-no_icc[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Do not provide a file for class inlines.
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1m-settings_file [4m[22mfilename[0m
|
|
|
|
|
Get options from a settings file. Right now this option does
|
|
|
|
|
nothing.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1mREQUIREMENTS[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Python fcc requires Python version >= 2.0
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1mVERSION[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Version: 0.8a of May 5, 2001
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1mLICENSE AND COPYRIGHT[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Copyright
|
|
|
|
|
(C)2001, Elf M. Sternberg
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1melf.sternberg@gmail.com[0m
|
|
|
|
|
[1mhttp://elfsternberg.com[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
|
|
|
|
License
|
2011-08-04 21:30:37 +00:00
|
|
|
|
This program can be redistributed and/or modified under the
|
|
|
|
|
terms of the GNU Public License. See the file COPYING or visit
|
|
|
|
|
[1mhttp://www.gnu.org/copyleft/gpl.html [22mfor terms of use and dis-
|
|
|
|
|
tribution.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
Misc If you find this software useful, please drop me some email
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
Misc This man page was generated using latex2man by Dr. Jurgen
|
|
|
|
|
Vollmer, and is available from the CTAN archives.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
[1mAUTHOR[0m
|
2010-10-26 00:09:58 +00:00
|
|
|
|
Elf M. Sternberg
|
2011-08-04 21:30:37 +00:00
|
|
|
|
Email: [1melf.sternberg@gmail.com[0m
|
|
|
|
|
WWW: [1mhttp://elfsternberg.com[22m.
|
2010-10-26 00:09:58 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2011-08-04 21:30:37 +00:00
|
|
|
|
C++ Development Tools 04 August 2011 FCC(1)
|