draft/man3/err.3

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     From: @(#)err.3 8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/gen/err.3,v 1.11.2.5 2001/08/17 15:42:32 ru Exp $
  34 .\"
  35 .\" 2011-09-10, mtk, Converted from mdoc to man macros
  36 .\"
  37 .\" Japanese Version Copyright (c) 2003  Akihiro MOTOKI
  38 .\"         all rights reserved.
  39 .\" Translated 2003-03-10, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  40 .\"
  41 .TH ERR 3 2011-09-15 "Linux" "Linux Programmer's Manual"
  42 .\"O .SH NAME
  43 .\"O err, verr, errx, verrx, warn, vwarn, warnx, vwarnx \- formatted error messages
  44 .SH 名前
  45 err, verr, errx, verrx, warn, vwarn, warnx, vwarnx \- エラーメッセージを整形する
  46 .Nd
  47 .\"O .SH SYNOPSIS
  48 .SH 書式
  49 .nf
  50 .B #include <err.h>
  51 .sp
  52 .BI "void err(int " eval ", const char *" fmt ", ...);"
  53 .sp
  54 .BI "void errx(int " eval ", const char *" fmt ", ...);"
  55 .sp
  56 .BI "void warn(const char *" fmt ", ...);"
  57 .sp
  58 .BI "void warnx(const char *" fmt ", ...);"
  59 .sp
  60 .B #include <stdarg.h>
  61 .sp
  62 .BI "void verr(int " eval ", const char *" fmt ", va_list " args );
  63 .sp
  64 .BI "void verrx(int " eval ", const char *" fmt ", va_list " args );
  65 .sp
  66 .BI "void vwarn(const char *" fmt ", va_list " args );
  67 .sp
  68 .BI "void vwarnx(const char *" fmt ", va_list " args );
  69 .fi
  70 .\"O .SH DESCRIPTION
  71 .SH 説明
  72 .\"O The
  73 .\"O .BR err ()
  74 .\"O and
  75 .\"O .BR warn ()
  76 .\"O family of functions display a formatted error message on the standard
  77 .\"O error output.
  78 .BR err ()
  79 関数群と
  80 .BR warn ()
  81 関数群は、エラーメッセージを整形して標準エラー出力に表示する。
  82 .\"O In all cases, the last component of the program name, a colon character,
  83 .\"O and a space are output.
  84 どの関数の場合も、(ディレクトリ部分を省いた)プログラム名、
  85 コロン 1個、スペース 1個が出力される。
  86 .\"O If the
  87 .\"O .I fmt
  88 .\"O argument is not NULL, the
  89 .\"O .BR printf (3)-like
  90 .\"O formatted error message is output.
  91 .I fmt
  92 引き数が NULL でない場合、
  93 .BR printf (3)
  94 と同様に整形が行われ、エラーメッセージが出力される。
  95 .\"O The output is terminated by a newline character.
  96 出力は改行文字で終わる。
  97 .PP
  98 .\"O The
  99 .\"O .BR err (),
 100 .\"O .BR verr (),
 101 .\"O .BR warn (),
 102 .\"O and
 103 .\"O .BR vwarn ()
 104 .\"O functions append an error message obtained from
 105 .\"O .BR strerror (3)
 106 .\"O based on the global variable
 107 .\"O .IR errno ,
 108 .\"O preceded by another colon and space unless the
 109 .\"O .I fmt
 110 .\"O argument is
 111 .\"O NULL.
 112 \"O motoki: based on a code or 〜 の「a code」とは？
 113 関数
 114 .BR err (),
 115 .BR verr (),
 116 .BR warn (),
 117 .BR vwarn ()
 118 は、グローバル変数
 119 .I errno
 120 に基づいて
 121 .BR strerror (3)
 122 から得たエラーメッセージを出力する。
 123 .I fmt
 124 引き数が NULL
 125 でない場合は、一個ずつのコロンとスペースに続けて出力する。
 126 .PP
 127 .\"O The
 128 .\"O .BR errx ()
 129 .\"O and
 130 .\"O .BR warnx ()
 131 .\"O functions do not append an error message.
 132 関数
 133 .BR errx (),
 134 .BR warnx ()
 135 はエラーメッセージを付け加えない。
 136 .PP
 137 .\"O The
 138 .\"O .BR err (),
 139 .\"O .BR verr (),
 140 .\"O .BR errx (),
 141 .\"O and
 142 .\"O .BR verrx ()
 143 .\"O functions do not return, but exit with the value of the argument
 144 .\"O .I eval .
 145 関数
 146 .BR err (),
 147 .BR verr (),
 148 .BR errx (),
 149 .BR verrx ()
 150 は返り値を返さないが、引き数
 151 .I eval
 152 の値を exit status に設定し終了する。
 153 .\"O .SH EXAMPLES
 154 .SH 例
 155 .\"O Display the current
 156 .\"O .I errno
 157 .\"O information string and exit:
 158 現在の
 159 .I errno
 160 の情報を表示し、終了する:
 161 .in +4n
 162 .nf
 163
 164 if ((p = malloc(size)) == NULL)
 165     err(1, NULL);
 166 if ((fd = open(file_name, O_RDONLY, 0)) == \-1)
 167     err(1, "%s", file_name);
 168 .fi
 169 .in
 170 .PP
 171 .\"O Display an error message and exit:
 172 エラーメッセージを表示し、終了する:
 173 .in +4n
 174 .nf
 175
 176 if (tm.tm_hour < START_TIME)
 177     errx(1, "too early, wait until %s", start_time_string);
 178 .fi
 179 .in
 180 .PP
 181 .\"O Warn of an error:
 182 エラーを警告表示する:
 183 .in +4n
 184 .nf
 185
 186 if ((fd = open(raw_device, O_RDONLY, 0)) == \-1)
 187     warnx("%s: %s: trying the block device",
 188             raw_device, strerror(errno));
 189 if ((fd = open(block_device, O_RDONLY, 0)) == \-1)
 190     err(1, "%s", block_device);
 191 .fi
 192 .in
 193 .\"O .SH "CONFORMING TO"
 194 .SH 準拠
 195 .\"O These functions are nonstandard BSD extensions.
 196 これらの関数は非標準の BSD 拡張である。
 197 .\"O .\" .SH HISTORY
 198 .\" .SH 歴史
 199 .\"O .\" The
 200 .\"O .\" .BR err ()
 201 .\"O .\" and
 202 .\"O .\" .BR warn ()
 203 .\"O .\" functions first appeared in
 204 .\"O .\" 4.4BSD.
 205 .\" 関数
 206 .\" .BR err ()
 207 .\" と
 208 .\" .BR warn ()
 209 .\" は
 210 .\" 4.4BSD
 211 .\" で初めて登場した。
 212 .\"O .SH SEE ALSO
 213 .SH 関連項目
 214 .BR error (3),
 215 .BR exit (3),
 216 .BR perror (3),
 217 .BR printf (3),
 218 .BR strerror (3)