summaryrefslogtreecommitdiff
path: root/doc/6m.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/6m.1')
-rw-r--r--doc/6m.127
1 files changed, 18 insertions, 9 deletions
diff --git a/doc/6m.1 b/doc/6m.1
index 7ef544c..f04090c 100644
--- a/doc/6m.1
+++ b/doc/6m.1
@@ -3,15 +3,14 @@
6m
.SH SYNOPSIS
.B 6m
-.I -[hioS]
+.I -[?hioSG9d]
.I [file...]
.br
.SH DESCRIPTION
.PP
-The ?m family of compilers compile Myrddin source into object files
-for the corresponding architecture. There is one compiler for each
-architecture supported, with a unique name. By default, if the input
-file is named
+The ?m compiler family compiles Myrddin source into object files
+for the corresponding architecture. Each architecture gets its own
+compler. Unless otherwise specified, if the input file is named
.I filename.myr
then the the object file that is generated will be named
.I filename.o.
@@ -22,7 +21,7 @@ tools like 'mbld'.
.PP
If the filename does not end with the suffix
.I .myr
-then the suffix
+then the object suffix
.I .o
will simply be appended to it.
@@ -36,29 +35,39 @@ x86-64
The compiler options are:
.TP
-.B -d [flTri]
+.B -d [flTriu]
Print debugging dumps. Additional options may be given to give more
debugging information for specific intermediate states of the compilation.
.TP
-.B -h
+.B -h, -?
Print a summary of the available options.
.TP
.B -I path
Add 'path' to the search path for unquoted use statments. This option
does not affect the search path for local usefiles, which are always
-searched relative to the compiler's current working directory. Without
+searched relative to the directory containing the output file. Without
any options, the search path defaults to /usr/include/myr.
.TP
.B -o output-file
Specify that the generated code should be placed in
+.I output-file
+instead of the default location.
.TP
.B -S
Generate assembly code along with the object file.
+.TP
+.B -G
+Generate assembly in the Gnu As syntax.
+
+.TP
+.B -9
+Generate assembly in the Plan 9 syntax.
+
.SH EXAMPLE
.EX
6m foo.myr