'\"
'\" Copyright (c) 1998 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" 
'\" RCS: @(#) $Id: regexp.n,v 1.2 2003/11/24 05:09:59 bbbush Exp $
'\" 
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: regexp.n,v 1.2 2003/11/24 05:09:59 bbbush Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH regexp 3tcl 8.3 Tcl "Tcl Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
regexp \- 針對一個字符串匹配一個正則表達式

.SH "總覽 SYNOPSIS"
\fBregexp \fR?\fIswitches\fR? \fIexp string \fR?\fImatchVar\fR? ?\fIsubMatchVar subMatchVar ...\fR?
.BE

.SH "描述 DESCRIPTION"
.PP
確定正則表達式 \fIexp\fR 是否匹配部分或全部 \fIstring\fR，在未指定 \fB-inline\fR (參見後面)的時候，如果匹配則返回 1，否則返回 0。(正則表達式匹配的描述請參見 \fBre_syntax\fR 參考頁。)
.LP
如果在 \fIstring\fR 之後指定了補充的參數，則把它們作爲變量的名字對待，把關於 \fIstring\fR 中匹配 \fIexp \fR的那部分的信息返回到其中。\fIMatchVar\fR 將被設置爲匹配全部 \fIexp \fR的 \fIstring \fR的範圍。第一個\fIsubMatchVar\fR 將包含與 \fIexp \fR中最左的圓括號中的子表達式相匹配的 \fIstring\fR 中那部分字符，下一個 \fIsubMatchVar\fR 將包含與\fIexp \fR中從左到右的下一個圓括號中的子表達式相匹配的 \fIstring\fR 中那部分字符，以此類推。
.PP
如果給 \fBregexp\fR 的初始的參數以 \fB-\fR 爲開始，則它們被作爲開關來對待。當前支持下列開關:
.TP 15
\fB\-about\fR
不再嘗試匹配正則表達式，返回包含關於正則表達式信息的一個列表。列表的第一個元素是子表達式計數。第二個元素是描述正則表達式各種特性的屬性名的一個列表。這個開關主要用於調試目的。
.TP 15
\fB\-expanded\fR
啓用展開的(expanded)正則表示式語法，將忽略白空格和註釋。這與指定 \fB(?x)\fR 嵌入選項相同。(see METASYNTAX, below).
.TP 15
\fB\-indices\fR
改變在 \fIsubMatchVar\fR 中存儲的內容。不再存儲 \fIstring \fR中匹配的字符串，每個變量將包含兩個十進制字符串組成的一個列表，它們給出匹配的字符範圍中的第一個和最後一個字符在     \fIstring\fR 中的索引 。
.TP 15
\fB\-line\fR
啓用換行敏感匹配。缺省的，換行是沒有特殊意義的一個完全的普通字符。加上了這個標誌，‘[^’ 方括號表達式和‘.’將永不匹配換行，‘^’除了它的正常功能之外還匹配在任何換行之後的空串，而‘$’除了它的正常功能之外還匹配在任何換行之前的空串。這個標誌等價於指定 \fB-linestop\fR 和 \fB-lineanchor \fR二者，或者 \fB(?n)\fR 嵌入選項。 (see METASYNTAX, below).
.TP 15
\fB\-linestop\fR
改變‘[^’方括號表達式和‘.’的行爲，這樣表示式將停止於換行。這與指定 \fB(?p)\fR 嵌入選項相同。 (see METASYNTAX, below).
.TP 15
\fB\-lineanchor\fR
改變‘^’和‘$’(“錨”)的行爲，這樣它們分別的匹配一行的開始和結束。這與指定 \fB(?w)\fR 嵌入選項相同。 (see METASYNTAX, below).
.TP 15
\fB\-nocase\fR
導致在匹配處理中把 \fIstring\fR 中的大寫字符與小寫字符同樣對待。
.VS 8.3
.TP 15
\fB\-all\fR
導致盡字符串中可能的次數去匹配正則表達式，返回發現的匹配總數。如果一起指定的還有匹配變量，它們將只保持最後的匹配。
.TP 15
\fB\-inline\fR
導致命令把原先要放置到匹配變量中的數據作爲一個列表返回。當使用 \fB-inline\fR 的時候，不可以指定匹配變量。如果還使用了 \fB-all\fR，在每次重複操作(iteration)時串聯列表，這樣將總是返回一個平坦的列表。對於每次匹配的重複操作，這個命令將添加整體的匹配數據，爲正則表達式中的每個子表達式加上一個元素。例如:
.CS
    regexp -inline -- {\\w(\\w)} " inlined "
 => {in n}
    regexp -all -inline -- {\\w(\\w)} " inlined "
 => {in n li i ne e}
.CE
.TP 15
\fB\-start\fR \fIindex\fR
在字符串中指定一個字符索引，在這個偏移量上開始匹配。當使用了這個開關的時候，‘^’將不匹配行的開始，而     \A 將仍舊在 \fIindex \fR上匹配字符串的開始。如果指定了 \fB-indices\fR，編制索引將以輸入字符串的絕對開始爲起始。\fIindex\fR     將被約束爲輸入字符串的束縛。
.VE 8.3
.TP 15
\fB\-\|\-\fR
標記開關的結束。這個標誌之後的參數即使以 \fB- \fR爲開始仍被作爲 \fIexp\fR 對待。
.PP
如果 \fIsubMatchVar\fR 比 \fIexp\fR 中的圓括號中的子表達式多，或者在 \fIexp\fR 中的一個特定子表達式不匹配字符串。(比如，因爲它是不被匹配的子表達式的一部分), 則在指定了 \fB-indices\fR 的時候，相應\fIsubMatchVar\fR 將被設置成``\fB\-1 \-1\fR''，其他時候被設置成空串。

.SH "參見 SEE ALSO"
re_syntax(n), regsub(n)

.SH "關鍵字 KEYWORDS"
match, regular expression, string

.SH "[中文版維護人]"
.B 寒蟬退士
.SH "[中文版最新更新]"
.B 2001/10/27
.SH "《中國 Linux 論壇 man 手冊頁翻譯計劃》:"
.BI http://cmpp.linuxforum.net
.SH "跋"
.br
本頁面中文版由中文 man 手冊頁計劃提供。
.br
中文 man 手冊頁計劃：\fBhttps://github.com/man-pages-zh/manpages-zh\fR