Set the default DESTDIR to /var/vkernel when the platform is vkernel.
[dragonfly.git] / share / man / man9 / make_dev.9
CommitLineData
984263bc
MD
1.\" Copyright (c) 1999 Chris Costello
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/share/man/man9/make_dev.9,v 1.2.2.3 2001/12/17 11:30:18 ru Exp $
44cb301e 26.\" $DragonFly: src/share/man/man9/make_dev.9,v 1.3 2006/05/26 19:39:40 swildner Exp $
984263bc
MD
27.\"
28.Dd September 25, 1999
29.Os
30.Dt MAKE_DEV 9
31.Sh NAME
32.Nm make_dev ,
33.Nm destroy_dev
34.Nd "Create or destroy dev_t for a new device"
35.Sh SYNOPSIS
36.In sys/types.h
37.In sys/conf.h
38.Ft dev_t
39.Fn make_dev "struct cdevsw *cdevsw" "int minor" "uid_t uid" "gid_t gid" "int perms" "char *fmt" ...
40.Ft void
41.Fn destroy_dev "dev_t dev"
42.Sh DESCRIPTION
43The
44.Fn make_dev
45function creates a
46.Fa dev_t
47structure for a new device.
48The device will be owned by
49.Va uid ,
50with the group ownership as
51.Va gid ,
52and with the name as specified in
53.Va name .
54The permissions of the file specified in
55.Va perms
56are defined in
44cb301e 57.In sys/stat.h :
984263bc
MD
58.Pp
59.Bd -literal -offset indent -compact
60#define S_IRWXU 0000700 /* RWX mask for owner */
61#define S_IRUSR 0000400 /* R for owner */
62#define S_IWUSR 0000200 /* W for owner */
63#define S_IXUSR 0000100 /* X for owner */
64
65#define S_IRWXG 0000070 /* RWX mask for group */
66#define S_IRGRP 0000040 /* R for group */
67#define S_IWGRP 0000020 /* W for group */
68#define S_IXGRP 0000010 /* X for group */
69
70#define S_IRWXO 0000007 /* RWX mask for other */
71#define S_IROTH 0000004 /* R for other */
72#define S_IWOTH 0000002 /* W for other */
73#define S_IXOTH 0000001 /* X for other */
74
75#define S_ISUID 0004000 /* set user id on execution */
76#define S_ISGID 0002000 /* set group id on execution */
77#define S_ISVTX 0001000 /* sticky bit */
78#ifndef _POSIX_SOURCE
79#define S_ISTXT 0001000
80#endif
81.Ed
82.Pp
83The
84.Fn destroy_dev
85function takes the returned
86.Fa dev_t
87from
88.Fn make_dev
89and destroys the registration for that device.
90.Sh HISTORY
91The
92.Fn make_dev
93and
94.Fn destroy_dev
95functions first appeared in
96.Fx 4.0 .