77ca69b73b3681f88b58358a961ffc2ecf29415b
[sdk] / share / man / man1 / ecp.1
1 .TH ECP "1" "August 2012" "ecp" "Ecere SDK/eC Compiling Tools"
2 .SH NAME
3 ecp - eC Precompiler (Symbol File Generator)
4 .SH SYNOPSIS
5 .IX
6 ecp [\fB-t\fR \fItarget-platform\fR]
7     [\fB-cpp\fR \fIC-preprocessor\fR]
8     [\fB-defaultns\fR \fIdefault-namespace\fR]
9     [\fB-strictns\fR]
10     [understood-C-flags]
11     \fB-c\fR \fIinput\fR
12     [\fB-o\fR \fIoutput\fR]
13     [\fB-symbols\fR \fIsymbols-dir\fR]
14
15 .SH DESCRIPTION
16 ecp will parse the eC source file specified in \fIinput\fR and generate a list of symbols.
17 .SH OPTIONS
18 .SS Input
19 \fB-c\fR \fIinput\fR
20 The eC source file to compile
21 .SS Output
22 \fB-o\fR \fIoutput\fR
23 The location and name for the output intermediate C file
24 .P
25 (Defaults to the name of \fIinput\fR with the \fB.ec\fR extension replaced by \fB.sym\fR, placed in the directory specified by \fIsymbolsdir\fR, or current working directory if none is specified)
26 .SS Intermediate Directory
27 \fB-symbols\fR \fIsymbols-dir\fR
28 .P
29 Default output location for symbols file (\fB.sym\fR) if no output is specified
30 .SS Platform
31 \fB-t\fR \fItarget-platform\fR
32 .P
33 Where \fBtarget-platform\fR is one of: \fBwin32 linux apple\fR (Ignored for \fBecp\fR)
34 .SS Toolchain Options
35 \fB-cpp\fR \fIC-preprocessor\fR
36 .P
37 Which C preprocessor to use (defaults to \fBgcc\fR)
38 .SS Namespace Options
39 \fB-defaultns\fR \fIdefault-namespace\fR
40 .P
41    Assume all classes and namespaces defined in source file are within the namespace \fIdefault-namespace\fR.
42 This does not affect constructs defined with the \fBdefault\fR access mode, which are non-mangled and C compatible.
43 .P
44 \fB-strictns\fR
45    Do not automatically resolve constructs within namespaces and sub-namespaces. All classes, functions and defines must be explicitly qualified with their full namespaces.
46 .SS Understood C Flags
47 \fB-I\fR\fIincludedir\fR
48
49 \fB-isystem\fR|\fB-isysroot\fR \fIsysincludedir\fR
50
51 \fB-D\fR\fIdefinition\fR
52
53 \fB-m32\fR