diff options
Diffstat (limited to 'bba/README.md')
| -rw-r--r-- | bba/README.md | 46 |
1 files changed, 25 insertions, 21 deletions
diff --git a/bba/README.md b/bba/README.md index 7e64b582..166ff7ff 100644 --- a/bba/README.md +++ b/bba/README.md @@ -12,59 +12,63 @@ independent. Valid commands for the input are as follows. -pre <string> ------------- +pre \<string\> +-------------- When a C file is generated as output, all the "pre" strings will be included before the binary blob. -post <string> -------------- +post \<string\> +--------------- When a C file is generated as output, all the "post" strings will be included after the binary blob. -push <name> ------------ +push \<name\> +------------- All following commands up until the matching "pop" will be writen to stream -<name>. Everything written to the same stream will end up in a continous -region of the output. +\<name\>. Everything written to the same stream will end up in a continous +region of the output. The statements `pop`, `label`, `ref`, `u8`, `u16`, +`u32`, and `str` are only valid within such a block. The name used in the +first push statement also determines the name of the variable in the generated +C output (when C is selected as output file format). pop --- End of a push..pop block. -label <name> [<comment>] ------------------------- +label \<name\> \[\<comment\>\] +------------------------------ Add a label for the current position. -ref <name> [<comment>] ----------------------- +ref \<name\> \[\<comment\>\] +---------------------------- Add a 32-bit reference to the specified label. The reference will be a byte offset relative to the memory location of the reference itself. -u8 <value> [<comment>] ----------------------- +u8 \<value\> \[\<comment\>\] +---------------------------- Add a 8-bit value to the binary blob. -u16 <value> [<comment>] ------------------------ +u16 \<value\> \[\<comment\>\] +----------------------------- Add a 16-bit value to the binary blob. Note that the input must be structured in a way that ensures that all u16 are aligned to 2-byte addresses. -u32 <value> [<comment>] ----------------------- +u32 \<value\> \[\<comment\>\] +----------------------------- Add a 32-bit value to the binary blob. Note that the input must be structured in a way that ensures that all u32 are aligned to 4-byte addresses. -str <string> ------------- +str "\<string\>" \[\<comment\>\] +-------------------------------- -Add a reference to a zero-terminated copy of the specified string. +Add a reference to a zero-terminated copy of that string. Any character may be +used to quote the string, but the most common choices are `"` and `|`. |