freebsd-dev/share/man/man9/devfs_add_devswf.9

.\"
.\" Copyright (c) 1995 Joerg Wunsch
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd December 31, 1995
.Os FreeBSD
.Dt DEVFS_ADD_DEVSWF 9
.Sh NAME
.Nm devfs_add_devswf
.Nd wire device into devswitch table
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/devfsext.h>
.Ft void *
.Fn devfs_add_devswf "void *devsw" "int minor" "int chrblk" "uid_t uid" "gid_t gid" "int perms" "char *fmt" ...
.Sh DESCRIPTION
The call that adds an entry into devfs is
.Nm .
.Pp
Its arguments are:
.Bl -tag -width 8n
.It Ar devsw
the address of the devsw entry the name should access
.It Ar minor
the minor number
.It Ar chrblk
whether the device is CHAR or BLK
.It Ar uid
Owner UID
.It Ar gid
Owner GID
.It Ar perms
Permissions (e.g. rwxr--r-- = 0744)
.It Ar fmt
Formatted string including name, and, if applicable, path to device within DEVFS 
.El
.Sh RETURN VALUES
It returns a token that can be used to link another name to the same
device
.Pq see Xr devfs_link 9 ,
or destroy the device
.Pq see Xr devfs_remove_dev 9 .
.Sh SEE ALSO
.Xr devfs_link 9 ,
.Xr devfs_remove_dev 9
.Sh HISTORY
The function
.Nm
appeared in
.Fx 2.2 .
.Sh AUTHORS
.An -nosplit
This man page was written by
.An J\(:org Wunsch
after a description from
.An Julian Elischer .
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.\"`
			`.\" Copyright (c) 1995 Joerg Wunsch`
			`.\"`
			`.\" All rights reserved.`
			`.\"`
			`.\" This program is free software.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,`
			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
			`.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
			`.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.\"`
			`.Dd December 31, 1995`
			`.Os FreeBSD`
Makefile: added devfs_add_devswf.9, removed devfs_add_devsw.9 devfs_link.9: modified man page to reflect source code devfs_add_devsw.9: replaced by devfs_add_devswf.9 devfs_add_devswf.9: proper function for adding devices to DEVFS 1996-04-02 04:10:45 +00:00			`.Dt DEVFS_ADD_DEVSWF 9`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Sh NAME`
Makefile: added devfs_add_devswf.9, removed devfs_add_devsw.9 devfs_link.9: modified man page to reflect source code devfs_add_devsw.9: replaced by devfs_add_devswf.9 devfs_add_devswf.9: proper function for adding devices to DEVFS 1996-04-02 04:10:45 +00:00			`.Nm devfs_add_devswf`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Nd wire device into devswitch table`
			`.Sh SYNOPSIS`
Fixed #include and/or prototype bugs in synopsis. 1997-04-13 14:49:13 +00:00			`.Fd #include <sys/types.h>`
Another round of man page cleanups. Down to only about 100 items left to cleanup! :-) 1996-02-12 04:57:03 +00:00			`.Fd #include <sys/devfsext.h>`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Ft void *`
Fixed #include and/or prototype bugs in synopsis. 1997-04-13 14:49:13 +00:00			`.Fn devfs_add_devswf "void devsw" "int minor" "int chrblk" "uid_t uid" "gid_t gid" "int perms" "char fmt" ...`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Sh DESCRIPTION`
			`The call that adds an entry into devfs is`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm .`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Pp`
Correct "it's" to "its". PR: 18469 Submitted by: Anatoly Vorobey <mellon@pobox.com> 2000-05-09 18:08:52 +00:00			`Its arguments are:`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.Bl -tag -width 8n`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.It Ar devsw`
			`the address of the devsw entry the name should access`
			`.It Ar minor`
			`the minor number`
			`.It Ar chrblk`
			`whether the device is CHAR or BLK`
			`.It Ar uid`
			`Owner UID`
			`.It Ar gid`
			`Owner GID`
			`.It Ar perms`
			`Permissions (e.g. rwxr--r-- = 0744)`
Makefile: added devfs_add_devswf.9, removed devfs_add_devsw.9 devfs_link.9: modified man page to reflect source code devfs_add_devsw.9: replaced by devfs_add_devswf.9 devfs_add_devswf.9: proper function for adding devices to DEVFS 1996-04-02 04:10:45 +00:00			`.It Ar fmt`
			`Formatted string including name, and, if applicable, path to device within DEVFS`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.El`
			`.Sh RETURN VALUES`
			`It returns a token that can be used to link another name to the same`
			`device`
			`.Pq see Xr devfs_link 9 ,`
devfs_add_devswf(9) and devfs_link(9) don't tell you how to remove the device once it's added or linked. PR: 6524 Reviewed by: phk Submitted by: Brian Cully <shmit@kublai.com> 1998-05-06 09:13:53 +00:00			`or destroy the device`
			`.Pq see Xr devfs_remove_dev 9 .`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Sh SEE ALSO`
Sort cross references. 1998-08-31 16:41:09 +00:00			`.Xr devfs_link 9 ,`
devfs_add_devswf(9) and devfs_link(9) don't tell you how to remove the device once it's added or linked. PR: 6524 Reviewed by: phk Submitted by: Brian Cully <shmit@kublai.com> 1998-05-06 09:13:53 +00:00			`.Xr devfs_remove_dev 9`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Sh HISTORY`
			`The function`
			`.Nm`
Use the .Fx macro to reference FreeBSD versions in several newer man pages. For those of you that don't know, here is an example of how the .Fx macro is used: The xyzzy command first appeared in .Fx 2.2 . Will expand to: The xyzzy command first appeared in FreeBSD 2.2. 1996-08-21 21:43:28 +00:00			`appeared in`
			`.Fx 2.2 .`
Add man pages for devfs functions after Julian's descripton. Someone must be the first. :) 1995-12-31 00:08:18 +00:00			`.Sh AUTHORS`
mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00			`.An -nosplit`
Grammar police; "has been written by" --> "was written by". 2000-08-15 15:23:46 +00:00			`This man page was written by`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.An J\(:org Wunsch`
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq. 1998-03-12 07:31:21 +00:00			`after a description from`
			`.An Julian Elischer .`