README revision 1.5 
1	$NetBSD: README,v 1.5 2018/04/13 01:20:27 kamil Exp $
2
3                           Kernel Developer's Manual
4
5DESCRIPTION
6     The kernel example dynamic modules.
7
8     This directory contains the following example modules
9     * hello           - the simplest `hello world' module
10     * properties      - handle incoming properties during the module load
11     * readhappy       - basic implementation of read(9) with happy numbers
12     * ping            - basic ioctl(9)
13     * luahello        - the simplest `hello world' Lua module
14     * luareadhappy    - demonstrates calling Lua code from C
15     * sysctl          - demonstrates adding a sysctl handle dynamically
16
17     To build the examples you need a local copy of NetBSD sources. You also
18     need the comp set with toolchain. To build the module just enter a
19     directory with example modules and use make(1):
20
21         # make
22
23     To load, unload, and stat the module use modload(8), modunload(8) and
24     modstat(8).
25
26     The S parameter in the Makefile files points to src/sys and it can be
27     overloaded in this way:
28
29         # make S=/data/netbsd/src/sys
30
31     The code of a module does not need to be in src/sys unless you use
32     the autoconf(9) framework.
33
34     A cross-built of a module for a target platform is possible with the
35     build.sh framework. You need to generate the toolchain and set
36     appropriately PATH to point bin/ in the TOOLDIR path. An example command
37     to cross-build a module with the amd64 toolchain is as follows:
38
39        # nbmake-amd64 S=/data/netbsd/src/sys
40
41
42     The example modules should not be used on a production machine.
43
44     All modules that create a cdevsw should be verified that the major number
45     should not conflict with a real device.
46
47SEE ALSO
48     modctl(2), module(7), modload(8), modstat(8), modunload(8), module(9),
49     intro(9lua)
50
51HISTORY
52     An example of handling incoming properties first appeared in NetBSD 5.0
53     and was written by Julio Merino with further modifications by Martin
54     Husemann, Adam Hamsik, John Nemeth and Mindaugas Rasiukevicius.
55
56     This document and additional modules (hello, readhappy, properties,
57     ping, luahello and luareadhappy) first appeared in NetBSD 8.0; they were
58     written by Kamil Rytarowski.
59
60     The sysctl module first appeared in NetBSD 9.0 and was authored by
61     Siddharth Muralee.
62
63AUTHORS
64     This document was written by Kamil Rytarowski.
65