share/man/man9/device_printf.9

   1 .\"
   2 .\" Copyright (c) 2003 M. Warner Losh
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  19 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  21 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  22 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd April 21, 2003
  29 .Dt DEVICE_PRINTF 9
  30 .Os
  31 .Sh NAME
  32 .Nm device_printf
  33 .Nd formatted output conversion
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In sys/bus.h
  37 .Ft int
  38 .Fn device_printf "device_t dev" "const char *fmt" ...
  39 .Sh DESCRIPTION
  40 The
  41 .Fn device_printf
  42 function is a convenience interface to the
  43 .Xr printf 9
  44 function.
  45 It outputs the name of the
  46 .Fa dev
  47 device, followed by a colon and a space, and then what
  48 .Xr printf 9
  49 would print if you passed
  50 .Fa fmt
  51 and the remaining arguments to it.
  52 .Sh RETURN VALUES
  53 The
  54 .Fn device_printf
  55 function returns the number of characters displayed.
  56 .Sh SEE ALSO
  57 .Xr printf 3 ,
  58 .Xr printf 9