M1.1 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. .\"Made with Love
  2. .TH M1 1 "JULY 2019" Linux "User Manuals"
  3. .SH NAME
  4. M1 \- The universal Macro assembler
  5. .SH SYNOPSIS
  6. M1 --architecture ARCHITECTURE --file FILE [--output FILE --octal --binary --BigEndian --LittleEndian]
  7. .SH DESCRIPTION
  8. M1 is the most minimal cross-platform macro assembler possible
  9. .br
  10. Leveraging a few grammar details to provide the user with a
  11. rich vocabulary of ways of expressing their desired output
  12. and input; thus eliminating surprise from the generation
  13. process.
  14. At it's core is DEFINE MACRO EXPANDED
  15. Where one can define an assembly instruction like:
  16. DEFINE INT_80 CD80
  17. and know that everywhere INT_80 is placed in the input
  18. file there will be the hex encoding of that instruction
  19. in the output file or if no output file is specified the
  20. output will be send to standard out.
  21. .br
  22. The supported ARCHITECTURES are as follows: knight-native,
  23. knight-posix, x86, amd64, armv7l and aarch64.
  24. If you fail to specify an architecture, the default of knight-native
  25. will be used.
  26. .br
  27. M1 also supports the generation of 8, 16 and 32bit integers
  28. provided they are encoded as !NUM, @NUM or %NUM respectively.
  29. eg !-1, @42 and %8675309
  30. You however can not mix integers with definitions as macros
  31. are always applied first and will not be evaluated further.
  32. Should you wish to specify the bit and byte encoding of the
  33. integers to match your target --BigEndian and --LittleEndian
  34. Should you wish for the output to be something other than hex
  35. format, you can specify the exact output you desire with:
  36. --octal or --binary
  37. .SH EXAMPLES
  38. Typically, M1 will be called in scripts used in bootstrapping
  39. .br
  40. # M1 -f x86.defs -f libc-core.M1 -f cc.M1 -f cc-footer.M1 --LittleEndian --architecture x86 -o cc.hex2
  41. .br
  42. .SH COMPATIBILITY
  43. M1 is compatible with all Turing complete machines;
  44. even the ones that try to be Turing complete -1
  45. .SH AUTHORS
  46. Jeremiah Orians <Jeremiah@pdp10.guru>
  47. .br
  48. Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
  49. .SH COPYRIGHT
  50. Copyright 2016-2019 Jeremiah Orians <Jeremiah@pdp10.guru>
  51. .br
  52. Copyright 2017 Jan Nieuwenhuizen <janneke@gnu.org>
  53. .br
  54. License GPLv3+.
  55. .SH "SEE ALSO"
  56. hex2(1), blood-elf(1), kaem(1), syscalls(2)