file_cmds-184.tar.gz
[apple/file_cmds.git] / mknod / mknod.8
1 .\"     $NetBSD: mknod.8,v 1.15 1998/09/11 07:20:48 mycroft Exp $
2 .\"
3 .\" Copyright (c) 1980, 1991, 1993
4 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by the University of
17 .\"     California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\"     @(#)mknod.8     8.2 (Berkeley) 12/11/93
35 .\"
36 .Dd September 11, 1998
37 .Dt MKNOD 8
38 .Os NetBSD 1.4
39 .Sh NAME
40 .Nm mknod
41 .Nd make device special file
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl F Ar format
45 .Ar name
46 .Op Cm c | Cm b
47 .Ar major minor
48 .Nm
49 .Op Fl F Ar format
50 .Ar name
51 .Op Cm c | Cm b
52 .Ar major unit subunit
53 .Nm
54 .Ar name
55 .Op Cm c | Cm b
56 .Ar number
57 .Nm
58 .Ar name
59 .Ar w
60 .Sh DESCRIPTION
61 The
62 .Nm
63 command creates device special files.
64 Normally the shell script
65 .Pa /dev/MAKEDEV
66 is used to create special files for commonly known devices; it executes
67 .Nm
68 with the appropriate arguments and can make all the files required for the
69 device.
70 .Pp
71 To make nodes manually, the required arguments are:
72 .Pp
73 .Bl -tag -width majorx
74 .It Ar name
75 Device name, for example
76 .Dq sd
77 for a SCSI disk on an HP300 or a
78 .Dq pty
79 for pseudo-devices.
80 .It Cm b | Cm c | Cm w
81 Type of device. If the
82 device is a block type device such as a tape or disk drive which needs
83 both cooked and raw special files,
84 the type is
85 .Cm b .
86 Whiteout nodes are type
87 .Cm w .
88 All other devices are character type devices, such as terminal
89 and pseudo devices, and are type
90 .Cm c .
91 .It Ar major
92 The major device number is an integer number which tells the kernel
93 which device driver entry point to use.  To learn what
94 major device number to use for a particular device, check the file
95 .Pa /dev/MAKEDEV
96 to see if the device is known, or check
97 the system dependent device configuration file:
98 .Bd -filled -offset indent
99 .Dq Pa /usr/src/sys/conf/device. Ns Em architecture
100 .Ed
101 .Pp
102 (for example
103 .Pa device.hp300 ) .
104 .It Ar minor
105 The minor device number tells the kernel which one of several similar
106 devices the node corresponds to; for example, it may be a specific serial
107 port or pty.
108 .It Ar unit and subunit
109 The unit and subunit numbers select a subset of a device; for example, the
110 unit may specify a particular SCSI disk, and the subunit a partition on
111 that disk.  (Currently this form of specification is only supported by the
112 .Ar bsdos
113 format, for compatibility with the
114 .Bsx
115 .Xr mknod 8 .)
116 .El
117 .Pp
118 Device numbers for different operating systems may be packed in a different
119 format.  To create device nodes that may be used by such an operating system
120 (e.g. in an exported file system used for netbooting), the
121 .Fl F
122 option is used.  The following formats are recognized:
123 native,
124 386bsd,
125 4bsd,
126 bsdos,
127 freebsd,
128 hpux,
129 isc,
130 linux,
131 netbsd,
132 osf1,
133 sco,
134 solaris,
135 sunos,
136 svr3,
137 svr4 and
138 ultrix.
139 .Pp
140 Alternatively, a single opaque device number may be specified.
141 .Sh SEE ALSO
142 .Xr mkfifo 1 ,
143 .Xr mkfifo 2 ,
144 .Xr mknod 2 ,
145 .Xr MAKEDEV 8
146 .Sh HISTORY
147 A
148 .Nm
149 command appeared in
150 .At v6 .
151 The
152 .Fl F
153 option appeared in
154 .Nx 1.4 .