contrib/libxo/libxo/xo_error.3

   1 .\" #
   2 .\" # Copyright (c) 2014, Juniper Networks, Inc.
   3 .\" # All rights reserved.
   4 .\" # This SOFTWARE is licensed under the LICENSE provided in the
   5 .\" # ../Copyright file. By downloading, installing, copying, or
   6 .\" # using the SOFTWARE, you agree to be bound by the terms of that
   7 .\" # LICENSE.
   8 .\" # Phil Shafer, July 2014
   9 .\"
  10 .Dd December 4, 2014
  11 .Dt LIBXO 3
  12 .Os
  13 .Sh NAME
  14 .Nm xo_error
  15 .Nd generate simple error messages in multiple output styles
  16 .Sh LIBRARY
  17 .Lb libxo
  18 .Sh SYNOPSIS
  19 .In libxo/xo.h
  20 .Ft void
  21 .Fn xo_error "const char *fmt" "..."
  22 .Sh DESCRIPTION
  23 Use the
  24 .Fn xo_error
  25 function to generate error messages to standard error.
  26 The
  27 .Fa fmt
  28 argument is a string containing printf-style formatting
  29 instructions that describe the remaining arguments.
  30 .Pp
  31 When converting an application to
  32 .Nm libxo ,
  33 one can replace
  34 .Em "fprintf(stderr,...)"
  35 calls with
  36 .Fn xo_error
  37 calls.
  38 .Sh SEE ALSO
  39 .Xr printf 3 ,
  40 .Xr xo_emit 3 ,
  41 .Xr libxo 3
  42 .Sh HISTORY
  43 The
  44 .Nm libxo
  45 library first appeared in
  46 .Fx 11.0 .
  47 .Sh AUTHORS
  48 .Nm libxo
  49 was written by
  50 .An Phil Shafer Aq Mt phil@freebsd.org .
  51