4857

Clean up the debugging flow, and go over help messages for inconsistencies.
They predate the new Readme, which takes some time to describe the x86
instruction set.

1 files changed, 12 insertions, 3 deletions

diff --git a/subx/001help.cc b/subx/001help.cc
index 5f90abca..8d815be5 100644
--- a/subx/001help.cc
+++ b/subx/001help.cc
@@ -76,10 +76,19 @@ void init_help() {
     "    subx translate input1.subx intput2.subx ... -o <output ELF binary>\n"
     "- Run a SubX binary using SubX itself (for better error messages):\n"
     "    subx run <ELF binary>\n"
-    "Add '--trace' to any of these commands to also emit a trace, for debugging purposes.\n"
-    "However, options starting with '--' must always come before any other arguments.\n"
     "\n"
-    "To start learning how to write SubX programs, run:\n"
+    "== Debugging aids\n"
+    "- Add '--trace' to any of these commands to print a trace to stderr\n"
+    "  for debugging purposes.\n"
+    "- Add '--map' to add information to traces. 'subx --map translate' will save\n"
+    "  (to a file called 'map') the mapping from labels to addresses that it computes\n"
+    "  during translation. This file is then available to 'subx --map --trace run'\n"
+    "  which prints out label names in the trace as it encounters them.\n"
+    "\n"
+    "Options starting with '--' must always come before any other arguments.\n"
+    "\n"
+    "To start learning how to write SubX programs, see Readme.md (particularly\n"
+    "the section on the x86 instruction set) and then run:\n"
     "  subx help\n"
   );
   // End Help Texts