xref: /dflybsd-src/share/man/man9/device_set_desc.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1*86d7f5d3SJohn Marino.\" Copyright (c) 1998 Doug Rabson
2*86d7f5d3SJohn Marino.\"
3*86d7f5d3SJohn Marino.\" All rights reserved.
4*86d7f5d3SJohn Marino.\"
5*86d7f5d3SJohn Marino.\" This program is free software.
6*86d7f5d3SJohn Marino.\"
7*86d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
8*86d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
9*86d7f5d3SJohn Marino.\" are met:
10*86d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
11*86d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
12*86d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
13*86d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
14*86d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
15*86d7f5d3SJohn Marino.\"
16*86d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17*86d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18*86d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19*86d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20*86d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21*86d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22*86d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23*86d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24*86d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25*86d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*86d7f5d3SJohn Marino.\"
27*86d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/device_set_desc.9,v 1.5.2.3 2001/12/17 11:30:18 ru Exp $
28*86d7f5d3SJohn Marino.\" $DragonFly: src/share/man/man9/device_set_desc.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
29*86d7f5d3SJohn Marino.\"
30*86d7f5d3SJohn Marino.Dd June 16, 1998
31*86d7f5d3SJohn Marino.Dt DEVICE_SET_DESC 9
32*86d7f5d3SJohn Marino.Os
33*86d7f5d3SJohn Marino.Sh NAME
34*86d7f5d3SJohn Marino.Nm device_set_desc ,
35*86d7f5d3SJohn Marino.Nm device_set_desc_copy ,
36*86d7f5d3SJohn Marino.Nm device_get_desc
37*86d7f5d3SJohn Marino.Nd access the description of a device
38*86d7f5d3SJohn Marino.Sh SYNOPSIS
39*86d7f5d3SJohn Marino.In sys/param.h
40*86d7f5d3SJohn Marino.In sys/bus.h
41*86d7f5d3SJohn Marino.Ft void
42*86d7f5d3SJohn Marino.Fn device_set_desc "device_t dev" "const char *desc"
43*86d7f5d3SJohn Marino.Ft void
44*86d7f5d3SJohn Marino.Fn device_set_desc_copy "device_t dev" "const char *desc"
45*86d7f5d3SJohn Marino.Ft const char *
46*86d7f5d3SJohn Marino.Fn device_get_desc "device_t dev"
47*86d7f5d3SJohn Marino.Sh DESCRIPTION
48*86d7f5d3SJohn MarinoManipulate the verbose description of a device.  This description (if
49*86d7f5d3SJohn Marinopresent) is printed as part of the message when it is attached during
50*86d7f5d3SJohn Marinoautoconfiguration.
51*86d7f5d3SJohn MarinoThe variation
52*86d7f5d3SJohn Marino.Xr device_set_desc_copy 9
53*86d7f5d3SJohn Marinois used to set the description if the string passed is a temporary
54*86d7f5d3SJohn Marinobuffer which will be overwritten.
55*86d7f5d3SJohn MarinoIn this case, the system will copy
56*86d7f5d3SJohn Marinothe string, otherwise the pointer passed will be used directly.
57*86d7f5d3SJohn Marino.Sh SEE ALSO
58*86d7f5d3SJohn Marino.Xr device 9
59*86d7f5d3SJohn Marino.Sh AUTHORS
60*86d7f5d3SJohn MarinoThis man page was written by
61*86d7f5d3SJohn Marino.An Doug Rabson .
62