(split) LDP: Update releases based on LDP 3.52 release

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

.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\"     GNU texinfo documentation on glibc date/time functions.
.\" Modified Sat Jul 24 18:03:44 1993 by Rik Faith (faith@cs.unc.edu)
.\" Applied fix by Wolfgang Franke, aeb, 961011
.\" Corrected return value, aeb, 970307
.\" Added Single UNIX Spec conversions and %z, aeb/esr, 990329.
.\" 2005-11-22 mtk, added Glibc Notes covering optional 'flag' and
.\"           'width' components of conversion specifications.
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH STRFTIME 3 2013\-06\-28 GNU "Linux Programmer's Manual"
.SH 名前
strftime \- 日付および時刻の文字列への変換
.SH 書式
.nf
\fB#include <time.h>\fP
.sp
\fBsize_t strftime(char *\fP\fIs\fP\fB, size_t \fP\fImax\fP\fB, const char *\fP\fIformat\fP\fB,\fP
\fB                const struct tm *\fP\fItm\fP\fB);\fP
.fi
.SH 説明
.\" FIXME POSIX says: Local timezone information is used as though
.\" strftime() called tzset().  But this doesn't appear to be the case
\fBstrftime\fP()  関数 は、要素別の時刻 \fItm\fP の内容を \fIformat\fP で指定された書式指定にしたがって変換し、 長さ
\fImax\fP の文字列 \fIs\fP に書き込む。
.PP
書式指定は NULL 終端された文字列であり、 「変換指定 (conversion specification)」と呼ばれる特別な文字列を
含まることができる。 各々の変換指定は \(aq%\(aq 文字で始まり、 「変換指定文字 (conversion specifier
character)」と呼ばれる 何らか他の文字で終端される。上記以外の全ての文字列は 「通常の文字列 (ordinary character
sequence)」となる。
.PP
(NULL バイトも含む) 通常の文字列内の文字は、 そのまま \fIformat\fP から \fIs\fP にコピーされる。
一方、変換指定の文字は以下のように置換される。
.TP 
\fB%a\fP
現在のロケールにおける曜日の省略名。
.TP 
\fB%A\fP
現在のロケールにおける曜日の完全な名前。
.TP 
\fB%b\fP
現在のロケールにおける月の省略名。
.TP 
\fB%B\fP
現在のロケールにおける月の完全な名前。
.TP 
\fB%c\fP
現在のロケールにおいて一般的な日付・時刻の表記。
.TP 
\fB%C\fP
世紀 (西暦年の上 2 桁)。 (SU)
.TP 
\fB%d\fP
月内通算日 (10 進数表記) (01\-31)。
.TP 
\fB%D\fP
\fB%m/%d/%y\fP と等価。(うえっ、アメリカ専用だ。アメリカ以外の国では \fB%d/%m/%y\fP
の方が一般的だ。紛らわしいので、使用すべきではない。) (SU)
.TP 
\fB%e\fP
\fB%d\fP と同様に月内通算日を 10 進数で表現するが、 1 桁の場合 10 の位にゼロを置かずスペースを置く。(SU)
.TP 
\fB%E\fP
別形式を使用する際の修飾子。下記参照。 (SU)
.TP 
\fB%F\fP
\fB%Y\-%m\-%d\fP と等価 (ISO\ 8601 形式の日付フォーマット)。 (C99)
.TP 
\fB%G\fP
ISO\ 8601 週単位表記の年 (week\-based year; 「注意」の節を参照)。 世紀も 10 進数で表す。 ISO 週番号 (\fB%V\fP
を参照) に対応した 4 桁の西暦年。 これは基本的には \fB%Y\fP と同じ形式だが、ISO 週数が前年や翌年になる
場合にはその年が使用される点が異なる。(TZ)
.TP 
\fB%g\fP
\fB%G\fP と同様。但し、世紀を含まず下 2 桁のみを表示 (00\-99)。 (TZ)
.TP 
\fB%h\fP
\fB%b\fP と等価 (SU)
.TP 
\fB%H\fP
24 時間表記での時 (hour)。 (00\-23)
.TP 
\fB%I\fP
12 時間表記での時 (hour)。 (01\-12)
.TP 
\fB%j\fP
年の初めから通算の日数。 (001\-366)
.TP 
\fB%k\fP
24 時間表記での時 (0\-23)。 1 桁の場合には前にゼロでなくスペースが置かれる。 (\fB%H\fP も参照) (TZ)
.TP 
\fB%l\fP
12 時間表記での時 (0\-12)。 1 桁の場合には前にゼロでなくスペースが置かれる。 (\fB%I\fP も参照) (TZ)
.TP 
\fB%m\fP
月 (10 進数表記)。 (01\-12)
.TP 
\fB%M\fP
分 (10 進数表記) (00\-59)
.TP 
\fB%n\fP
改行。 (SU)
.TP 
\fB%O\fP
別形式を使用する際の修飾子。下記参照。 (SU)
.TP 
\fB%p\fP
現在のロケールにおける「午前」「午後」に相当する文字列。 英語の場合には "AM" または "PM" となる。
正午は「午後」、真夜中は「午前」として扱われる。
.TP 
\fB%P\fP
\fB%p\fP と同様であるが小文字が使用される。 英語の場合には "am" や "pm" となる。(GNU)
.TP 
\fB%r\fP
午前・午後形式での時刻。 POSIX ロケールでは \fB%I:%M:%S %p\fP と等価である。(SU)
.TP 
\fB%R\fP
The time in 24\-hour notation (\fB%H:%M\fP).  (SU)  For a version including the
seconds, see \fB%T\fP below.
.TP 
\fB%s\fP
紀元 (Epoch; 1970\-01\-01 00:00:00 +0000 (UTC)) からの秒数。 (TZ)
.TP 
\fB%S\fP
秒 (10 進数表記) (00\-60)  (時々ある閏秒に対応するため、値の範囲は 60 までとなっている)
.TP 
\fB%t\fP
タブ文字 (SU)
.TP 
\fB%T\fP
The time in 24\-hour notation (\fB%H:%M:%S\fP).  (SU)
.TP 
\fB%u\fP
週の何番目の日 (10 進数表記) か。月曜日を 1 とする (1\-7)。 \fB%w\fP も参照。(SU)
.TP 
\fB%U\fP
年の初めからの通算の週番号 (10 進数表記) (00\-53)。 その年の最初の日曜日を、第 1 週の始まりとして計算する。 \fB%V\fP と \fB%W\fP
も参照すること。
.TP 
\fB%V\fP
ISO\ 8601 形式での年の始めからの週番号 (「注意」の節を参照)。 10 進数表記で、01 から 53 の値となる。週番号は、
新しい年が少なくとも 4 日以上含まれる最初の週を 1 として計算する。 \fB%U\fP と \fB%W\fP も参照のこと。(SU)
.TP 
\fB%w\fP
週の何番目の日 (10 進数表記) か。日曜日を 0 とする。(0\-6)。 \fB%u\fP も参照。(SU)
.TP 
\fB%W\fP
年の初めからの通算の週番号 (10 進数表記) (00\-53)。 その年の最初の月曜日を、第 1 週の始まりとして計算する。
.TP 
\fB%x\fP
現在のロケールで一般的な日付表記。時刻は含まない。
.TP 
\fB%X\fP
現在のロケールで一般的な時刻表記。日付は含まない。
.TP 
\fB%y\fP
西暦の下2桁 (世紀部分を含まない年) (00\-99)。
.TP 
\fB%Y\fP
世紀部分を含めた ( 4 桁の) 西暦年。
.TP 
\fB%z\fP
\fI+hhmm\fP や \fI\-hhmm\fP の形式のタイムゾーン (UTC へのオフセット時間)。(SU)
.TP 
\fB%Z\fP
The timezone name or abbreviation.
.TP 
\fB%+\fP
.\" Nov 05 -- Not in Linux/glibc, but is in some BSDs (according to
.\" their man pages)
\fBdate\fP(1)  形式での日時。(TZ)  (glibc2 ではサポートされていない)
.TP 
\fB%%\fP
\(aq%\(aq 文字。
.PP
いくつかの変換指定では、変換指定文字の前に \fBE\fP や \fBO\fP 「修飾子」を置くことによって別書式を使用するように指定することができる。
現在のロケールにおいて別書式が存在しない場合には、 通常の変換指定が使用されたかのように動作する (SU)。 統一 UNIX 規格 (Single
UNIX Specification) では \fB%Ec\fP, \fB%EC\fP, \fB%Ex\fP, \fB%EX\fP, \fB%Ey\fP, \fB%EY\fP,
\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,
\fB%OV\fP, \fB%Ow\fP, \fB%OW\fP, \fB%Oy\fP, について記述がある。ここで \fBO\fP 修飾子は別形式の数値 (ローマ数字とか)
を指定するために使用する。 \fBE\fP 修飾子はロケール依存の別表現を指定するのに使用する。 (訳注: \fBE\fP
修飾子は日本で使用されている「昭和」「平成」 などの元号による年表記を指定する。glibc 2.2 以降でのみ有効)
.PP
要素別の時刻構造体 \fItm\fP の詳細は \fI<time.h>\fP に定義されている。 \fBctime\fP(3)  も参照すること。
.SH 返り値
Provided that the result string, including the terminating null byte, does
not exceed \fImax\fP bytes, \fBstrftime\fP()  returns the number of bytes
(excluding the terminating null byte)  placed in the array \fIs\fP.  If the
length of the result string (including the terminating null byte)  would
exceed \fImax\fP bytes, then \fBstrftime\fP()  returns 0, and the contents of the
array are undefined.  (This behavior applies since at least libc 4.4.4; very
old versions of libc, such as libc 4.4.1, would return \fImax\fP if the array
was too small.)
.LP
Note that the return value 0 does not necessarily indicate an error.  For
example, in many locales \fB%p\fP yields an empty string.  An empty \fIformat\fP
string will likewise yield an empty string.
.SH 環境変数
環境変数 \fBTZ\fP と \fBLC_TIME\fP が使用される。 (訳注: \fBLC_ALL\fP が設定されている場合には \fBLC_TIME\fP
よりもそちらが優先される。 \fBLC_TIME\fP も \fBLC_ALL\fP も設定されていない場合には \fBLANG\fP が使用される。)
.SH 準拠
SVr4, C89, C99.  個々の変換が厳密にどの規格に含まれるかは、 ANSI C (印なし)、統一 UNIX 規格 (SU印)、Olson の
timezone パッケージ (TZ印)、 glibc 独自 (GNU印) で示している。glibc2 では \fB%+\fP はサポートされていないが、
いくつかの拡張が行われている。POSIX.1 では ANSI C のみを参照している。 POSIX.2 の \fBdate\fP(1)
のところに記述されている幾つかの拡張は \fBstrftime\fP()  にも適用できるだろう。 \fB%F\fP 変換は C99 と POSIX.1\-2001
にある。

SUSv2 では、 \fB%S\fP は 00 から 61 の範囲をとると規定されている。 これは、1分間のうち閏秒が 2つ入る可能性が理論的にはあることを
考慮してのものである (実際には、このような状況はこれまで一度も 起こっていない)。
.SH 注意
.SS "ISO\ 8601 の週・曜日表記 (Week Dates)"
\fB%G\fP, \fB%g\fP, and \fB%V\fP yield values calculated from the week\-based year
defined by the ISO\ 8601 standard.  In this system, weeks start on a Monday,
and are numbered from 01, for the first week, up to 52 or 53, for the last
week.  Week 1 is the first week where four or more days fall within the new
year (or, synonymously, week 01 is: the first week of the year that contains
a Thursday; or, the week that has 4 January in it).  When three of fewer
days of the first calendar week of the new year fall within that year, then
the ISO 8601 week\-based system counts those days as part of week 53 of the
preceding year.  For example, 1 January 2010 is a Friday, meaning that just
three days of that calendar week fall in 2010.  Thus, the ISO\ 8601
week\-based system considers these days to be part of week 53 (\fB%V\fP)  of the
year 2009 (\fB%G\fP); week 01 of ISO\ 8601 year 2010 starts on Monday, 4
January 2010.
.SS "glibc での注意"
.\" HP-UX and Tru64 also have features like this.
glibc では変換指定にいくつか拡張を行っている (これらの拡張は POSIX.1\-2001 には規定されていないが、
他のいくつかのシステムで同様の機能が提供されている)。 \(aq%\(aq 文字と変換指定文字の間に、オプションとして \fIflag\fP とフィールドの
\fI幅\fP を指定できる (これらを指定する場合には \fBE\fP や \fBO\fP 修飾子の前に置く)。

以下のフラグ文字が使用できる:
.TP 
\fB_\fP
(下線)  数値の結果文字列のパディング (穴埋め) をスペース (空白文字) で行う。
.TP 
\fB\-\fP
(ダッシュ)  数値の結果文字列に対するパディングを行わない。
.TP 
\fB0\fP
変換指定文字がデフォルトではスペースでパディングを行う場合でも、 数値の結果文字列へのパディングを 0 で行う。
.TP 
\fB^\fP
結果文字列中のアルファベット文字を大文字に変換する。
.TP 
\fB#\fP
結果文字列の大文字・小文字を入れ替える (このフラグは特定の変換指定文字でしか機能しない。その中でも 本当に有用なのは \fB%Z\fP の場合だけである)。
.PP
オプションの10進数の幅指定子はフラグの後ろに置くことができる (フラグはなくてもよい)。フィールドの本来の大きさが指定された幅よりも
小さい場合、結果文字列の左側は指定された幅までパディングされる。
.SH バグ
If the output string would exceed \fImax\fP bytes, \fIerrno\fP is \fInot\fP set.
This makes it impossible to distinguish this error case from cases where the
\fIformat\fP string legitimately produces a zero\-length output string.
POSIX.1\-2001 does \fInot\fP specify any \fIerrno\fP settings for \fBstrftime\fP().

\fBgcc\fP(1)  のいくつかのバージョンにはおかしなところがあり、 \fB%c\fP の使用法について以下のような警告を出す: \fIwarning:
`%c' yields only last 2 digits of year in some locales\fP
(\fI警告:\fPいくつかのロケールでは\fI`%c'\fPは年の下2桁しか出力しない\fI)。\fP もちろんプログラマが \fB%c\fP
を使うのはお薦めできることである。 \fB%c\fP を使うと適切な日付と時刻の表記を得ることができるからである。 \fBgcc\fP(1)
のこの問題を回避しようとすると、何かすっきりしない気分になるだろう。 比較的きれいな解決方法は以下のような中間関数を追加することである。
.in +4n
.nf

size_t
my_strftime(char *s, size_t max, const char *fmt,
            const struct tm *tm)
{
    return strftime(s, max, fmt, tm);
}
.fi
.in

現在では、 \fBgcc\fP(1)  はこの警告を抑えるための \fI\-Wno\-format\-y2k\fP オプションを
提供しており、上記の回避策はもはや必要ない。
.SH 例
\fBRFC\ 2822 準拠の日付形式\fP (%a と %b は英語ロケール)
.PP
.in +2n
"%a,\ %d\ %b\ %Y\ %T\ %z"
.PP
\fBRFC\ 822 準拠の日付形式\fP (%a と %b は英語ロケール)
.PP
.in +2n
"%a,\ %d\ %b\ %y\ %T\ %z"
.SS サンプルプログラム
以下のプログラムを使うと \fBstrftime\fP()  の実験ができる。
.PP
以下に、 \fBstrftime\fP()  の glibc 実装が生成する結果の例をいくつか示す:
.in +4n
.nf

$\fB ./a.out \(aq%m\(aq\fP
Result string is "11"
$\fB ./a.out \(aq%5m\(aq\fP
Result string is "00011"
$\fB ./a.out \(aq%_5m\(aq\fP
Result string is "   11"
.fi
.in
.PP
プログラムのソースは以下の通り:
.nf

#include <time.h>
#include <stdio.h>
#include <stdlib.h>

int
main(int argc, char *argv[])
{
    char outstr[200];
    time_t t;
    struct tm *tmp;

    t = time(NULL);
    tmp = localtime(&t);
    if (tmp == NULL) {
        perror("localtime");
        exit(EXIT_FAILURE);
    }

    if (strftime(outstr, sizeof(outstr), argv[1], tmp) == 0) {
        fprintf(stderr, "strftime returned 0");
        exit(EXIT_FAILURE);
    }

    printf("Result string is \e"%s\e"\en", outstr);
    exit(EXIT_SUCCESS);
}
.fi
.SH 関連項目
\fBdate\fP(1), \fBtime\fP(2), \fBctime\fP(3), \fBsetlocale\fP(3), \fBsprintf\fP(3),
\fBstrptime\fP(3)
.SH この文書について
この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
である。プロジェクトの説明とバグ報告に関する情報は
http://www.kernel.org/doc/man\-pages/ に書かれている。