2 .\" Copyright (c) 2001 Andrew R. Reiter
3 .\" Copyright (c) 2004 Joerg Wunsch
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" $FreeBSD: src/share/man/man9/printf.9,v 1.8 2006/09/08 14:05:03 ru Exp $
43 .Nd formatted output conversion
48 .Fn kprintf "const char *format" ...
50 .Fn ksprintf "char *str" "const char *format" ...
52 .Fn ksnprintf "char *str" "size_t size" "const char *format" ...
54 .Fn kvprintf "const char *format" "__va_list ap"
56 .Fn kvsprintf "char *str" "const char *format" "__va_list ap"
58 .Fn kvsnprintf "char *str" "size_t size" "const char *format" "__va_list ap"
60 .Fn krateprintf "struct krate *rate" "const char *format" ...
62 .Fn tprintf "struct proc *p" "int pri" "const char *format" ...
64 .Fn uprintf "const char *format" ...
67 .Fn log "int pri" "const char *format" ...
71 family of functions are similar to the
74 The different functions each use a different output stream.
77 function outputs to the current process' controlling tty, while
85 write to the console as well as to the logging facility.
88 function outputs to the tty associated with the process
90 and the logging facility if
95 function sends the message to the kernel logging facility, using
96 the log level as indicated by
99 Each of these related functions use the
105 parameters in the same manner as
109 functions add another conversion specifier to
114 identifier expects two arguments: an
118 These are used as a register value and a print mask for decoding bitmasks.
119 The print mask is made up of two parts: the base and the
121 The base value is the output base expressed as an integer value;
122 for example, \e10 gives octal and \e20 gives hexadecimal.
123 The arguments are made up of a sequence of bit identifiers.
124 Each bit identifier begins with an integer value which is the number of the
125 bit (starting from 1) this identifier describes.
126 The rest of the identifier is a string of characters containing the name of
128 The string is terminated by either the bit number at the start of the next
131 for the last bit identifier.
143 parameter (mistakenly called
148 of \-1 is given, the message will be appended to the last log message
149 started by a previous call to
151 As these messages are generated by the kernel itself, the facility will
157 function is a rate controlled version of
165 must be initialized with the desired reporting frequency.
168 of 0 will result in no output.
171 to a negative value allows an initial burst.
184 functions return the number of characters displayed.
186 This example demonstrates the use of the
190 conversion specifiers.
192 .Bd -literal -offset indent
197 kprintf("reg=%b\en", 3, "\e10\e2BITTWO\e1BITONE\en");
201 will produce the following output:
202 .Bd -literal -offset indent
207 .Bd -literal -offset indent
208 log(LOG_DEBUG, "%s%d: been there.\en", sc->sc_name, sc->sc_unit);
211 will add the appropriate debug message at priority