share/man/man9/bus_generic_print_child.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/bus_generic_print_child.9,v 1.5.2.4 2001/12/17 11:30:18 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/bus_generic_print_child.9,v 1.5 2008/11/23 21:55:52 swildner Exp $
  29 .\"
  30 .Dd June 16, 1998
  31 .Dt BUS_GENERIC_PRINT_CHILD 9
  32 .Os
  33 .Sh NAME
  34 .Nm bus_generic_print_child
  35 .Nd generic implementation of
  36 .Dv DEVICE_PRINT_CHILD
  37 for busses
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/bus.h
  41 .Ft int
  42 .Fn bus_generic_print_child "device_t dev" "device_t child"
  43 .Sh DESCRIPTION
  44 This implementation prints out the default device announcement message.
  45 Given device 'foo0' on bus 'bar0' where foo0 has the name "FooCard 1234" the
  46 following would be printed:
  47 .Pp
  48 foo0: <FooCard 1234> on bar0
  49 .Pp
  50 .Fn bus_generic_print_child
  51 itself calls two functions ,
  52 .Fn bus_print_child_header
  53 and
  54 .Fn bus_print_child_footer .
  55 The former prints "foo0: <FooCard 1234>" and the latter "on bar0".
  56 These routines should be used if possible in your own code if
  57 .Fn bus_generic_print_child
  58 does not completely suit your needs.
  59 .Sh RETURN VALUES
  60 The number of characters output.
  61 .Sh SEE ALSO
  62 .Xr device 9
  63 .Sh AUTHORS
  64 This man page was written by
  65 .An Doug Rabson .