diff options
author | Ori Bernstein <ori@eigenstate.org> | 2017-11-24 20:41:23 -0800 |
---|---|---|
committer | Ori Bernstein <ori@eigenstate.org> | 2017-11-24 20:41:23 -0800 |
commit | 04533d17c0b822121016ad48954aa05ca3b719d3 (patch) | |
tree | 483d6af4ed249be9ac61dd8b97bfd791b19eb48a /mbld | |
parent | c634b3005ccd2ddfe903b1c1c7b7d61e2e8d6fb4 (diff) | |
download | mc-04533d17c0b822121016ad48954aa05ca3b719d3.tar.gz |
Improve formatting a bit.
Diffstat (limited to 'mbld')
-rw-r--r-- | mbld/mbld.1 | 81 |
1 files changed, 50 insertions, 31 deletions
diff --git a/mbld/mbld.1 b/mbld/mbld.1 index 3a93115..b22898d 100644 --- a/mbld/mbld.1 +++ b/mbld/mbld.1 @@ -20,7 +20,11 @@ an executable. .PP By default, it reads from an input file called 'bld.proj', but if given the -option '-b' or '-l', it will build a binary or library, respectively, from +option +.I -b +or +.IR -l , +it will build a binary or library, respectively, from the arguments specified on the command lines. .PP @@ -36,40 +40,49 @@ Print a summary of the available options. .TP .B -b \fIbinname\fP Compile source into a binary named 'name'. If neither this option nor -the '-l' option are given, mbld will create a binary called 'a.out'. +the +.I -l +option are given, mbld will create a binary called +.IR a.out . .TP .B -I \fIpath\fP 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. +any options, the search path defaults to +.IR /usr/include/myr . .TP -.B -l -.I libname +.B -l \fIlibname\fP Compile source given into a library called 'lib\fIname\fP.a' (or the equivalent for the target platform), and a matching usefile called 'name'. Only static libraries are currently supported. Ignores the contents of \fIbld.proj\fP and \fIbld.sub\fP if they exist. .TP -.B -R -.I src +.B -R \fIsrc\fP Compile source given into a binary in temporary storage, and then execute it with the command line arguments passed in. .TP .B -S Tell the toolchain to generate assembly for the code being compiled as well -as the .o files, as though '-S' was passed to 6m. - -.TP -\fB-r \fIruntime -Compile a binary using the runtime 'rt'. If the runtime name given -is 'none', then no runtime will be linked. If this option is not provided, -then the default runtime in '$INSTALL_ROOT/myr/lib/_myrrt.o' will be -used. +as the .o files, as though +.I -S +was passed to 6m. + +.TP +.B -r \fIruntime\fP +Compile a binary using the runtime +.IR rt . +If the runtime name given +is +.IR none , +then no runtime will be linked. If this option is not provided, +then the default runtime in +.I $INSTALL_ROOT/myr/lib/_myrrt.o +will be used. .SH ACTIONS @@ -195,10 +208,10 @@ the local source directories. Bin targets are installed to .I ${BASEDIR}/bin when invoking -.I mbld install. +.IR mbld\ install . Test and bench targets built and run when invoking -.I mbld bench. +.IR mbld bench . Tests are run with the .I cwd set to the directory that contains @@ -213,7 +226,7 @@ and file pair. These files are installed to .I ${BASEDIR}/lib/myr when invoking -.I mbld install. +.IR mbld install . .PP Gen and cmd targets are also similar to each other, @@ -226,7 +239,7 @@ On the other targets are not invoked implicitly at all, unless they have an attribute such as .I test or -.I bench. +.IR bench . Instead, they are invoked explicitly by the user, bundling up some useful command or another, possibly providing system specific variants. @@ -238,7 +251,7 @@ This data may be generated from a target, or may simply be shipped as a file. The data is installed to the system specific share directory. For example, on Unix, this may be -.I ${BASEDIR}/share. +.IR ${BASEDIR}/share . .PP Man targets are installed to the system-appropriate manual @@ -275,7 +288,7 @@ targets .TP .B inc=path Add a path to the include -.I path . +.IR path . Valid on binary targets. .TP @@ -292,7 +305,7 @@ targets. .TP .B noinst Do not install this target when running -.I mbld install. +.IR mbld\ install . .TP .B test @@ -317,7 +330,7 @@ The file generated by this or .I cmd target should not be removed with -.I mbld clean. +.IR mbld\ clean . This is useful for keeping around files where the user may not have or want to run the generation code. @@ -333,7 +346,7 @@ target should be re-run when the argument changes. .B path=path When specified on a data target, provides the desired installation directory. Defaults to -.I ${BASEDIR}/share. +.IR ${BASEDIR}/share \. .SH FILES @@ -372,23 +385,29 @@ and \fIbaz.myr\fP .B DESTDIR prepends $DESTDIR to the path to install to. For example, if the installgg prefix is /usr, the binary path is bin/, then binaries will get copied -to $DESTDIR/usr/bin on +to +.I $DESTDIR/usr/bin +on .B mbld install .TP .B MYR_MC -Compiles the binaries with '$MYR_MC' instead of the default value of -6m. +Compiles the binaries with +.I $MYR_MC +instead of the default value, +.IR 6m . .TP .B MYR_MUSE -Merges usefiles with '$MYR_MUSE' instead of hte default value of -muse. +Merges usefiles with +.I $MYR_MUSE +instead of hte default value +.IR muse . .TP .B MYR_RT -Links with the runtime $MYR_RT instead of the default of -prefix/lib/myr/_myrrt.o. +Links with the runtime $MYR_RT instead of the default +.IR ${BASEDIR}/lib/myr/_myrrt.o . .SH SOURCES The source for mbld is available from |