[linuxjm/LDP_man-pages.git] / release / man3 / fmtmsg.3

.\"  Copyright 2002 walter harms (walter.harms@informatik.uni-oldenburg.de)
.\"  Distributed under GPL
.\"  adapted glibc info page
.\"
.\"  This should run as 'Guru Meditation' (amiga joke :)
.\"  The function is quite complex and deserves an example
.\"
.\"  Polished, aeb, 2003-11-01
.\"
.\" Japanese Version Copyright (c) 2004 Yuichi SATO
.\"         all rights reserved.
.\" Translated Sat Jul 24 20:19:54 JST 2004
.\"         by Yuichi SATO <ysato444@yahoo.co.jp>
.\"
.TH FMTMSG 3 2008-06-14 "" "Linux Programmer's Manual"
.SH ̾Á°
fmtmsg \- À°·Á¤µ¤ì¤¿¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤òɽ¼¨¤¹¤ë
.SH ½ñ¼°
.nf
.B #include <fmtmsg.h>
.sp
.BI "int fmtmsg(long " classification ", const char *" label ,
.br
.BI "           int " severity ", const char *" text ,
.br
.BI "           const char *" action ", const char *" tag );
.fi
.SH ÀâÌÀ
¤³¤Î´Ø¿ô¤Ï¡¢°ú¤­¿ô¤Çµ­½Ò¤µ¤ì¤¿¥á¥Ã¥»¡¼¥¸¤ò¡¢
.I classification
°ú¤­¿ô¤Ç»ØÄꤵ¤ì¤¿¥Ç¥Ð¥¤¥¹¾å¤Ëɽ¼¨¤¹¤ë¡£
.I stderr
¤Ë½ñ¤­½Ð¤µ¤ì¤ë¥á¥Ã¥»¡¼¥¸¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤Ï¡¢
.B MSGVERB
´Ä¶­ÊÑ¿ô¤Ë°Í¸¤¹¤ë¡£
.LP
.I label
°ú¤­¿ô¤Ï¥á¥Ã¥»¡¼¥¸¤ÎȯÀ¸¸»¤ò¼±Ê̤¹¤ë¡£
¤³¤Îʸ»úÎó¤Ï¥³¥í¥ó¤Ç¶èÀÚ¤é¤ì¤¿ 2 ¤Ä¤ÎÉôʬ¤«¤é¹½À®¤µ¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
1 ¤ÄÌܤÎÉôʬ¤Ï 10 ʸ»ú°ÊÆâ¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤º¡¢
2 ¤ÄÌܤÎÉôʬ¤Ï 14 ʸ»ú°ÊÆâ¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.LP
.I text
°ú¤­¿ô¤Ë¤Ï¥¨¥é¡¼¾ò·ï¤òµ­½Ò¤¹¤ë¡£
.LP
.I action
°ú¤­¿ô¤Ë¤Ï¥¨¥é¡¼¤«¤é²óÉü¤¹¤ë¤¿¤á¤ËÍøÍѲÄǽ¤Ê¥¹¥Æ¥Ã¥×¤òµ­½Ò¤¹¤ë¡£
¤³¤ì¤¬É½¼¨¤µ¤ì¤ë¾ì¹ç¡¢"TO FIX: " ¤¬Á°¤ËÉÕ¤¯¡£
.LP
.I tag
°ú¤­¿ô¤Ï¤è¤ê¿¤¯¤Î¾ðÊó¤ò¸«¤Ä¤±¤ë¤¿¤á¤Î¥ª¥ó¥é¥¤¥ó¥É¥­¥å¥á¥ó¥È¤Ø¤Î»²¾È¤Ç¤¢¤ë¡£
¤³¤ì¤Ï
.I label
Ãͤȥæ¥Ë¡¼¥¯¤Ê¼±ÊÌÈÖ¹æ¤ò´Þ¤ó¤Ç¤¤¤ë¤Ù¤­¤Ç¤¢¤ë¡£
.SS ¥À¥ß¡¼°ú¤­¿ô
³Æ°ú¤­¿ô¤Ë¤Ï¥À¥ß¡¼¤ÎÃͤòÆþ¤ì¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
¥À¥ß¡¼¤Î
.I classification
ÃÍ
.B MM_NULLMC
(0L) ¤Ï½ÐÎϤò²¿¤â»ØÄꤷ¤Ê¤¤¡£¤½¤Î¤¿¤á²¿¤âɽ¼¨¤µ¤ì¤Ê¤¤¡£
¥À¥ß¡¼¤Î
.I severity
ÃÍ
.B NO_SEV
(0) ¤Ï½ÅÂçÅÙ (severity) ¤¬Í¿¤¨¤é¤ì¤Æ¤¤¤Ê¤¤¤³¤È¤òɽ¤¹¡£
ÃÍ
.BR MM_NULLLBL ,
.BR MM_NULLTXT ,
.BR MM_NULLACT ,
.B MM_NULLTAG
¤Ï
.I "((char *) 0)"
¤È¶õʸ»úÎó¤ÎÊÌ̾¤Ç¤¢¤ê¡¢
.B MM_NULLSEV
¤Ï
.B NO_SEV
¤ÎÊÌ̾¤Ç¤¢¤ë¡£
.SS "classification °ú¤­¿ô"
.I classification
°ú¤­¿ô¤Ï 4 ¼ïÎà¤Î¾ðÊó¤òµ­½Ò¤¹¤ëÃͤÎϤǤ¢¤ë¡£
.br
.sp
ºÇ½é¤ÎÃͤϽÐÎÏ¥Á¥ã¥ó¥Í¥ë¤òÄêµÁ¤¹¤ë¡£
.TP 12n
.B MM_PRINT
.I stderr
¤Ë½ÐÎϤ¹¤ë¡£
.TP
.B MM_CONSOLE
¥·¥¹¥Æ¥à¥³¥ó¥½¡¼¥ë¤Ë½ÐÎϤ¹¤ë¡£
.TP
.B "MM_PRINT | MM_CONSOLE"
ξÊý¤Ë½ÐÎϤ¹¤ë¡£
.PP
2 ÈÖÌܤÎÃͤϥ¨¥é¡¼¤ÎȯÀ¸¸»¤Ç¤¢¤ë:
.TP 12n
.B MM_HARD
¥Ï¡¼¥É¥¦¥§¥¢¥¨¥é¡¼¤¬µ¯¤³¤Ã¤¿¡£
.TP
.B MM_FIRM
¥Õ¥¡¡¼¥à¥¦¥§¥¢¥¨¥é¡¼¤¬µ¯¤³¤Ã¤¿¡£
.TP
.B MM_SOFT
¥½¥Õ¥È¥¦¥§¥¢¥¨¥é¡¼¤¬µ¯¤³¤Ã¤¿¡£
.PP
3 ÈÖÌܤÎÃͤÏÌäÂê¤Î¸¡ÃΤò¹Ô¤Ã¤¿¤â¤Î¤ò¥¨¥ó¥³¡¼¥É¤¹¤ë:
.TP 12n
.B MM_APPL
¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ë¤è¤Ã¤Æ¸¡ÃΤµ¤ì¤¿¡£
.TP
.B MM_UTIL
¥æ¡¼¥Æ¥£¥ê¥Æ¥£¤Ë¤è¤Ã¤Æ¸¡ÃΤµ¤ì¤¿¡£
.TP
.B MM_OPSYS
¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à¤Ë¤è¤Ã¤Æ¸¡ÃΤµ¤ì¤¿¡£
.PP
4 ÈÖÌܤÎÃͤÏÌäÂê¤Î½ÅÂçÅÙ¤òɽ¤¹:
.TP 12n
.B MM_RECOVER
²óÉü²Äǽ¤Ê¥¨¥é¡¼¤Ç¤¢¤ë¡£
.TP
.B MM_NRECOV
²óÉüÉÔ²Äǽ¤Ê¥¨¥é¡¼¤Ç¤¢¤ë¡£
.SS "severity °ú¤­¿ô"
.I severity
°ú¤­¿ô¤Ï°Ê²¼¤Î 1 ¤Ä¤ÎÃͤò¤È¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.TP 12n
.B MM_NOSEV
½ÅÂçÅÙ¤Ïɽ¼¨¤µ¤ì¤Ê¤¤¡£
.TP
.B MM_HALT
¤³¤ÎÃÍ¤Ï HALT ¤È¤·¤Æɽ¼¨¤µ¤ì¤ë¡£
.TP
.B MM_ERROR
¤³¤ÎÃÍ¤Ï ERROR ¤È¤·¤Æɽ¼¨¤µ¤ì¤ë¡£
.TP
.B MM_WARNING
¤³¤ÎÃÍ¤Ï WARNING ¤È¤·¤Æɽ¼¨¤µ¤ì¤ë¡£
.TP
.B MM_INFO
¤³¤ÎÃÍ¤Ï INFO ¤È¤·¤Æɽ¼¨¤µ¤ì¤ë¡£
.PP
¿ôÃͤξì¹ç¤Ï 0 ¤«¤é 4 ¤Ç¤¢¤ë¡£
.BR addseverity (3)
¤Þ¤¿¤Ï´Ä¶­ÊÑ¿ô
.B SEV_LEVEL
¤ò»È¤¦¤³¤È¤Ë¤è¤ê¡¢É½¼¨¤¹¤ë¥ì¥Ù¥ë¤Èʸ»úÎó¤ò¹¹¤ËÄɲäǤ­¤ë¡£
.SH ÊÖ¤êÃÍ
´Ø¿ô¤Ï 4 ¤Ä¤ÎÃͤòÊÖ¤¹:
.TP 12n
.B MM_OK
Á´¤Æ¤¬¤¦¤Þ¤¯¤¤¤Ã¤¿¡£
.TP
.B MM_NOTOK
´°Á´¤Ë¼ºÇÔ¤·¤¿¡£
.TP
.B MM_NOMSG
.I stderr
¤Ë½ñ¤­¹þ¤à¤È¤­¤Ë¥¨¥é¡¼¤¬µ¯¤³¤Ã¤¿¡£
.TP
.B MM_NOCON
¥³¥ó¥½¡¼¥ë¤Ë½ñ¤­¹þ¤à¤È¤­¤Ë¥¨¥é¡¼¤¬µ¯¤³¤Ã¤¿¡£
.SH ´Ä¶­ÊÑ¿ô
´Ä¶­ÊÑ¿ô
.B MSGVERB
("message verbosity") ¤Ï
.I stderr
¤Ø¤Î½ÐÎϤΰìÉô¤òÍÞÀ©¤¹¤ë¤Î¤Ë»È¤¦¤³¤È¤¬¤Ç¤­¤ë¡£
(¥³¥ó¥½¡¼¥ë¤Ø¤Î½ÐÎϤˤϱƶÁ¤·¤Ê¤¤¡£)
¤³¤ÎÊÑ¿ô¤¬ÄêµÁ¤µ¤ì¤Æ¡¢NULL ¤Ç¤Ê¤¯¡¢
¥³¥í¥ó¤Ç¶èÀÚ¤é¤ì¤¿Í­¸ú¤Ê¥­¡¼¥ï¡¼¥É¤Î¥ê¥¹¥È¤Ç¤¢¤ë¾ì¹ç¡¢
¥­¡¼¥ï¡¼¥É¤ËÂбþ¤¹¤ë¥á¥Ã¥»¡¼¥¸¤Î°ìÉô¤Î¤ß¤¬É½¼¨¤µ¤ì¤ë¡£
Í­¸ú¤Ê¥­¡¼¥ï¡¼¥É¤Ï "label", "severity", "text", "action", "tag" ¤Ç¤¢¤ë¡£
.PP
´Ä¶­ÊÑ¿ô
.B SEV_LEVEL
¤Ï¿·¤·¤¤½ÅÂçÅÙ¥ì¥Ù¥ë¤òƳÆþ¤¹¤ë¤Î¤Ë»ÈÍѤǤ­¤ë¡£
¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¡¢¾åµ­¤Î 5 ¤Ä¤Î½ÅÂçÅÙ¥ì¥Ù¥ë¤Î¤ß¤¬ÍøÍѲÄǽ¤Ç¤¢¤ë¡£
¾¤Î¿ôÃͤξì¹ç¡¢
.BR fmtmsg ()
¤Ï²¿¤âɽ¼¨¤·¤Ê¤¤¡£
.BR fmtmsg ()
¤ò½é¤á¤Æ¸Æ¤Ó½Ð¤¹Á°¤Ë¡¢¥æ¡¼¥¶¤¬
.B SEV_LEVEL
¤ò
.sp
.RS
SEV_LEVEL=[description[:description[:...]]]
.RE
.sp
¤Î¤è¤¦¤Ê·Á¼°¤Ç¥×¥í¥»¥¹¤Î´Ä¶­¤ËÀßÄꤹ¤ë¤È¡¢
.BR fmtmsg ()
¤Ï (ɸ½à¤Î¥ì¥Ù¥ë 0-4 ¤Ë²Ã¤¨¤Æ) level ¤Ë»ØÄꤵ¤ì¤¿Ãͤâ¼õ¤±ÉÕ¤±¡¢
¤½¤Î¤è¤¦¤Ê¥ì¥Ù¥ë¤ÎÌäÂ꤬ȯÀ¸¤¹¤ë¤È»ØÄꤵ¤ì¤¿ printstring ¤òɽ¼¨¤¹¤ë¡£
³Æ description ¤Ï
.sp
.RS
severity-keyword,level,printstring
.RE
.sp
¤È¤¤¤¦·Á¼°¤Ç¤¢¤ë¡£
.LP
severity-keyword Éô¤Ï
.BR fmtmsg ()
¤Ë»ÈÍѤµ¤ì¤Ê¤¤¤¬¡¢Â¸ºß¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
level Éô¤Ï¿ôÃͤòʸ»úÎó¤Çɽ¤·¤¿¤â¤Î¤Ç¤¢¤ë¡£
¿ôÃÍ¤Ï 4 ¤è¤êÂ礭¤¤ÃͤǤʤ±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
¤³¤ÎÃͤÏ
.BR fmtmsg ()
¤Î severity °ú¤­¿ô¤Ç»ÈÍѤµ¤ì¤Ê¤±¤ì¤Ð¤Ê¤é¤º¡¢¤³¤Î½ÅÂçÅÙ¤òÁªÂò¤¹¤ë¡£
Á°¤â¤Ã¤ÆÀë¸À¤µ¤ì¤¿½ÅÂçÅÙ¤ò¾å½ñ¤­¤¹¤ë¤³¤È¤Ï¤Ç¤­¤Ê¤¤¡£
printstring ¤Ï¡¢
¤³¤Î½ÅÂçÅ٤Υá¥Ã¥»¡¼¥¸¤¬
.BR fmtmsg ()
¤Ë¤è¤Ã¤ÆÀ¸À®¤µ¤ì¤¿¾ì¹ç¤Ëɽ¼¨¤µ¤ì¤ëʸ»úÎó¤Ç¤¢¤ë¡£
.SH ¥Ð¡¼¥¸¥ç¥ó
.BR fmtmsg ()
¤Ï¡¢¥Ð¡¼¥¸¥ç¥ó 2.1 °Ê¹ß¤Î glibc ¤ÇÄ󶡤µ¤ì¤Æ¤¤¤ë¡£
.SH ½àµò
´Ø¿ô
.BR fmtmsg ()
¤È
.BR addseverity (3)
¤È´Ä¶­ÊÑ¿ô
.B MSGVERB
¤È
.B SEV_LEVEL
¤Ï System V ¤ËͳÍ褷¤Æ¤¤¤ë¡£
´Ø¿ô
.BR fmtmsg ()
¤È´Ä¶­ÊÑ¿ô
.B MSGVERB
¤Ï POSIX.1-2001 ¤Ëµ­½Ò¤µ¤ì¤Æ¤¤¤ë¡£
.SH Ãí°Õ
System V ¤È Unixware ¤Î man ¥Ú¡¼¥¸¤Ë¤Ï¡¢
¡Ö¤³¤ì¤é¤Î´Ø¿ô¤Ï "pfmt() ¤È addsev()"
¤Þ¤¿¤Ï "pfmt(), vpfmt(), lfmt(), vlfmt()" ¤ÇÃÖ¤­´¹¤¨¤é¤ì¤Æ¤ª¤ê¡¢
¾­Íè¤Ïºï½ü¤µ¤ì¤ëͽÄê¤Ç¤¢¤ë¡×¤È½ñ¤«¤ì¤Æ¤¤¤ë¡£
.SH Îã
.nf
#include <stdio.h>
#include <stdlib.h>
#include <fmtmsg.h>

