ref: 44bd7d2ca3dc2b1a06cc0f4f688c0980d52a296e
parent: dc9d65663705d6fbbb86cce816acbe6f6d480f0b
author: Ryan Roden-Corrent <ryan@rcorre.net>
date: Sat Oct 8 08:55:50 EDT 2016
Rename mc.1 to 6m.1. The executable itself is called 6m, so rename the manpage to match. This avoids a potential conflict with Midnight Commander, which is called 'mc' on some distributions (e.g. ArchLinux).
--- /dev/null
+++ b/doc/6m.1
@@ -1,0 +1,89 @@
+.TH MC 1
+.SH NAME
+6m
+.SH SYNOPSIS
+.B 6m
+.I -[hioS]
+.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
+.I filename.myr
+then the the object file that is generated will be named
+.I filename.o.
+.PP
+Any text between the first '+' in the file name and the suffix are
+stripped. This functionality is used to specify system tags for
+tools like 'mbld'.
+.PP
+If the filename does not end with the suffix
+.I .myr
+then the suffix
+.I .o
+will simply be appended to it.
+
+.PP
+The following architectures are currently supported:
+.TP
+6m
+x86-64
+
+.PP
+The compiler options are:
+
+.TP
+.B -d [flTri]
+Print debugging dumps. Additional options may be given to give more
+debugging information for specific intermediate states of the compilation.
+
+.TP
+.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
+any options, the search path defaults to /usr/include/myr.
+
+.TP
+.B -o output-file
+Specify that the generated code should be placed in
+
+.TP
+.B -S
+Generate assembly code along with the object file.
+
+.SH EXAMPLE
+.EX
+ 6m foo.myr
+ 6m bar.myr
+ ld -o foobar foo.o bar.o
+.EE
+
+.SH FILES
+The source code for this compiler is available from
+.B git://git.eigenstate.org/git/ori/mc.git
+
+.SH SEE ALSO
+.IR muse(1)
+.IR ld(1)
+.IR as(1)
+
+.SH BUGS
+.PP
+The language is not yet complete, and the compilers often omit useful
+constructs in spite of their desirability.
+.PP
+There are virtually no optimizations done, and the generated source is
+often very poorly performing.
+.PP
+The current calling convention is stack-based and not register-based, even
+on architectures where it should be register-based.
+.PP
+The calling convention is not compatible with C.
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,4 +1,4 @@
-INSTMAN=mc.1 \
+INSTMAN=6m.1 \
muse.1 \
include ../config.mk
--- a/doc/mc.1
+++ /dev/null
@@ -1,89 +1,0 @@
-.TH MC 1
-.SH NAME
-6m
-.SH SYNOPSIS
-.B 6m
-.I -[hioS]
-.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
-.I filename.myr
-then the the object file that is generated will be named
-.I filename.o.
-.PP
-Any text between the first '+' in the file name and the suffix are
-stripped. This functionality is used to specify system tags for
-tools like 'mbld'.
-.PP
-If the filename does not end with the suffix
-.I .myr
-then the suffix
-.I .o
-will simply be appended to it.
-
-.PP
-The following architectures are currently supported:
-.TP
-6m
-x86-64
-
-.PP
-The compiler options are:
-
-.TP
-.B -d [flTri]
-Print debugging dumps. Additional options may be given to give more
-debugging information for specific intermediate states of the compilation.
-
-.TP
-.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
-any options, the search path defaults to /usr/include/myr.
-
-.TP
-.B -o output-file
-Specify that the generated code should be placed in
-
-.TP
-.B -S
-Generate assembly code along with the object file.
-
-.SH EXAMPLE
-.EX
- 6m foo.myr
- 6m bar.myr
- ld -o foobar foo.o bar.o
-.EE
-
-.SH FILES
-The source code for this compiler is available from
-.B git://git.eigenstate.org/git/ori/mc.git
-
-.SH SEE ALSO
-.IR muse(1)
-.IR ld(1)
-.IR as(1)
-
-.SH BUGS
-.PP
-The language is not yet complete, and the compilers often omit useful
-constructs in spite of their desirability.
-.PP
-There are virtually no optimizations done, and the generated source is
-often very poorly performing.
-.PP
-The current calling convention is stack-based and not register-based, even
-on architectures where it should be register-based.
-.PP
-The calling convention is not compatible with C.
--- a/doc/mkfile
+++ b/doc/mkfile
@@ -1,5 +1,5 @@
MANS=\
- mc.1 \
+ 6m.1 \
muse.1 \
all:V: $MANS
--- a/doc/muse.1
+++ b/doc/muse.1
@@ -75,7 +75,7 @@
directory within the source tree.
.SH SEE ALSO
-.IR mc(1)
+.IR 6m(1)
.IR ld(1)
.IR as(1)
--- a/lib/regex/doc/myr-regex.3
+++ b/lib/regex/doc/myr-regex.3
@@ -188,7 +188,7 @@
.B git://git.eigenstate.org/git/ori/libregex.git
.SH SEE ALSO
-.IR mc(1)
+.IR 6m(1)
.SH BUGS
.PP
--- a/mbld/mbld.1
+++ b/mbld/mbld.1
@@ -141,7 +141,7 @@
directory within the source tree.
.SH SEE ALSO
-.IR mc(1)
+.IR 6m(1)
.IR muse(1)
.IR ld(1)
.IR as(1)