f67d2b3b1b389c6f7545b8bce7817aba52251ab3
[dragonfly.git] / sbin / mknod / mknod.8
1 .\" Copyright (c) 1980, 1991, 1993
2 .\"     The Regents of the University of California.  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 the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)mknod.8     8.2 (Berkeley) 12/11/93
33 .\" $FreeBSD: src/sbin/mknod/mknod.8,v 1.11.2.10 2003/03/04 15:16:19 keramida Exp $
34 .\" $DragonFly: src/sbin/mknod/mknod.8,v 1.5 2008/05/02 02:05:05 swildner Exp $
35 .\"
36 .Dd December 11, 1993
37 .Dt MKNOD 8
38 .Os
39 .Sh NAME
40 .Nm mknod
41 .Nd build special file
42 .Sh SYNOPSIS
43 .Nm
44 .Ar name
45 .Op Cm c | Cm b
46 .Ar major minor
47 .Op Ar owner : Ns Ar group
48 .Sh DESCRIPTION
49 The
50 .Nm
51 utility creates device special files.
52 Normally the shell script
53 .Pa /dev/MAKEDEV
54 is used to create special files for commonly known devices; it executes
55 .Nm
56 with the appropriate arguments and can make all the files required for the
57 device.
58 .Pp
59 To make nodes manually, the four required arguments are:
60 .Bl -tag -width indent
61 .It Ar name
62 Device name, for example
63 .Dq sd
64 for a SCSI disk on an HP300 or a
65 .Dq pty
66 for pseudo-terminals.
67 .It Cm b | Cm c
68 Type of device.
69 If the
70 device is a block type device such as a tape or disk drive which needs
71 both cooked and raw special files,
72 the type is
73 .Cm b .
74 All other devices are character type devices, such as terminal
75 and pseudo devices, and are type
76 .Cm c .
77 .It Ar major
78 The major device number is an integer number which tells the kernel
79 which device driver entry point to use.  To learn what
80 major device number to use for a particular device, check
81 .Pa /dev/MAKEDEV
82 or
83 .Pa /usr/src/sys/conf/majors .
84 .It Ar minor
85 The minor device number tells the kernel which subunit
86 the node corresponds to on the device; for example,
87 a subunit may be a file system partition
88 or a tty line.
89 .It Ar owner : Ns Ar group
90 The
91 .Ar owner
92 .Ar group
93 operand pair is optional, however, if one is specified, they both must be
94 specified.
95 The
96 .Ar owner
97 may be either a numeric user ID or a user name.
98 If a user name is also a numeric user ID, the operand is used as a
99 user name.
100 The
101 .Ar group
102 may be either a numeric group ID or a group name.
103 Similar to the user name,
104 if a group name is also a numeric group ID, the operand is used as a
105 group name.
106 .El
107 .Pp
108 Major and minor device numbers can be given in any format acceptable to
109 .Xr strtoul 3 ,
110 so that a leading
111 .Ql 0x
112 indicates a hexadecimal number, and a leading
113 .Ql 0
114 will cause the number to be interpreted as octal.
115 .Sh COMPATIBILITY
116 The
117 .Xr chown 8 Ns - Ns
118 like functionality is specific to
119 .Dx
120 /
121 .Fx
122 and was added so that
123 .Pa /dev/MAKEDEV
124 would not depend on
125 .Pa /usr
126 being mounted.
127 .Sh SEE ALSO
128 .Xr mkfifo 1 ,
129 .Xr mknod 2 ,
130 .Xr chown 8 ,
131 .Xr MAKEDEV 8
132 .Sh HISTORY
133 A
134 .Nm
135 utility appeared in
136 .At v6 .