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