kaem.1 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. .\"Made with Love
  2. .TH kaem 1 "JULY 2019" Linux "User Manuals"
  3. .SH NAME
  4. kaem - Like running with scissors but shell scripts without a shell
  5. .SH SYNOPSIS
  6. .na
  7. kaem [--file FILE --strict --verbose --nightmare-mode]
  8. .SH DESCRIPTION
  9. kaem exists to be the most minimal shell needed in the bootstrap
  10. processes; that has the ability to function as an init
  11. thus allowing the bootstrap to occur with only itself and a
  12. hex0 assembler as the only binaries running on the system.
  13. .br
  14. At its core is read a line (except when the line is terminated
  15. with a '\\', when it is read the next line too) and then collect
  16. the arguments into an array, lookup the program in the path
  17. provided by the name or if not found in the ENVIRONMENT and
  18. then execute the program with the specified options.
  19. .br
  20. If no filename is passed, it then attempts to execute a file
  21. called kaem.run; which is the standard name for kaem scripts.
  22. If you wish for kaem to stop when one of the lines throws or
  23. returns an error code, simply add --strict. If you wish to
  24. see what is being executed, simply add --verbose. If you
  25. hate dealing with an environment and want to eliminate it
  26. entirely --nightmare-mode.
  27. .SH EXAMPLES
  28. Typically, kaem will be in running scripts used in bootstrapping
  29. .br
  30. # kaem --verbose --strict
  31. .br
  32. # kaem -f bootstrap.sh --nightmare-mode
  33. .br
  34. .SH COMPATIBILITY
  35. kaem is compatible with all Turing complete machines;
  36. even the ones that try to be Turing complete -1
  37. .SH AUTHORS
  38. Jeremiah Orians <Jeremiah@pdp10.guru>
  39. .SH COPYRIGHT
  40. Copyright 2016-2019 Jeremiah Orians <Jeremiah@pdp10.guru>
  41. .br
  42. License GPLv3+.
  43. .SH "SEE ALSO"
  44. M1(1), hex2(1), blood-elf(1), get_machine(1), syscalls(2)