No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man8 / MAKEDEV.local.8
blobdaf347c5cfc7370d255458b385b3734fed38728f
1 .\" $NetBSD: MAKEDEV.local.8,v 1.6 2008/04/09 20:23:20 apb Exp $
2 .\"
3 .\" Copyright (c) 2007 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .Dd April 9, 2008
28 .Dt MAKEDEV.LOCAL 8
29 .Os
30 .Sh NAME
31 .Nm MAKEDEV.local
32 .Nd create site-specific device special files
33 .Sh SYNOPSIS
34 .Nm
35 .Op Fl fMs
36 .Op Fl m Ar mknod
37 .Op Fl p Ar pax
38 .Op Fl t Ar mtree
39 .Bro Pa all | site-specific-argument Brc Op Ar ...
40 .Sh DESCRIPTION
41 .Nm
42 is used to create site-specific device special files.
43 Each argument may be the word
44 .Pa all
45 or a site-specific argument.
46 By default, there are no valid site-specific arguments,
47 and the
48 .Pa all
49 argument has no effect;
50 This may be changed by editing the script.
51 .Pp
52 The script is in
53 .Pa /dev/MAKEDEV.local .
54 Devices are created in the current working directory;
55 in normal use,
56 .Nm
57 should be invoked with
58 .Pa /dev
59 as the current working directory.
60 .Pp
61 Supported options for
62 .Nm
63 are the same as for
64 .Xr MAKEDEV 8 .
65 .Sh FILES
66 .Bl -tag -width "/dev/MAKEDEV.local" -compact
67 .It Pa /dev
68 special device files directory
69 .It Pa /dev/MAKEDEV
70 script that invokes
71 .Nm
72 with the
73 .Pa all
74 argument.
75 .It Pa /dev/MAKEDEV.local
76 script described in this man page
77 .El
78 .Sh SEE ALSO
79 .Xr config 1 ,
80 .Xr intro 4 ,
81 .Xr MAKEDEV 8 ,
82 .Xr mknod 8
83 .Sh HISTORY
84 The
85 .Nm
86 command appeared in
87 .Bx 4.2 .
88 Handling of the same command line options as
89 .Xr MAKEDEV 8 ,
90 and the use of
91 .Xr MAKEDEV 8
92 as a function library, was added in
93 .Nx 5.0 .
94 .Sh NOTES
95 The relationship between
96 .Nm
97 and
98 .Xr MAKEDEV 8
99 is complex:
100 .Bl -bullet
103 .Xr MAKEDEV 8
104 is invoked with the
105 .Pa all
107 .Pa local
108 argument, then it will invoke
110 as a child process, with options similar to
111 those that were originally passed to
112 .Xr MAKEDEV 8 ,
113 and with the
114 .Pa all
115 argument.
118 uses shell functions defined in
119 .Xr MAKEDEV 8 .
120 This is done by loading
121 .Xr MAKEDEV 8
122 using the shell
123 .Dq \&.
124 command, with the
125 .Ev MAKEDEV_AS_LIBRARY
126 variable set (to inform
127 .Xr MAKEDEV 8
128 that it should behave as a function library,
129 not as an independent program).