xref: /netbsd-src/usr.bin/rump_wmd/rump_wmd.1 (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1.\"	$NetBSD: rump_wmd.1,v 1.3 2014/01/28 14:02:54 pooka Exp $
2.\"
3.\" Copyright (c) 2014 Antti Kantee.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd January 28, 2014
27.Dt RUMP_WMD 1
28.Os
29.Sh NAME
30.Nm rump_wmd
31.Nd Resolve rump kernel component dependencies
32.Sh SYNOPSIS
33.Nm
34.Op Fl hv
35.Op Fl L Ar dir
36.Fl l Ar component
37.Sh DESCRIPTION
38The
39.Nm
40utility can be used to resolve the link dependencies of rump kernel
41components.
42This functionality is useful when desiring to run a rump kernel with
43a given set of drivers, but not being sure what the dependencies of
44those drivers are.
45The output of
46.Nm
47is accepted as command line input by
48.Xr rump_server 1 .
49.Pp
50The command line options are:
51.Bl -tag -width indent
52.It Fl h
53Print the usage.
54.It Fl L Ar dir
55By default, rump kernel components in
56.Pa /usr/lib
57are examined.
58If this option is supplied, components in
59.Ar dir
60are examined instead.
61.It Fl v
62Increase debug output from the utility.
63This option may be given multiple times.
64.El
65.Pp
66The desired components are given using
67.Fl l Ar component .
68This parameter may be specified multiple time and must be the last
69set of parameters.
70.Sh EXAMPLES
71Resolve dependencies for FFS:
72.Bd -literal -offset indent
73$ rump_wmd -lrumpfs_ffs
74DEBUG0: Searching component combinations. This may take a while ...
75DEBUG0: Found a set
76-lrumpdev -lrumpdev_disk -lrumpvfs -lrumpfs_ffs
77.Ed
78.Pp
79Resolve dependencies for NFS, use IPv6 networking and the virtif
80network interface:
81.Bd -literal -offset indent
82$ rump_wmd -lrumpfs_nfs -lrumpnet_netinet6 -lrumpnet_virtif
83DEBUG0: Searching component combinations. This may take a while ...
84DEBUG0: Found a set
85-lrumpnet -lrumpnet_net -lrumpvfs -lrumpfs_nfs -lrumpnet_netinet6 -lrumpnet_virtif
86.Ed
87.Sh SEE ALSO
88.Xr rump_server 1
89.Sh CAVEATS
90Since
91.Nm
92uses trial-and-error brute force resolution, it runs somewhat slow.
93If several seconds are spent for dependency resolution, the benefit of
94a rump kernel booting in 10ms is somewhat lost.
95Caching the output is highly recommended.
96.Sh FUN FACTS
97.Nm
98is short for "rump, where's my dependency".
99