xref: /NextBSD/usr.sbin/ndiscvt/ndisgen.8 (revision e5d2f8730c92c4abb6de986ec4e1f39a242b9868)
1.\" Copyright (c) 2005
2.\"	Bill Paul <wpaul@windriver.com> All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"   without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD$
32.\"
33.Dd April 24, 2005
34.Dt NDISGEN 8
35.Os
36.Sh NAME
37.Nm ndisgen
38.Nd generate a FreeBSD driver module from a
39.Tn Windows\[rg]
40NDIS driver distribution
41.Sh SYNOPSIS
42.Nm
43.Op Ar /path/to/INF /path/to/SYS
44.Sh DESCRIPTION
45The
46.Nm
47script uses the
48.Xr ndiscvt 8
49utility and other tools to generate a
50.Fx
51loadable driver module
52and a static ELF object module from a
53.Tn Windows\[rg]
54NDIS driver, for use with the
55.Xr ndis 4
56compatibility module.
57.Pp
58The
59.Nm
60script is interactive and contains its own help section.
61Unless the paths to both files are supplied on the command line,
62the script will prompt the user for the
63.Pa .INF
64and
65.Pa .SYS
66files needed to generate the
67.Fx
68driver module.
69The script will also prompt for
70any firmware or other external files needed.
71.Sh SEE ALSO
72.Xr ld 1 ,
73.Xr objcopy 1 ,
74.Xr ndis 4 ,
75.Xr kldload 8 ,
76.Xr ndiscvt 8
77.Sh HISTORY
78The
79.Nm
80utility first appeared in
81.Fx 6.0 .
82.Sh AUTHORS
83The
84.Nm
85utility was written by
86.An Bill Paul Aq Mt wpaul@windriver.com .
87