From 96cf8dffe4f7b0b910f790066ae622dc429eb522 Mon Sep 17 00:00:00 2001 From: Jannis Hoffmann Date: Tue, 9 Jul 2024 13:02:45 +0200 Subject: initial commit of version 23 --- man/x.html | 99 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 man/x.html (limited to 'man/x.html') diff --git a/man/x.html b/man/x.html new file mode 100644 index 0000000..224edc1 --- /dev/null +++ b/man/x.html @@ -0,0 +1,99 @@ + + +
+
+SYNTAX
+       #include "logmsg.h"
+
+       int logmsg(const char *who, int ecode, unsigned int classs, char *msg)
+
+       err_sys(w,e) logmsg(w,e,FATAL,"")
+       err_sys_plus(w,e,m) logmsg(w,e,FATAL,m)
+       err_tmp(w,e) logmsg(w,e,WARN,"")
+       err_tmp_plus(w,e,m) logmsg(w,e,WARN,m)
+       err_int(w,e,c) logmsg(w,e,c,"")
+       err_int_plus(w,e,c,m) logmsg(w,e,c,m)
+       log_who(w,m) logmsg(w,0,LOG,m)
+       log_anon(m) logmsg("",0,LOG,m)
+
+DESCRIPTION
+       logmsg  prints  error,  warning, or info/logging messages to stderr and
+       potentially terminates the calling  program,  depending  on  the  class
+       given.   who  is the name of the program, ecode is an error code, class
+       determines the behavior upon call and msg is the logging message.  Read
+       "error.h" to learn more about related constants.
+
+ECODE
+       ecode is the error code and subject to be displayed in the log file and
+       potentially used upon exit if the class equals ERROR, FATAL, or DROP.
+
+       To avoid conflicts with syscall error codes, appplication defined error
+       codes  should  be negative.  The values -15, -100 and -111 are reserved
+       for backward compatibility.
+
+CLASS
+       The class parameter indicates how the  application  handles  exceptions
+       and displays the log message.
+
+       o   LOG, INFO, ALERT, WARN - display message and continue operation
+
+       o   DROP  - display warning message and continue while returning to the
+           calling program
+
+       o   USAGE, SYNTAX, FATAL, ERROR - display error message and exit appli‐
+           cation with error code
+
+       INFO,  ALERT, WARN, DROP, USAGE, and FATAL as well as ERROR display the
+       respective class string like warning: in the  log  message,  while  LOG
+       shows the log message only.
+
+       The  class FATAL should be used for system error codes only, rather ER‐
+       ROR and WARN shall be  set  in  conjunction  with  an  application  er‐
+       ror/warning.
+
+MESSAGE
+       If the custom message msg is given, it will be printed additionally.
+
+       Dan  Bernstein  used sets of strerr_dieY*() and strerr_warnY() messages
+       which explicitely determine the  message  and  behavior  class.   Other
+       classes were occasionally defined on demand, such als usage().
+
+       Kai  Peter introduced the errmsg facility in his qlibs including a sys‐
+       log compliant severity as second parameter.
+
+EXAMPLES
+       The macro definitions uses  w for the  calling  program,  e  for  error
+       code, c for class, and m for message.
+
+         #include "logmsg.h"
+         #define WHO "my_prog"
+
+         err_sys(WHO,errno);
+         err_sys_plus(WHO,-111,"additional message");
+
+         err_tmp("",-100);
+         err_tmp_plus("",errno,"additional message");
+
+         log_who(WHO,"message");
+
+       log_anon() is like log_who() but doesn't print the caller name.
+
+       An user defined message s can be build from multiple arguments by using
+       the B (build) macro:
+
+         err_sys_plus((errno),B("unable to run: ",*argv));
+
+SEE ALSO
+       syslog(3)
+
+
+
+                                       3                        qlibs:(logmsg)
+
+
+
+Man(1) output converted with +man2html +
+ + -- cgit v1.2.3