(split) Fixed #25191 (typo in fenv.3).

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

.\" Copyright (C), 1995, Graeme W. Wilford. (Wilf.)
.\"
.\" 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.
.\"
.\" Wed Jun 14 16:10:28 BST 1995 Wilf. (G.Wilford@ee.surrey.ac.uk)
.\" Tiny change in formatting - aeb, 950812
.\" Modified 8 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk)
.\"
.\" Japanese Version Copyright (c) 1998 Takatsugu Nokubi
.\"     all rights reserved.
.\" Translated 1998-06-30, Takatsugu Nokubi
.\" Updated & Modified 2001-11-05, Yuichi SATO <ysato@h4.dion.ne.jp>
.\" Updated & Modified 2005-02-24, Yuichi SATO <ysato444@yahoo.co.jp>
.\" Updated 2008-08-02, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.05
.\"
.\"WORD:        bitwise-or              ¥Ó¥Ã¥È¤´¤È¤ÎOR
.\"WORD:        element                 (¹½Â¤ÂÎ)Í×ÁÇ
.\"WORD:        collating element       ¾È¹ç½ç½ø¤ÎÍ×ÁÇ
.\"
.\" show the synopsis section nicely
.de xx
.in \\n(INu+\\$1
.ti -\\$1
..
.TH REGEX 3 2008-05-29 "GNU" "Linux Programmer's Manual"
.SH ̾Á°
regcomp, regexec, regerror, regfree \- POSIX regex ´Ø¿ô
.SH ½ñ¼°
.nf
.B #include <sys/types.h>
.B #include <regex.h>

.BI "int regcomp(regex_t *" preg ", const char *" regex ", int " cflags );

.BI "int regexec(const regex_t *" preg ", const char *" string \
", size_t " nmatch ,
.BI "            regmatch_t " pmatch[] ", int " eflags );

.BI "size_t regerror(int " errcode ", const regex_t *" preg ", char *" errbuf ,
.BI "                size_t " errbuf_size );

.BI "void regfree(regex_t *" preg );
.fi
.SH ÀâÌÀ
.SS "POSIX regex ¥³¥ó¥Ñ¥¤¥ë"
.BR regcomp ()
¤Ï¡¢Àµµ¬É½¸½¤ò¥³¥ó¥Ñ¥¤¥ë¤·¤Æ¡¢
.BR regexec ()
¤Ç¤Î¸¡º÷½èÍý¤ËŬ¹ç¤¹¤ë·ÁÂ֤ˤ¹¤ë¡£

.BR regcomp ()
¤Ï¥Ñ¥¿¡¼¥ó¤òµ­²±¤¹¤ë¥Ð¥Ã¥Õ¥¡¤Ø¤Î¥Ý¥¤¥ó¥¿
.IR preg ¡¢
¥Ì¥ëʸ»ú¤Ç½ªÃ¼¤µ¤ì¤¿Ê¸»úÎó
.IR regex ¡¢
¤½¤·¤Æ¥³¥ó¥Ñ¥¤¥ë¤Î·Á¼°¤ò·è¤á¤ë¤¿¤á¤Î¥Õ¥é¥°
.I cflag
¤ò°ú¿ô¤Ëȼ¤¦¡£

Á´¤Æ¤ÎÀµµ¬É½¸½¸¡º÷¤Ï¡¢¥³¥ó¥Ñ¥¤¥ë¤µ¤ì¤¿¥Ñ¥¿¡¼¥ó¤Ë¤è¤Ã¤Æ¹Ô¤ï¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
¤è¤Ã¤Æ¡¢
.BR regexec ()
¤Ë»ØÄꤹ¤ë¤Î¤Ï¡¢É¬¤º
.RB ( regcomp ()
¤Ë¤è¤Ã¤Æ¥³¥ó¥Ñ¥¤¥ë¤µ¤ì¤¿) ¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡¤Ø¤Î¥¢¥É¥ì¥¹¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£

