Mercurial > molko
comparison doc/docs/tools/bcc.md @ 239:d47e70da760e
doc: switch to mkdocs+doxybook2, closes #2516 @2h
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Fri, 27 Nov 2020 17:00:30 +0100 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 238:b30c3af37a01 | 239:d47e70da760e |
|---|---|
| 1 # Tool: mlk-bcc | |
| 2 | |
| 3 This utility generates C byte array from any input file. Its main purpose is to | |
| 4 allow embedding data directly into the executable without having to load files | |
| 5 from disk. | |
| 6 | |
| 7 It reads the given file and generate the output to the standard output. | |
| 8 | |
| 9 Synopsis: | |
| 10 | |
| 11 mlk-bcc [-0csu] [-I num] [-i num] filename variable | |
| 12 | |
| 13 Options and arguments: | |
| 14 | |
| 15 -0 | |
| 16 : Terminate the array with a NUL terminator. | |
| 17 | |
| 18 -c | |
| 19 : Generate a ``const`` C array. | |
| 20 | |
| 21 -s | |
| 22 : Generate a ``static`` C array. | |
| 23 | |
| 24 -u | |
| 25 : Use ``unsigned char`` instead of ``signed char`` when generating the byte | |
| 26 array. | |
| 27 | |
| 28 -I num | |
| 29 : Use ``num`` tabs to indent (defaults to 1). | |
| 30 | |
| 31 -i num | |
| 32 : Use ``num`` spaces to indent. | |
| 33 | |
| 34 filename | |
| 35 : Filename to read as input, a value of ``-`` will read the standard input. | |
| 36 | |
| 37 variable | |
| 38 : The C variable to generate, any character that is not valid in C will be | |
| 39 replaced by a ``_`` but the variable must still not start with a digit. |