'\"
'\" Copyright (c) 1993 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\" Copyright (c) 2000 Scriptics Corporation.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" 
'\" RCS: @(#) $Id: regsub.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: regsub.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 regsub 3tcl 8.3 Tcl "Tcl Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
regsub \- 基於正則表達式模式匹配進行替換
.SH "總覽 SYNOPSIS"
\fBregsub \fR?\fIswitches\fR? \fIexp string subSpec varName\fR
.BE

.SH "描述 DESCRIPTION"
.PP
這個命令針對 \fIstring \fR匹配正則表達式 \fIexp\fR，並且它把 \fIstring\fR 複製到用 \fIvarName\fR 給出名字的變量中。(正則表達式匹配的描述請參見 \fBre_syntax\fR 參考頁。)如果有一個匹配，則在複製 \fIstring\fR 到 \fIvarName\fR 期間，\fIstring\fR 中匹配 \fIexp\fR 的那部分將被替代爲 \fIsubSpec\fR。如果 \fIsubSpec\fR 包含一個``&''或``\e0''，則在這個替換中它被替代爲 \fIstring\fR 中匹配 \fIexp \fR的那部分。如果 \fIsubSpec\fR 包含一個``\e\fIn\fR''，這裏的 \fIn\fR 是在 1 和 9 之間的一個數字，則在這個替換中它將被替代爲 \fIstring\fR 中匹配第 \fIn \fR個圓括號中的子表達式 \fIexp \fR的那部分。 在 \fIsubSpec\fR 中可以使用額外的反斜槓來防對``&''、``\e0''、``\e\fIn\fR''或反斜槓的特殊解釋。在 \fIsubSpec\fR 中使用的反斜槓可能與 Tcl 分析器使用的反斜槓有所衝突。所以，如果 \fIsubSpec\fR 中包含反斜槓，最安全的方式通常是把 \fIsubSpec\fR 包圍在花括號中。
.LP
如果給 \fBregexp\fR 的初始的參數以 \fB-\fR 爲開始，則它們被作爲開關來對待。當前支持下列開關:
.TP 10
\fB\-all\fR
找到 \fIstring\fR 中匹配 \fIexp\fR  的所有範圍，並對每個範圍進行替換。沒有這個選項，則只有第一個匹配的範圍被找到並替換。如果指定了 \fB-all\fR，則對於每次替換使用相應的匹配信息來處理``&''和``\e\fIn\fR''序列。
.TP 15
\fB\-expanded\fR
啓用展開的(expanded)正則表示式語法，將忽略白空格和註釋。這與指定 \fB(?x)\fR 嵌入選項相同。 (see METASYNTAX, below).
.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 10
\fB\-nocase\fR
Upper-case characters in \fIstring\fR will be converted to lower-case
before matching against \fIexp\fR;  however, substitutions specified
by \fIsubSpec\fR use the original unconverted form of \fIstring\fR.
.VS 8.3
.TP 10
\fB\-start\fR \fIindex\fR
在字符串中指定一個字符索引，在這個偏移量上開始匹配。當使用了這個開關的時候，‘^’將不匹配行的開始，而     \\A  將仍舊在 \fIindex \fR上匹配字符串的開始。\fIindex\fR 將被約束爲輸入字符串的束縛。
.VE 8.3
.TP 10
\fB\-\|\-\fR
標記開關的結束。這個標誌之後的參數即使以 \fB- \fR爲開始仍被作爲 \fIexp\fR 對待。
.PP
這個命令返回找到並替換的匹配範圍的總數。正則表達式的解釋詳見 \fBregexp\fR 的手冊條目。

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

.SH "關鍵字 KEYWORDS"
match, pattern, regular expression, substitute

.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