share/man/man9/bus_generic_print_child.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1998 Doug Rabson
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD: src/share/man/man9/bus_generic_print_child.9,v 1.5.2.4 2001/12/17 11:30:18 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/bus_generic_print_child.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  31 .\"
  32 .Dd June 16, 1998
  33 .Dt BUS_GENERIC_PRINT_CHILD 9
  34 .Os
  35 .Sh NAME
  36 .Nm bus_generic_print_child
  37 .Nd generic implementation of
  38 .Dv DEVICE_PRINT_CHILD
  39 for busses
  40 .Sh SYNOPSIS
  41 .In sys/param.h
  42 .In sys/bus.h
  43 .Ft int
  44 .Fn bus_generic_print_child "device_t dev" "device_t child"
  45 .Sh DESCRIPTION
  46 This implementation prints out the default device announcement message.
  47 Given device 'foo0' on bus 'bar0' where foo0 has the name "FooCard 1234" the
  48 following would be printed:
  49 .Pp
  50 foo0: <FooCard 1234> on bar0
  51 .Pp
  52 bus_generic_print_child itself calls two functions
  53 .Fn bus_print_child_header
  54 and
  55 .Fn bus_print_child_footer
  56 The former prints "foo0: <FooCard 1234>" and the latter "on bar0".
  57 These routines should be used if possible in your own code if
  58 .Fn bus_generic_print_child
  59 does not completely suit your needs.
  60 .Sh SEE ALSO
  61 .Xr device 9
  62 .Sh RETURN VALUES
  63 The number of characters output.
  64 .Sh AUTHORS
  65 This man page was written by
  66 .An Doug Rabson .