release/man3/strftime.3

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