share/man/man9/printf.9

   1 .\"
   2 .\" Copyright (c) 2001 Andrew R. Reiter
   3 .\" Copyright (c) 2004 Joerg Wunsch
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   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.
  14 .\"
  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
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd May 9, 2020
  30 .Dt PRINTF 9
  31 .Os
  32 .Sh NAME
  33 .Nm printf ,
  34 .Nm uprintf ,
  35 .Nm tprintf ,
  36 .Nm log
  37 .Nd formatted output conversion
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/systm.h
  41 .Ft int
  42 .Fn printf "const char *fmt" ...
  43 .Ft void
  44 .Fn tprintf "struct proc *p" "int pri" "const char *fmt" ...
  45 .Ft int
  46 .Fn uprintf "const char *fmt" ...
  47 .Ft int
  48 .Fn vprintf "const char *fmt" "va_list ap"
  49 .In sys/syslog.h
  50 .Ft void
  51 .Fn log "int pri" "const char *fmt" ...
  52 .Ft void
  53 .Fn vlog "int pri" "const char *fmt" "va_list ap"
  54 .Sh DESCRIPTION
  55 The
  56 .Xr printf 9
  57 family of functions are similar to the
  58 .Xr printf 3
  59 family of functions.
  60 The different functions each use a different output stream.
  61 The
  62 .Fn uprintf
  63 function outputs to the current process' controlling tty, while
  64 .Fn printf
  65 writes to the console as well as to the logging facility.
  66 The
  67 .Fn tprintf
  68 function outputs to the tty associated with the process
  69 .Fa p
  70 and the logging facility if
  71 .Fa pri
  72 is not \-1.
  73 The
  74 .Fn log
  75 function sends the message to the kernel logging facility, using
  76 the log level as indicated by
  77 .Fa pri ,
  78 and to the console if no process is yet reading the log.
  79 .Pp
  80 Each of these related functions use the
  81 .Fa fmt
  82 parameter in the same manner as
  83 .Xr printf 3 .
  84 However,
  85 .Xr printf 9
  86 adds two other conversion specifiers and omits one.
  87 .Pp
  88 The
  89 .Cm \&%b
  90 identifier expects two arguments: an
  91 .Vt int
  92 and a
  93 .Vt "char *" .
  94 These are used as a register value and a print mask for decoding bitmasks.
  95 The print mask is made up of two parts: the base and the
  96 arguments.
  97 The base value is the output base expressed as an integer value;
  98 for example, \e10 gives octal and \e20 gives hexadecimal.
  99 The arguments are made up of a sequence of bit identifiers.
 100 Each bit identifier begins with an integer value which is the number of the
 101 bit (starting from 1) this identifier describes.
 102 The rest of the identifier is a string of characters containing the name of
 103 the bit.
 104 The string is terminated by either the bit number at the start of the next
 105 bit identifier or
 106 .Dv NUL
 107 for the last bit identifier.
 108 .Pp
 109 The
 110 .Cm \&%D
 111 identifier is meant to assist in hexdumps.
 112 It requires two arguments: a
 113 .Vt "u_char *"
 114 pointer and a
 115 .Vt "char *"
 116 string.
 117 The memory pointed to by the pointer is output in hexadecimal one byte at
 118 a time.
 119 The string is used as a delimiter between individual bytes.
 120 If present, a width directive will specify the number of bytes to display.
 121 By default, 16 bytes of data are output.
 122 .Pp
 123 The
 124 .Cm \&%n
 125 conversion specifier is not supported.
 126 .Pp
 127 The
 128 .Fn log
 129 function uses
 130 .Xr syslog 3
 131 level values
 132 .Dv LOG_DEBUG
 133 through
 134 .Dv LOG_EMERG
 135 for its
 136 .Fa pri
 137 parameter (mistakenly called
 138 .Sq priority
 139 here).
 140 Alternatively, if a
 141 .Fa pri
 142 of \-1 is given, the message will be appended to the last log message
 143 started by a previous call to
 144 .Fn log .
 145 As these messages are generated by the kernel itself, the facility will
 146 always be
 147 .Dv LOG_KERN .
 148 .Sh RETURN VALUES
 149 The
 150 .Fn printf
 151 and the
 152 .Fn uprintf
 153 functions return the number of characters displayed.
 154 .Sh EXAMPLES
 155 This example demonstrates the use of the
 156 .Cm \&%b
 157 and
 158 .Cm \&%D
 159 conversion specifiers.
 160 The function
 161 .Bd -literal -offset indent
 162 void
 163 printf_test(void)
 164 {
 165
 166         printf("reg=%b\en", 3, "\e10\e2BITTWO\e1BITONE");
 167         printf("out: %4D\en", "AAAA", ":");
 168 }
 169 .Ed
 170 .Pp
 171 will produce the following output:
 172 .Bd -literal -offset indent
 173 reg=3<BITTWO,BITONE>
 174 out: 41:41:41:41
 175 .Ed
 176 .Pp
 177 The call
 178 .Bd -literal -offset indent
 179 log(LOG_DEBUG, "%s%d: been there.\en", sc->sc_name, sc->sc_unit);
 180 .Ed
 181 .Pp
 182 will add the appropriate debug message at priority
 183 .Dq Li kern.debug
 184 to the system log.
 185 .Sh SEE ALSO
 186 .Xr printf 3 ,
 187 .Xr syslog 3