.I cflags
¤Ë¤Ï°Ê²¼¤Ë¼¨¤¹Äê¿ô°ì¤Ä°Ê¾å¤Î¥Ó¥Ã¥È¤´¤È¤Î OR (bitwise-or) ¤ò»ØÄꤹ¤ë¡£
.TP
.B REG_EXTENDED
.I regex
¤Ë
.B POSIX
³ÈÄ¥Àµµ¬É½¸½¤ò»ÈÍѤ¹¤ë¡£¤â¤·¤³¤Î¥Õ¥é¥°¤¬ÀßÄꤵ¤ì¤Ê¤¤¾ì¹ç¡¢
.B POSIX
ɸ½àÀµµ¬É½¸½¤¬»È¤ï¤ì¤ë¡£
.TP
.B REG_ICASE
Âçʸ»ú¾®Ê¸»ú¤Î°ã¤¤¤ò̵»ë¤¹¤ë¡£¤³¤Î¥Õ¥é¥°¤ò»ØÄꤷ¤Æ¥³¥ó¥Ñ¥¤¥ë¤µ¤ì¤¿
¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡¤òÍѤ¤¤Æ
.BR regexec ()
´Ø¿ô¤ò¸Æ¤Ó½Ð¤¹¤È¡¢Âçʸ»ú¾®Ê¸»ú¤Î¶èÊ̤òÉÕ¤±¤º¤Ë¸¡º÷¤¬¹Ô¤ï¤ì¤ë¡£
.TP
.B REG_NOSUB
¤³¤Î¥Õ¥é¥°¤òÀßÄꤷ¤Æ¥³¥ó¥Ñ¥¤¥ë¤µ¤ì¤¿¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡¤¬
.BR regexec ()
¤Î°ú¿ô¤Ë»ØÄꤵ¤ì¤ë¤È¡¢°ú¤­¿ô
.IR nmatch ,
.I pmatch
¤¬Ìµ»ë¤µ¤ì¤ë¡£
.TP
.B REG_NEWLINE
Á´¤Æ¤Îʸ»ú¤Ë¥Þ¥Ã¥Á¤¹¤ë¥ª¥Ú¥ì¡¼¥¿¤Ë²þ¹Ô¤ò¥Þ¥Ã¥Á¤µ¤»¤Ê¤¤¡£

²þ¹Ô¤ò´Þ¤Þ¤Ê¤¤Èó¥Þ¥Ã¥Á¥ó¥°Ê¸»ú¥ê¥¹¥È
.RB ( [^...] )
¤Ë²þ¹Ô¤ò¥Þ¥Ã¥Á¤µ¤»¤Ê¤¤¡£

.BR regexec ()
¤Î¼Â¹Ô»þ¤Ë»ØÄꤹ¤ë¥Õ¥é¥°
.I eflags
¤Ë
.B REG_NOTBOL
¤ò´Þ¤à¤«¤É¤¦¤«¤Ë¤«¤«¤ï¤é¤º¡¢¹ÔƬ¤Ë¥Þ¥Ã¥Á¤¹¤ë¥ª¥Ú¥ì¡¼¥¿
.RB ( ^ )
¤ò²þ¹Ôľ¸å¤Î¶õʸ»úÎó¤Ë¥Þ¥Ã¥Á¤µ¤»¤ë¡£

