|author||Ori Bernstein <firstname.lastname@example.org>||2019-01-07 22:47:42 -0800|
|committer||Ori Bernstein <email@example.com>||2019-01-12 00:03:23 -0800|
Improve manpages (thanks BurnZeZ)
Diffstat (limited to 'doc/muse.1')
1 files changed, 49 insertions, 30 deletions
@@ -3,76 +3,95 @@
-.I -o out -p pkg [-h] [-d dbg] [-l libs]
+.I file ...
-The muse tool acts as a linker for
+tool acts as a linker for
files. It reads all of the usefiles provided to it on the
command line, filters them by package, and outputs a new
usefile with the merged set of symbols. Both the
-.I -o out.use
-.I -p pkg
options are mandatory.
-The output of muse is architecture-independent. However, the format of the
+The output of
+is architecture-independent. However, the format of the
generated file is not stable, and is not guaranteed to work across
different compiler versions.
-The muse options are:
+Print a summary of the available options.
.B -d [flTri]
Print debugging dumps. Additional options may be given to give more
debugging information for specific intermediate states of the compilation.
-Print a summary of the available options.
-.B -p package
+.BI -p\ package
Take the symbols that match
and their dependencies, and merge them into a single package. Only symbols
matching the package name will be reexported.
-.B -o output-file
+.BI -o\ output-file
Specify that the generated usefile should be named
should match up with the package name given to the
muse -o library.use -p library foo.use bar.use
-The source for muse is available from
+The source for
+is available from
and lives in the
directory within the source tree.
.SH SEE ALSO
+.IR 6m (1),
+.IR 2l (1),
+.IR 2a (1)
There is insufficient checking and validation done on usefiles.
The file format is in flux, and in current iterations, it is not at all compact.
-The file format is not closed under concatentation.
+There is no versioning on the usefiles as it stands. If you use the wrong
+version with the wrong compiler, a mysterious error or even segfault is
+This utility should not exist. Instead, the compiler should put the
+exported symbol information into the object file or library directly.