share/man/man9/device_set_desc.9

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