.I eflags
¤Ë
.B REG_NOTEOL
¤ò´Þ¤à¤«¤É¤¦¤«¤Ë¤«¤«¤ï¤é¤º¡¢¹ÔËö¤Ë¥Þ¥Ã¥Á¤¹¤ë¥ª¥Ú¥ì¡¼¥¿
.RB ( $ )
¤ò²þ¹ÔľÁ°¤Î¶õʸ»úÎó¤Ë¥Þ¥Ã¥Á¤µ¤»¤ë¡£
.SS "POSIX regex ¥Þ¥Ã¥Á¥ó¥°"
.BR regexec ()
¤Ï¡¢
¥×¥ê¥³¥ó¥Ñ¥¤¥ë¤µ¤ì¤¿¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡
.I preg
¤ò¥Ì¥ëʸ»ú¤Ç½ªÃ¼¤µ¤ì¤¿Ê¸»úÎó¤Ë¥Þ¥Ã¥Á¤µ¤»¤ë¡£
.I nmatch
¤È
.I pmatch
¤Ï¥Þ¥Ã¥Á¥ó¥°¤Î°ÌÃ֤˴ؤ¹¤ë¾ðÊó¤ò¼èÆÀ¤¹¤ë¤Î¤ËÍѤ¤¤é¤ì¤ë¡£
.I eflags
¤Ë¤Ï
.B REG_NOTBOL
¤È
.B REG_NOTEOL
¤Î¤É¤Á¤é¤«¡¢¤â¤·¤¯¤ÏξÊý¤Î¥Ó¥Ã¥È¤´¤È¤Î
.BR OR " (bitwise-" or )
¤ò»ØÄꤷ¡¢°Ê²¼¤ÇÀâÌÀ¤¹¤ë¤è¤¦¤Ë¥Þ¥Ã¥Á¥ó¥°Æ°ºî¤òÊѲ½¤µ¤»¤ë¡£
.TP
.B REG_NOTBOL
¹ÔƬ¤Ë¥Þ¥Ã¥Á¤¹¤ë¥ª¥Ú¥ì¡¼¥¿¤Ï¡¢É¬¤º¥Þ¥Ã¥Á¤Ë¼ºÇÔ¤¹¤ë (¥³¥ó¥Ñ¥¤¥ë»þ¤Î¥Õ¥é¥°
.B REG_NEWLINE
¤Î¹àÌܤ⻲¾È)¡£
¤³¤Î¥Õ¥é¥°¤Ï¡¢Ê£¿ô¹Ô¤Ë¤Þ¤¿¤¬¤ëʸ»úÎó¤ò
.BR regexec ()
¤Ç¸¡º÷¤¹¤ëºÝ¤Ë¡¢Ê¸»úÎó¤ÎÀèƬ¤ò¹Ô¤ÎÀèƬ¤È¤·¤Æ²ò¼á¤µ¤»¤Ê¤¤¾ì¹ç¤ËÍѤ¤¤ë¡£
.TP
.B REG_NOTEOL
¹ÔËö¤Ë¥Þ¥Ã¥Á¤¹¤ë¥ª¥Ú¥ì¡¼¥¿¤Ï¡¢É¬¤º¥Þ¥Ã¥Á¤Ë¼ºÇÔ¤¹¤ë (¥³¥ó¥Ñ¥¤¥ë»þ¤Î¥Õ¥é¥°
.B REG_NEWLINE
¤Î¹àÌܤ⻲¾È)¡£
.SS ¥Ð¥¤¥È¥ª¥Õ¥»¥Ã¥È
¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡¤Î¥³¥ó¥Ñ¥¤¥ë»þ¤Ë
.B REG_NOSUB
¤¬ÀßÄꤵ¤ì¤Ê¤¤¾ì¹ç¤Ï¡¢Éôʬʸ»úÎó¤Î¥Þ¥Ã¥Á¥ó¥°°ÌÃÖ¾ðÊó¤òÆÀ¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.I pmatch
¤Ï¡¢¾¯¤Ê¤¯¤È¤â
.I nmatch
¤ÎÂ礭¤µ¤ò»ý¤Ä¤è¤¦¤Ë»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.BR regexec ()
¤Î¼Â¹Ô¤Ë¤è¤Ã¤Æ¡¢¤½¤ì¤é¤ËÉôʬʸ»úÎó¥Þ¥Ã¥Á¥ó¥°°ÌÃÖ¾ðÊó¤¬ÂåÆþ¤µ¤ì¤ë¡£
̤»ÈÍѤι½Â¤ÂÎÍ×ÁÇ¤Ë¤Ï \-1 ¤¬ÃͤȤ·¤ÆÂåÆþ¤µ¤ì¤ë¡£

.I pmatch
¤Î·¿¤Ç¤¢¤ë
.I regmatch_t
¹½Â¤ÂΤϡ¢
.I <regex.h>
Æâ¤ÇÄêµÁ¤µ¤ì¤ë¡£

.in +4n
.nf
typedef struct {
    regoff_t rm_so;
    regoff_t rm_eo;
} regmatch_t;
.fi
.in

