summaryrefslogtreecommitdiff
path: root/mbld.1
blob: 52066b39a4126e0a03cf29cdccc12c4191270710 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
.TH MBLD 1
.SH NAME
mbld
.SH SYNOPSIS
.B mbld
.I [all | clean | install | uninstall | test]
.I -[hblIsfrR]
.I [file...]
.br
.SH DESCRIPTION
.PP
The 'mbld' tool takes as input a list of Myrddin or assembly sources,
and compiles them in the correct dependency order into either a library or
an executable. 

.PP
By default, it reads from an input file called 'bldfile', but if given the
option '-b' or '-l', it will build a binary or library, respectively, from
the arguments specified on the command lines.

.PP
Myrbuild will default to building for the current architecture.

.PP
The myrbuild options are:

.TP
.B -h
Print a summary of the available options.

.TP
.B -b name
Compile source into a binary named 'name'. If neither this option nor
the '-l' option are given, myrbuild will create a binary called 'a.out'.

.TP
.B -l 'name'
Compile source given into a library called 'lib<name>.a', and a matching
usefile called 'name'. Only static libraries are currently supported.

.TP
.B -s 'script'
Pass the linker script 'script' to the linker. If this option is not
provided, no script is passed to the linker.

.TP
.B -r 'rt'
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.

.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.

.SH EXAMPLE
.EX
    mbld
    mbld -l foo bar.myr baz.myr
.EE

.SH FILES
The source for muse is available from
.B git://git.eigenstate.org/git/ori/mc.git
and lives in the
.I myrbuild/
directory within the source tree.

.SH SEE ALSO
.IR mc(1)
.IR muse(1)
.IR ld(1)
.IR as(1)

.SH BUGS
.PP
None known.