summaryrefslogtreecommitdiff
path: root/doc/0_03_commandline.adoc
blob: 980003b01d81ff754087dd1771b6097d06e355fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Commandline
===========

Let's start colm with the '--help' command line argument.

----
colm --help
----

NOTE: This reflects the development version 0.13.0.4;


```usage: colm [options] file
general:
   -h, -H, -?, --help   print this usage and exit
   -v --version         print version information and exit
   -o <file>            write output to <file>
   -c                   compile only (don't produce binary)
   -e <file>            write C++ export header to <file>
   -x <file>            write C++ export code to <file>
   -m <file>            write C++ commit code to <file>
   -a <file>            additional code file to include in output program
```

This reveals us some more insights: it reads a 'colm' file and creates a object file with eventually cpp/h/x code.