¹½Â¤ÂÎÍ×ÁÇ
.I rm_so
¤ÎÃͤ¬ \-1 ¤Ç¤Ê¤¤¾ì¹ç¡¢¤½¤ì¤Ïʸ»úÎóÆâ¤Ç¤Î¼¡¤ÎºÇÂç¤Î¥Þ¥Ã¥Á¥ó¥°Éôʬ¤Î³«»Ï
¥ª¥Õ¥»¥Ã¥È°ÌÃÖ¤ò¼¨¤¹¡£¤½¤ì¤ËÂФ·¡¢¹½Â¤ÂÎÍ×ÁÇ
.I rm_eo
¤Ï¥Þ¥Ã¥Á¥ó¥°Éôʬ¤Î½ªÎ»¥ª¥Õ¥»¥Ã¥È°ÌÃÖ¤ò¼¨¤·¡¢
¥Þ¥Ã¥Á¥ó¥°Éôʬ¤Îľ¸å¤Îʸ»ú¤Î¥ª¥Õ¥»¥Ã¥È°ÌÃÖ¤¬»ÈÍѤµ¤ì¤ë¡£
.SS "POSIX ¥¨¥é¡¼¥ì¥Ý¡¼¥È"
.BR regerror ()
¤Ï¡¢
.BR regcomp ()
¤È
.BR regexec ()
¤Î¼Â¹Ô¤Ë¤è¤Ã¤ÆÆÀ¤é¤ì¤ë¥¨¥é¡¼¥³¡¼¥É¤«¤é¡¢¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸Ê¸»úÎó¤ò
ÆÀ¤ë¤Î¤ËÍѤ¤¤é¤ì¤ë¡£

.BR regerror ()
¤Ï¥¨¥é¡¼¥³¡¼¥É
.IR errcode ¡¢
¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡
.IR preg ¡¢
ʸ»úÎó¥Ð¥Ã¥Õ¥¡¤Ø¤Î¥Ý¥¤¥ó¥¿
.IR errbuf ¡¢
ʸ»úÎó¥Ð¥Ã¥Õ¥¡¤Î¥µ¥¤¥º
.I errbuf_size
¤ò°ú¿ô¤Ë¤È¤ë¡£
¤³¤Î´Ø¿ô¤Ï¡¢¥Ì¥ëʸ»ú¤Ç½ªÃ¼¤µ¤ì¤¿¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸Ê¸»úÎó¤ò³ÊǼ¤¹¤ë¤Î¤ËɬÍפÊ
.I errbuf
¤Î¥µ¥¤¥º¤òÊÖ¤¹¡£¤â¤·
.I errbuf
¤È
.I errbuf_size
¤ÎξÊý¤¬Èó 0 ÃͤǤ¢¤ì¤Ð¡¢
.I errbuf
¤Ë¤ÏºÇ½é¤Î
.I "errbuf_size \- 1"
ʸ»úʬ¤Ë¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤È½ªÃ¼¤Î¥Ì¥ëʸ»ú¤¬¼ý¤Þ¤ë¤è¤¦¤ËÂåÆþ¤µ¤ì¤ë¡£
.SS "POSIX ¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡²òÊü"
°ú¿ô¤Ë¥³¥ó¥Ñ¥¤¥ë¤µ¤ì¤¿¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡
.I preg
¤òÍ¿¤¨¤Æ
.BR regfree ()
¤ò¸Æ¤Ó½Ð¤¹¤È¡¢
.BR regcomp ()
¤Ë¤è¤ë¥³¥ó¥Ñ¥¤¥ë»þ¤Ë¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡¤Ë³ä¤êÅö¤Æ¤é¤ì¤¿¥á¥â¥ê¤¬²òÊü¤µ¤ì¤ë¡£
.SH ÊÖ¤êÃÍ
.BR regcomp ()
¤Ï¡¢¥³¥ó¥Ñ¥¤¥ë¤ÎÀ®¸ù»þ¤Ë¤Ï 0 ¤òÊÖ¤·¡¢¼ºÇÔ»þ¤Ë¤Ï¥¨¥é¡¼¥³¡¼¥É¤òÊÖ¤¹¡£