int
main(void)
{
    long class = MM_PRINT | MM_SOFT | MM_OPSYS | MM_RECOVER;
    int err;

    err = fmtmsg(class, "util\-linux:mount", MM_ERROR,
                "unknown mount option", "See mount(8).",
                "util\-linux:mount:017");
    switch (err) {
    case MM_OK:
      break;
    case MM_NOTOK:
        printf("Nothing printed\en");
        break;
    case MM_NOMSG:
        printf("Nothing printed to stderr\en");
        break;
    case MM_NOCON:
        printf("No console output\en");
        break;
    default:
        printf("Unknown error from fmtmsg()\en");
    }
    exit(EXIT_SUCCESS);
}
.fi
.PP
½ÐÎϤÏ
.nf

    util\-linux:mount: ERROR: unknown mount option
    TO FIX: See mount(8).  util\-linux:mount:017

.fi
¤Î¤è¤¦¤Ë¤Ê¤ê¡¢
.nf

    MSGVERB=text:action; export MSGVERB

.fi
¤ò¼Â¹Ô¤·¤¿¸å¤Ç¤Ï
.nf

    unknown mount option
    TO FIX: See mount(8).

.fi
¤È¤Ê¤ë¡£
.SH ´ØÏ¢¹àÌÜ
.BR addseverity (3),
.BR perror (3)