release/man3/strftime.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\"     GNU texinfo documentation on glibc date/time functions.
  30 .\" Modified Sat Jul 24 18:03:44 1993 by Rik Faith (faith@cs.unc.edu)
  31 .\" Applied fix by Wolfgang Franke, aeb, 961011
  32 .\" Corrected return value, aeb, 970307
  33 .\" Added Single UNIX Spec conversions and %z, aeb/esr, 990329.
  34 .\" 2005-11-22 mtk, added Glibc Notes covering optional 'flag' and
  35 .\"           'width' components of conversion specifications.
  36 .\"
  37 .\"*******************************************************************
  38 .\"
  39 .\" This file was generated with po4a. Translate the source file.
  40 .\"
  41 .\"*******************************************************************
  42 .TH STRFTIME 3 2013\-06\-28 GNU "Linux Programmer's Manual"
  43 .SH 名前
  44 strftime \- 日付および時刻の文字列への変換
  45 .SH 書式
  46 .nf
  47 \fB#include <time.h>\fP
  48 .sp
  49 \fBsize_t strftime(char *\fP\fIs\fP\fB, size_t \fP\fImax\fP\fB, const char *\fP\fIformat\fP\fB,\fP
  50 \fB                const struct tm *\fP\fItm\fP\fB);\fP
  51 .fi
  52 .SH 説明
  53 .\" FIXME POSIX says: Local timezone information is used as though
  54 .\" strftime() called tzset().  But this doesn't appear to be the case
  55 \fBstrftime\fP()  関数 は、要素別の時刻 \fItm\fP の内容を \fIformat\fP で指定された書式指定にしたがって変換し、 長さ
  56 \fImax\fP の文字列 \fIs\fP に書き込む。
  57 .PP
  58 書式指定は NULL 終端された文字列であり、 「変換指定 (conversion specification)」と呼ばれる特別な文字列を
  59 含まることができる。 各々の変換指定は \(aq%\(aq 文字で始まり、 「変換指定文字 (conversion specifier
  60 character)」と呼ばれる 何らか他の文字で終端される。上記以外の全ての文字列は 「通常の文字列 (ordinary character
  61 sequence)」となる。
  62 .PP
  63 (NULL バイトも含む) 通常の文字列内の文字は、 そのまま \fIformat\fP から \fIs\fP にコピーされる。
  64 一方、変換指定の文字は以下のように置換される。
  65 .TP
  66 \fB%a\fP
  67 現在のロケールにおける曜日の省略名。
  68 .TP
  69 \fB%A\fP
  70 現在のロケールにおける曜日の完全な名前。
  71 .TP
  72 \fB%b\fP
  73 現在のロケールにおける月の省略名。
  74 .TP
  75 \fB%B\fP
  76 現在のロケールにおける月の完全な名前。
  77 .TP
  78 \fB%c\fP
  79 現在のロケールにおいて一般的な日付・時刻の表記。
  80 .TP
  81 \fB%C\fP
  82 世紀 (西暦年の上 2 桁)。 (SU)
  83 .TP
  84 \fB%d\fP
  85 月内通算日 (10 進数表記) (01\-31)。
  86 .TP
  87 \fB%D\fP
  88 \fB%m/%d/%y\fP と等価。(うえっ、アメリカ専用だ。アメリカ以外の国では \fB%d/%m/%y\fP
  89 の方が一般的だ。紛らわしいので、使用すべきではない。) (SU)
  90 .TP
  91 \fB%e\fP
  92 \fB%d\fP と同様に月内通算日を 10 進数で表現するが、 1 桁の場合 10 の位にゼロを置かずスペースを置く。(SU)
  93 .TP
  94 \fB%E\fP
  95 別形式を使用する際の修飾子。下記参照。 (SU)
  96 .TP
  97 \fB%F\fP
  98 \fB%Y\-%m\-%d\fP と等価 (ISO\ 8601 形式の日付フォーマット)。 (C99)
  99 .TP
 100 \fB%G\fP
 101 ISO\ 8601 週単位表記の年 (week\-based year; 「注意」の節を参照)。 世紀も 10 進数で表す。 ISO 週番号 (\fB%V\fP
 102 を参照) に対応した 4 桁の西暦年。 これは基本的には \fB%Y\fP と同じ形式だが、ISO 週数が前年や翌年になる
 103 場合にはその年が使用される点が異なる。(TZ)
 104 .TP
 105 \fB%g\fP
 106 \fB%G\fP と同様。但し、世紀を含まず下 2 桁のみを表示 (00\-99)。 (TZ)
 107 .TP
 108 \fB%h\fP
 109 \fB%b\fP と等価 (SU)
 110 .TP
 111 \fB%H\fP
 112 24 時間表記での時 (hour)。 (00\-23)
 113 .TP
 114 \fB%I\fP
 115 12 時間表記での時 (hour)。 (01\-12)
 116 .TP
 117 \fB%j\fP
 118 年の初めから通算の日数。 (001\-366)
 119 .TP
 120 \fB%k\fP
 121 24 時間表記での時 (0\-23)。 1 桁の場合には前にゼロでなくスペースが置かれる。 (\fB%H\fP も参照) (TZ)
 122 .TP
 123 \fB%l\fP
 124 12 時間表記での時 (0\-12)。 1 桁の場合には前にゼロでなくスペースが置かれる。 (\fB%I\fP も参照) (TZ)
 125 .TP
 126 \fB%m\fP
 127 月 (10 進数表記)。 (01\-12)
 128 .TP
 129 \fB%M\fP
 130 分 (10 進数表記) (00\-59)
 131 .TP
 132 \fB%n\fP
 133 改行。 (SU)
 134 .TP
 135 \fB%O\fP
 136 別形式を使用する際の修飾子。下記参照。 (SU)
 137 .TP
 138 \fB%p\fP
 139 現在のロケールにおける「午前」「午後」に相当する文字列。 英語の場合には "AM" または "PM" となる。
 140 正午は「午後」、真夜中は「午前」として扱われる。
 141 .TP
 142 \fB%P\fP
 143 \fB%p\fP と同様であるが小文字が使用される。 英語の場合には "am" や "pm" となる。(GNU)
 144 .TP
 145 \fB%r\fP
 146 午前・午後形式での時刻。 POSIX ロケールでは \fB%I:%M:%S %p\fP と等価である。(SU)
 147 .TP
 148 \fB%R\fP
 149 24 時間表記での時刻、秒は表示しない (\fB%H:%M\fP)。 秒を含んだものは以下の \fB%T\fP を参照すること。(SU)
 150 .TP
 151 \fB%s\fP
 152 紀元 (Epoch; 1970\-01\-01 00:00:00 +0000 (UTC)) からの秒数。 (TZ)
 153 .TP
 154 \fB%S\fP
 155 秒 (10 進数表記) (00\-60)  (時々ある閏秒に対応するため、値の範囲は 60 までとなっている)
 156 .TP
 157 \fB%t\fP
 158 タブ文字 (SU)
 159 .TP
 160 \fB%T\fP
 161 24 時間表記の時間 (\fB%H:%M:%S\fP) (SU)
 162 .TP
 163 \fB%u\fP
 164 週の何番目の日 (10 進数表記) か。月曜日を 1 とする (1\-7)。 \fB%w\fP も参照。(SU)
 165 .TP
 166 \fB%U\fP
 167 年の初めからの通算の週番号 (10 進数表記) (00\-53)。 その年の最初の日曜日を、第 1 週の始まりとして計算する。 \fB%V\fP と \fB%W\fP
 168 も参照すること。
 169 .TP
 170 \fB%V\fP
 171 ISO\ 8601 形式での年の始めからの週番号 (「注意」の節を参照)。 10 進数表記で、01 から 53 の値となる。週番号は、
 172 新しい年が少なくとも 4 日以上含まれる最初の週を 1 として計算する。 \fB%U\fP と \fB%W\fP も参照のこと。(SU)
 173 .TP
 174 \fB%w\fP
 175 週の何番目の日 (10 進数表記) か。日曜日を 0 とする。(0\-6)。 \fB%u\fP も参照。(SU)
 176 .TP
 177 \fB%W\fP
 178 年の初めからの通算の週番号 (10 進数表記) (00\-53)。 その年の最初の月曜日を、第 1 週の始まりとして計算する。
 179 .TP
 180 \fB%x\fP
 181 現在のロケールで一般的な日付表記。時刻は含まない。
 182 .TP
 183 \fB%X\fP
 184 現在のロケールで一般的な時刻表記。日付は含まない。
 185 .TP
 186 \fB%y\fP
 187 西暦の下2桁 (世紀部分を含まない年) (00\-99)。
 188 .TP
 189 \fB%Y\fP
 190 世紀部分を含めた ( 4 桁の) 西暦年。
 191 .TP
 192 \fB%z\fP
 193 \fI+hhmm\fP や \fI\-hhmm\fP の形式のタイムゾーン (UTC へのオフセット時間)。(SU)
 194 .TP
 195 \fB%Z\fP
 196 タイムゾーン名または省略名。
 197 .TP
 198 \fB%+\fP
 199 .\" Nov 05 -- Not in Linux/glibc, but is in some BSDs (according to
 200 .\" their man pages)
 201 \fBdate\fP(1)  形式での日時。(TZ)  (glibc2 ではサポートされていない)
 202 .TP
 203 \fB%%\fP
 204 \(aq%\(aq 文字。
 205 .PP
 206 いくつかの変換指定では、変換指定文字の前に \fBE\fP や \fBO\fP 「修飾子」を置くことによって別書式を使用するように指定することができる。
 207 現在のロケールにおいて別書式が存在しない場合には、 通常の変換指定が使用されたかのように動作する (SU)。 統一 UNIX 規格 (Single
 208 UNIX Specification) では \fB%Ec\fP, \fB%EC\fP, \fB%Ex\fP, \fB%EX\fP, \fB%Ey\fP, \fB%EY\fP,
 209 \fB%Od\fP, \fB%Oe\fP, \fB%OH\fP, \fB%OI\fP, \fB%Om\fP, \fB%OM\fP, \fB%OS\fP, \fB%Ou\fP, \fB%OU\fP,
 210 \fB%OV\fP, \fB%Ow\fP, \fB%OW\fP, \fB%Oy\fP, について記述がある。ここで \fBO\fP 修飾子は別形式の数値 (ローマ数字とか)
 211 を指定するために使用する。 \fBE\fP 修飾子はロケール依存の別表現を指定するのに使用する。 (訳注: \fBE\fP
 212 修飾子は日本で使用されている「昭和」「平成」 などの元号による年表記を指定する。glibc 2.2 以降でのみ有効)
 213 .PP
 214 要素別の時刻構造体 \fItm\fP の詳細は \fI<time.h>\fP に定義されている。 \fBctime\fP(3)  も参照すること。
 215 .SH 返り値
 216 終端の NULL バイトを含めた結果の文字列の長さが \fImax\fP バイトを超えなかった場合、 \fBstrftime\fP() 関数は配列 \fIs\fP
 217 に格納されたバイト数を返す (このバイト数に終端の NULL バイトは含まれない)。 終端の NULL バイトを含めた結果の文字列の長さが \fImax\fP
 218 バイトを超える場合には、 \fBstrftime\fP() は 0 を返し、配列の内容は不定となる。 (少なくとも libc 4.4.4
 219 以降ではこの動作となる。 libc 4.4.1 などの非常に古いバージョンの libc では配列が短かすぎた場合には \fImax\fP が返される。)
 220 .LP
 221 返り値 0 は必ずしもエラーを意味している訳ではないので注意すること。 例えば、多くのロケールでは \fB%p\fP は空文字列を返す。 同様に、空の
 222 \fIformat\fP 文字列は空文字列を返す。
 223 .SH 環境変数
 224 環境変数 \fBTZ\fP と \fBLC_TIME\fP が使用される。 (訳注: \fBLC_ALL\fP が設定されている場合には \fBLC_TIME\fP
 225 よりもそちらが優先される。 \fBLC_TIME\fP も \fBLC_ALL\fP も設定されていない場合には \fBLANG\fP が使用される。)
 226 .SH 準拠
 227 SVr4, C89, C99.  個々の変換が厳密にどの規格に含まれるかは、 ANSI C (印なし)、統一 UNIX 規格 (SU印)、Olson の
 228 timezone パッケージ (TZ印)、 glibc 独自 (GNU印) で示している。glibc2 では \fB%+\fP はサポートされていないが、
 229 いくつかの拡張が行われている。POSIX.1 では ANSI C のみを参照している。 POSIX.2 の \fBdate\fP(1)
 230 のところに記述されている幾つかの拡張は \fBstrftime\fP()  にも適用できるだろう。 \fB%F\fP 変換は C99 と POSIX.1\-2001
 231 にある。
 232
 233 SUSv2 では、 \fB%S\fP は 00 から 61 の範囲をとると規定されている。 これは、1分間のうち閏秒が 2つ入る可能性が理論的にはあることを
 234 考慮してのものである (実際には、このような状況はこれまで一度も 起こっていない)。
 235 .SH 注意
 236 .SS "ISO\ 8601 の週・曜日表記 (Week Dates)"
 237 \fB%G\fP, \fB%g\fP, \fB%V\fP は、ISO\ 8601 標準により定義された週単位表記の年により 計算される値を出力する。 ISO\ 8601
 238 標準の週単位表記では、週は月曜日から開始され、 週番号は、年の最初の週が 01 となり、最後の週は 52 か 53 となる。 週 01 は、新しい年が
 239 4 日以上含まれる最初の週である。 言い換えると、週 01 は、その年の木曜日を含む最初の週、 つまり 1 月 4 日を含む週ということである。
 240 新しい年のカレンダー上の最初の週に新しい年が 3 日以下しか含まれない場合、 ISO\ 8601 の週単位表記では、これらの日を前の年の週 53
 241 の一部とみなす。 例えば、2010 年 1 月 1 日は金曜日であり、 その週には 2010 年の日が 3 日しか含まれない。 したがって、ISO\ 8601 の週単位表記では、これらの日は 2009 年 (\fB%G\fP)  の週 53 (\fB%V\fP) の一部となる。 ISO\ 8601 の 2010
 242 年の週 01 は 2010 年 1 月 4 日の月曜日から始まる。
 243 .SS "glibc での注意"
 244 .\" HP-UX and Tru64 also have features like this.
 245 glibc では変換指定にいくつか拡張を行っている (これらの拡張は POSIX.1\-2001 には規定されていないが、
 246 他のいくつかのシステムで同様の機能が提供されている)。 \(aq%\(aq 文字と変換指定文字の間に、オプションとして \fIflag\fP とフィールドの
 247 \fI幅\fP を指定できる (これらを指定する場合には \fBE\fP や \fBO\fP 修飾子の前に置く)。
 248
 249 以下のフラグ文字が使用できる:
 250 .TP
 251 \fB_\fP
 252 (下線)  数値の結果文字列のパディング (穴埋め) をスペース (空白文字) で行う。
 253 .TP
 254 \fB\-\fP
 255 (ダッシュ)  数値の結果文字列に対するパディングを行わない。
 256 .TP
 257 \fB0\fP
 258 変換指定文字がデフォルトではスペースでパディングを行う場合でも、 数値の結果文字列へのパディングを 0 で行う。
 259 .TP
 260 \fB^\fP
 261 結果文字列中のアルファベット文字を大文字に変換する。
 262 .TP
 263 \fB#\fP
 264 結果文字列の大文字・小文字を入れ替える (このフラグは特定の変換指定文字でしか機能しない。その中でも 本当に有用なのは \fB%Z\fP の場合だけである)。
 265 .PP
 266 オプションの10進数の幅指定子はフラグの後ろに置くことができる (フラグはなくてもよい)。フィールドの本来の大きさが指定された幅よりも
 267 小さい場合、結果文字列の左側は指定された幅までパディングされる。
 268 .SH バグ
 269 出力文字列が \fImax\fP バイトを超えてしまう場合、 \fIerrno\fP は設定「されない」。 このため、このエラーを、 \fIformat\fP
 270 文字列がきちんと処理されて長さ 0 の出力文字列が生成される場合を区別することができない。 POSIX.1\-2001 では \fBstrftime\fP()
 271 で \fIerrno\fP に設定する値について一切規定して「いない」。
 272
 273 \fBgcc\fP(1)  のいくつかのバージョンにはおかしなところがあり、 \fB%c\fP の使用法について以下のような警告を出す: \fIwarning:
 274 `%c' yields only last 2 digits of year in some locales\fP
 275 (\fI警告:\fPいくつかのロケールでは\fI`%c'\fPは年の下2桁しか出力しない\fI)。\fP もちろんプログラマが \fB%c\fP
 276 を使うのはお薦めできることである。 \fB%c\fP を使うと適切な日付と時刻の表記を得ることができるからである。 \fBgcc\fP(1)
 277 のこの問題を回避しようとすると、何かすっきりしない気分になるだろう。 比較的きれいな解決方法は以下のような中間関数を追加することである。
 278 .in +4n
 279 .nf
 280
 281 size_t
 282 my_strftime(char *s, size_t max, const char *fmt,
 283             const struct tm *tm)
 284 {
 285     return strftime(s, max, fmt, tm);
 286 }
 287 .fi
 288 .in
 289
 290 現在では、 \fBgcc\fP(1)  はこの警告を抑えるための \fI\-Wno\-format\-y2k\fP オプションを
 291 提供しており、上記の回避策はもはや必要ない。
 292 .SH 例
 293 \fBRFC\ 2822 準拠の日付形式\fP (%a と %b は英語ロケール)
 294 .PP
 295 .in +2n
 296 "%a,\ %d\ %b\ %Y\ %T\ %z"
 297 .PP
 298 \fBRFC\ 822 準拠の日付形式\fP (%a と %b は英語ロケール)
 299 .PP
 300 .in +2n
 301 "%a,\ %d\ %b\ %y\ %T\ %z"
 302 .SS サンプルプログラム
 303 以下のプログラムを使うと \fBstrftime\fP()  の実験ができる。
 304 .PP
 305 以下に、 \fBstrftime\fP()  の glibc 実装が生成する結果の例をいくつか示す:
 306 .in +4n
 307 .nf
 308
 309 $\fB ./a.out \(aq%m\(aq\fP
 310 Result string is "11"
 311 $\fB ./a.out \(aq%5m\(aq\fP
 312 Result string is "00011"
 313 $\fB ./a.out \(aq%_5m\(aq\fP
 314 Result string is "   11"
 315 .fi
 316 .in
 317 .PP
 318 プログラムのソースは以下の通り:
 319 .nf
 320
 321 #include <time.h>
 322 #include <stdio.h>
 323 #include <stdlib.h>
 324
 325 int
 326 main(int argc, char *argv[])
 327 {
 328     char outstr[200];
 329     time_t t;
 330     struct tm *tmp;
 331
 332     t = time(NULL);
 333     tmp = localtime(&t);
 334     if (tmp == NULL) {
 335         perror("localtime");
 336         exit(EXIT_FAILURE);
 337     }
 338
 339     if (strftime(outstr, sizeof(outstr), argv[1], tmp) == 0) {
 340         fprintf(stderr, "strftime returned 0");
 341         exit(EXIT_FAILURE);
 342     }
 343
 344     printf("Result string is \e"%s\e"\en", outstr);
 345     exit(EXIT_SUCCESS);
 346 }
 347 .fi
 348 .SH 関連項目
 349 \fBdate\fP(1), \fBtime\fP(2), \fBctime\fP(3), \fBsetlocale\fP(3), \fBsprintf\fP(3),
 350 \fBstrptime\fP(3)
 351 .SH この文書について
 352 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 353 である。プロジェクトの説明とバグ報告に関する情報は
 354 http://www.kernel.org/doc/man\-pages/ に書かれている。