.BR regexec ()
¤Ï¡¢¥Þ¥Ã¥Á¥ó¥°¤ÎÀ®¸ù»þ¤Ë¤Ï 0 ¤òÊÖ¤·¡¢¼ºÇÔ»þ¤Ë¤Ï
.B REG_NOMATCH
¤òÊÖ¤¹¡£
.SH ¥¨¥é¡¼
.BR regcomp ()
¤Ï°Ê²¼¤Î¥¨¥é¡¼¤òÊÖ¤¹¡£
.TP
.B REG_BADBR
̵¸ú¤Ê¸åÊý»²¾È¥ª¥Ú¥ì¡¼¥¿¤Î»ÈÍÑ¡£
.TP
.B REG_BADPAT
¥°¥ë¡¼¥×¤ä¥ê¥¹¥È¤Ê¤É¤Î¡¢¥Ñ¥¿¡¼¥ó¥ª¥Ú¥ì¡¼¥¿¤Î̵¸ú¤Ê»ÈÍÑ¡£
.TP
.B REG_BADRPT
\(aq*\(aq ¤¬ºÇ½é¤Îʸ»ú¤È¤·¤Æ¤¯¤ë¤è¤¦¤Ê¡¢Ìµ¸ú¤Ê·«¤êÊÖ¤·¥ª¥Ú¥ì¡¼¥¿¤Î»ÈÍÑ¡£
.TP
.B REG_EBRACE
¥¤¥ó¥¿¡¼¥Ð¥ë¥ª¥Ú¥ì¡¼¥¿
.B {}
(brace interval operators) ¤¬ÊĤ¸¤Æ¤¤¤Ê¤¤¡£
.TP
.B REG_EBRACK
¥ê¥¹¥È¥ª¥Ú¥ì¡¼¥¿
.B []
(bracket list operators) ¤¬ÊĤ¸¤Æ¤¤¤Ê¤¤¡£
.TP
.B REG_ECOLLATE
¾È¹ç½ç½ø¤ÎÍ×ÁÇ (collating element) ¤È¤·¤ÆÍ­¸ú¤Ç¤Ï¤Ê¤¤¡£

(ÌõÃí) ¾È¹ç½ç½ø¤ÎÍ×ÁÇ (collating element) ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.BR regex (7)
¤ò»²¾È¡£
.TP
.B REG_ECTYPE
̤ÃΤΥ­¥ã¥é¥¯¥¿¥¯¥é¥¹Ì¾¡£
.TP
.B REG_EEND
̤ÄêµÁ¥¨¥é¡¼¡£¤³¤ì¤Ï POSIX.2 ¤Ë¤ÏÄêµÁ¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
.TP
.B REG_EESCAPE
Àµµ¬É½¸½¤¬¥Ð¥Ã¥¯¥¹¥é¥Ã¥·¥å¤Ç½ª¤Ã¤Æ¤¤¤ë¡£

(ÌõÃí) ÆüËܸì´Ä¶­¤Î¾ì¹ç¡¢¥Ð¥Ã¥¯¥¹¥é¥Ã¥·¥å¤È¤Ê¤ë¤Ù¤­½ê¤¬±ßµ­¹æ¤Ç
ɽ¼¨¤µ¤ì¤ë¤³¤È¤¬¤¢¤ë¤¬¡¢¤³¤ì¤Ïñ¤Ëɽ¼¨¥Õ¥©¥ó¥È¤ÎÌäÂê¤Ç¡¢
ÆâÉôŪ¤Ë¤ÏƱ¤¸°ÕÌ£¤Ç¤¢¤ë¡£
.TP
.B REG_EPAREN
¥°¥ë¡¼¥×¥ª¥Ú¥ì¡¼¥¿
.B ()
(parenthesis group operators) ¤¬ÊĤ¸¤Æ¤¤¤Ê¤¤¡£
.TP
.B REG_ERANGE
̵¸ú¤ÊÈÏ°Ï¥ª¥Ú¥ì¡¼¥¿¤Î»ÈÍÑ¡£
Î㤨¤Ð¡¢ÈϰϤνªÎ»°ÌÃÖ¤¬³«»Ï°ÌÃÖ¤è¤ê¤âÁ°¤Ë¤¢¤ë¤è¤¦¤Ê¾ì¹ç¡£
.TP
.B REG_ESIZE
Àµµ¬É½¸½¤Î¥³¥ó¥Ñ¥¤¥ë¤Ë¡¢64Kb °Ê¾å¤Î¥Ñ¥¿¡¼¥ó¥Ð¥Ã¥Õ¥¡¤¬É¬Íס£
¤³¤ì¤Ï POSIX.2 ¤Ë¤ÏÄêµÁ¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
.TP
.B REG_ESPACE
regex ¥ë¡¼¥Á¥ó¤¬¥á¥â¥ê¤ò»È¤¤¤Ï¤¿¤·¤Æ¤¤¤ë¡£
.TP
.B REG_ESUBREG
¥µ¥Ö¥¨¥¯¥¹¥×¥ì¥Ã¥·¥ç¥ó
.RB \e (...\e )
(subexpression) ¤Ø¤Î̵¸ú¤Ê¸åÊý»²¾È¡£
.SH ½àµò
POSIX.1-2001.
.SH ´ØÏ¢¹àÌÜ
.BR grep (1),
.BR regex (7),
GNU regex ¥Þ¥Ë¥å¥¢¥ë