Program template version 0.1.1

Initial revision 2003-08-16; Last revision 2004-05-31

1  Download

Win9x-EXE (minGW cross-compiled): mingw/template.zip [17 Kb ]

2  File readme

template --- template program in C


SUPPORTED ENVIRONMENTS

http://www.gnu.org    GNU/Linux 
http://www.mingw.org  MinGW --- Minimalist GNU For Windows


COMPILATION

Enter make (or gmake) in the directory where sources reside


BRIEF INSTRUCTION

This program provides the basic code for applications with "good"
command line interface (long/short options, short/long help screen). 

To instantiate your program, copy the source files to the directory,
where the new project will reside (say, fortytwo). Now type in

$ cd fortytwo
$ ./replace.pl fortytwo

to replace all instances of word "template" into "fortytwo" in all
files in the directory fortytwo.

This program also contain several macroses, simplifying programming:

Memory management (exits the program if NULL was returned):

TRY_MALLOC_TYPE(addr,size,type)
TRY_MALLOC(addr,size)
TRY_MALLOC_CHAR(addr,size)
FREE_IF_NON_NULL(a) if(a!=NULL) (free(a), a=NULL)

REPORTSTR(addr)

Simpliest operations over zero-tailored strings (with automatic
allocation of necessary memory):

STRDUP(addr,str)
DECLARE_STRING(var,static)
STRCAT(var,src)
STRCPY(var,src)

Converting macroses values to strings:
_XSTR(x)

This program should not be used on its own.

License conditions are described in file LICENSE.txt

3  Usage and options summary

user@computer$ ./template --help
Usage: template [OPTION]... FILE
Output file: FILE.template
  -q, --quiet             do not send any messages to stderr
  -h, --help              display this help and exit
  -m, --man               display complete description
  -v, --version           display version and exit

4  Project revision history

2003-08-16

2003-08-19

2003-09-28

2003-10-02

2003-10-21

2003-11-30

2004-02-01

2004-05-31

5  License

Available at http://www.math.toronto.edu/dkhmelev/PROGS/

Author:

Dmitry V. Khmelev dkhmelev((at))math.toronto.edu [change ((at)) to @ in order to get proper address - antispam]

University of Toronto, Department of Mathematics, 100 St George Street, M5S 3G3 ON, Canada

LICENSING TERMS

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. You should obtain GNU GPL with file COPYING in this distribution.

Scientific results produced using the software provided shall acknowledge the use of this software. The proper reference is:

D. Khmelev, http://www.math.toronto.edu/dkhmelev/PROGS/

Moreover shall the author of the software be informed about the publication.

By using this program you agree to the licensing terms.

NO WARRANTY

BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ÄS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.