traditionally forgot doc/shedskin.rst as well
[shedskin:mainline.git] / doc / shedskin.rst
1 ========
2 Shedskin
3 ========
4
5 ---------------------------------------------------
6 An experimental (restricted) Python-to-C++ Compiler
7 ---------------------------------------------------
8
9 :Date:   2013-06-16
10 :Version: 0.9.4
11 :Manual section: 1
12
13 SYNOPSIS
14 ========
15
16 shedskin [OPTION]... FILE
17
18 DESCRIPTION
19 ===========
20
21 Shed Skin is an experimental compiler, that can translate pure, but implicitly statically typed Python (2.4-2.6) programs into optimized C++. It can generate stand-alone programs or extension modules that can be imported and used in larger Python programs.
22
23 Besides the typing restriction, programs cannot freely use the Python standard library (although about 25 common modules, such as random and re, are currently supported). Also, not all Python features, such as nested functions and variable numbers of arguments, are supported.
24
25 OPTIONS
26 =======
27
28  -a --ann               Output annotated source code (.ss.py)
29
30  -b --nobounds          Disable bounds checking
31
32  -e --extmod            Generate extension module
33
34  -f --flags             Provide alternate Makefile flags
35
36  -g --nogcwarns         Disable runtime GC warnings
37
38  -l --long              Use long long integers
39
40  -m --makefile          Specify alternate Makefile name
41
42  -n --silent            Silent mode, only show warnings
43
44  -o --noassert          Disable assert statements
45
46  -r --random            Use fast random number generator (rand())
47
48  -s --strhash           Use fast string hashing algorithm (murmur)
49
50  -w --nowrap            Disable wrap-around checking
51
52  -x --traceback         Print traceback for uncaught exceptions
53   
54  -L --lib               Add a library directory