vim: runtime/doc/change.txt comparison

comparison runtime/doc/change.txt @ 1621:82b5078be2dd

updated for version 7.2a

author	vimboss
date	Tue, 24 Jun 2008 21:56:24 +0000
parents	afad99b3612c
children	0b796e045c42

comparison

equal deleted inserted replaced

-:73fe8baea242
+:82b5078be2dd
-*change.txt*    For Vim version 7.1.  Last change: 2007 Jan 07
+*change.txt*    For Vim version 7.2a.  Last change: 2008 Jun 22
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
 further characters (just like Insert mode).  In Replace mode, the backspace
 key restores the original text (if there was any).  (See section "Insert and
 Replace mode" |mode-ins-repl|).
 						*cw* *cW*
-Special case: "cw" and "cW" work the same as "ce" and "cE" if the cursor is
+Special case: When the cursor is in a word, "cw" and "cW" do not include the
-on a non-blank.  This is because Vim interprets "cw" as change-word, and a
+white space after a word, they only change up to the end of the word.  This is
-word does not include the following white space.  {Vi: "cw" when on a blank
+because Vim interprets "cw" as change-word, and a word does not include the
-followed by other blanks changes only the first blank; this is probably a
+following white space.
-bug, because "dw" deletes all the blanks; use the 'w' flag in 'cpoptions' to
+{Vi: "cw" when on a blank followed by other blanks changes only the first
-make it work like Vi anyway}
+blank; this is probably a bug, because "dw" deletes all the blanks; use the
+'w' flag in 'cpoptions' to make it work like Vi anyway}
 If you prefer "cw" to include the space after a word, use this mapping: >
 	:map cw dwi
-<
+Or use "caw" (see |aw|).
 							*:c* *:ch* *:change*
 :{range}c[hange][!]	Replace lines of text with some different text.
 			Type a line containing only "." to stop replacing.
 			Without {range}, this command changes only the current
 			line.
 			|Visual-mode|).  {not in Vi}
 g?g?							*g?g?* *g??*
 g??			Rot13 encode current line. {not in Vi}.
+To turn one line into title caps, make every first letter of a word
+uppercase: >
+	:s/\v<(.)(\w*)/\u\1\L\2/g
 Adding and subtracting ~
 							*CTRL-A*
 CTRL-A			Add [count] to the number or alphabetic character at
 			or after the cursor.  {not in Vi}
 4.1 Filter commands					*filter*
 A filter is a program that accepts text at standard input, changes it in some
 way, and sends it to standard output.  You can use the commands below to send
-some text through a filter, so that it is replace by the filter output.
+some text through a filter, so that it is replaced by the filter output.
 Examples of filters are "sort", which sorts lines alphabetically, and
 "indent", which formats C program files (you need a version of indent that
 works like a filter; not all versions do).  The 'shell' option specifies the
 shell Vim uses to execute the filter command (See also the 'shelltype'
 option).  You can repeat filter commands with ".".  Vim does not recognize a
 		:&
 <	The last command will replace "blue" with "red".
 	{not in Vi}
 Note that there is no flag to change the "magicness" of the pattern.  A
-different command is used instead.  The reason is that the flags can only be
+different command is used instead, or you can use |/\v| and friends.  The
-found by skipping the pattern, and in order to skip the pattern the
+reason is that the flags can only be found by skipping the pattern, and in
-"magicness" must be known.  Catch 22!
+order to skip the pattern the "magicness" must be known.  Catch 22!
 If the {pattern} for the substitute command is empty, the command uses the
 pattern from the last substitute or ":global" command.  With the [r] flag, the
 command uses the pattern from the last substitute, ":global", or search
 command.
 can use any other single-byte character, but not an alphanumeric character,
 '\', '"' or '|'.  This is useful if you want to include a '/' in the search
 pattern or replacement string.  Example: >
 	:s+/+//+
-For the definition of a pattern, see |pattern|.
+For the definition of a pattern, see |pattern|.  In Visual block mode, use
+|/\%V| in the pattern to have the substitute work in the block only.
+Otherwise it works on whole lines anyway.
 					*sub-replace-special* *:s\=*
 When the {string} starts with "\=" it is evaluated as an expression, see
 |sub-replace-expression|.  You can use that for any special characters.
 Otherwise these characters in {string} have a special meaning:
 9. Last search pattern register	"/			*quote_/* *quote/*
 Contains the most recent search-pattern.  This is used for "n" and 'hlsearch'.
 It is writable with ":let", you can change it to have 'hlsearch' highlight
 other matches without actually searching.  You can't yank or delete into this
-register.  {not in Vi}
+register.  The search direction is available in |v:searchforward|.
+Note that the valued is restored when returning from a function
+|function-search-undo|.
+{not in Vi}
 							*@/*
 You can write to a register with a ":let" command |:let-@|.  Example: >
 	:let @/ = "the"
 There is no command in Vim to right justify text.  You can do it with
 an external command, like "par" (e.g.: "!}par" to format until the end of the
 paragraph) or set 'formatprg' to "par".
 							*format-comments*
-Vim can format comments in a special way.  Vim recognizes a comment by a
+An overview of comment formatting is in section |30.6| of the user manual.
-specific string at the start of the line (ignoring white space).  Three types
-of comments can be used:
+Vim can automatically insert and format comments in a special way.  Vim
+recognizes a comment by a specific string at the start of the line (ignoring
+white space).  Three types of comments can be used:
 - A comment string that repeats at the start of each line.  An example is the
 type of comment used in shell scripts, starting with "#".
 - A comment string that occurs only in the first line, not in the following
 lines.  An example is this list with dashes.
 - Three-piece comments that have a start string, an end string, and optional
 lines in between.  The strings for the start, middle and end are different.
-An example is the C-style comment:
+An example is the C style comment:
 	/*
 	 * this is a C comment
 	 */
 The 'comments' option is a comma-separated list of parts.  Each part defines a
 m	Middle of a three-piece comment
 e	End of a three-piece comment
-l	Left adjust middle with start or end (default).  Only recognized when
+l	Left align. Used together with 's' or 'e', the leftmost character of
-	used together with 's' or 'e'.
+	start or end will line up with the leftmost character from the middle.
+	This is the default and can be omitted. See below for more details.
-r	Right adjust middle with start or end.  Only recognized when used
-	together with 's' or 'e'.
+r	Right align. Same as above but rightmost instead of leftmost. See
+	below for more details.
-O	Don't use this one for the "O" command.
+O	Don't consider this comment for the "O" command.
 x	Allows three-piece comments to be ended by just typing the last
-	character of the end-comment string as the first character on a new
+	character of the end-comment string as the first action on a new
-	line, when the middle-comment string has already been inserted
+	line when the middle-comment string has been inserted automatically.
-	automatically.  See below for more details.
+	See below for more details.
 {digits}
-	When together with 's' or 'e': add extra indent for the middle part.
+	When together with 's' or 'e': add {digit} amount of offset to an
-	This can be used to left-align the middle part with the start or end
+	automatically inserted middle or end comment leader. The offset begins
-	and then add an offset.
+	from a left alignment. See below for more details.
 -{digits}
 	Like {digits} but reduce the indent.  This only works when there is
 	some indent for the start or end part that can be removed.
 the comment does not continue on the next line.  Three-piece comments must
 have a middle string because otherwise Vim can't recognize the middle lines.
 Notice the use of the "x" flag in the above three-piece comment definition.
 When you hit Return in a C-comment, Vim will insert the middle comment leader
-for the new line, e.g. " * ".  To close this comment you just have to type "/"
+for the new line: " * ".  To close this comment you just have to type "/"
 before typing anything else on the new line.  This will replace the
-middle-comment leader with the end-comment leader, leaving just " */".  There
+middle-comment leader with the end-comment leader and apply any specified
-is no need to hit BackSpace first.
+alignment, leaving just " */".  There is no need to hit BackSpace first.
-Examples: >
+Here is an example of alignment flags at work to make a comment stand out
+(kind of looks like a 1 too). Consider comment string >
+	sr:/***,m:**,ex2:******/
+/***
+**<--right aligned from "r" flag
+**
+offset 2 spaces from the "2" flag--->**
+******/
+In this case, the first comment was typed, then return was pressed 4 times,
+then "/" was pressed to end the comment.
+Here are some finer points of three part comments. There are three times when
+alignment and offset flags are taken into consideration: opening a new line
+after a start-comment, opening a new line before an end-comment, and
+automatically ending a three-piece comment.  The end alignment flag has a
+backwards perspective; the result is that the same alignment flag used with
+"s" and "e" will result in the same indent for the starting and ending pieces.
+Only one alignment per comment part is meant to be used, but an offset number
+will override the "r" and "l" flag.
+Enabling 'cindent' will override the alignment flags in many cases.
+Reindenting using a different method like |gq| or |=| will not consult
+alignment flags either. The same behaviour can be defined in those other
+formatting options. One consideration is that 'cindent' has additional options
+for context based indenting of comments but cannot replicate many three piece
+indent alignments.  However, 'indentexpr' is has the ability to work better
+with three piece comments.
+Other examples: >
 "b:*"	Includes lines starting with "*", but not if the "*" is
 		followed by a non-blank.  This avoids a pointer dereference
 		like "*str" to be recognized as a comment.
 "n:>"	Includes a line starting with ">", ">>", ">>>", etc.
 "fb:-"	Format a list that starts with "- ".
 By default, "b:#" is included.  This means that a line that starts with
 "#include" is not recognized as a comment line.  But a line that starts with
 "# define" is recognized.  This is a compromise.
-Often the alignment can be changed from right alignment to a left alignment
-with an additional space.  For example, for Javadoc comments, this can be
-used (insert a backslash before the space when using ":set"): >
-	s1:/*,mb:*,ex:*/
-Note that an offset is included with start, so that the middle part is left
-aligned with the start and then an offset of one character added.  This makes
-it possible to left align the start and middle for this construction: >
-	/**
-	 * comment
-	 */
 {not available when compiled without the |+comments| feature}
 							*fo-table*
 You can use the 'formatoptions' option  to influence how Vim formats text.
 	When the 'c' flag is present this only happens for recognized
 	comments.
 n	When formatting text, recognize numbered lists.  This actually uses
 	the 'formatlistpat' option, thus any kind of list can be used.  The
 	indent of the text after the number is used for the next line.  The
-	default is to find a number, optionally be followed by '.', ':', ')',
+	default is to find a number, optionally followed by '.', ':', ')',
 	']' or '}'.  Note that 'autoindent' must be set too.  Doesn't work
 	well together with "2".
 	Example: >
 		1. the first item
 		   wraps
 <			To sort on the text at virtual column 10 (thus
 			ignoring the difference between tabs and spaces): >
 				:sort /.*\%10v/
 <			To sort on the first number in the line, no matter
 			what is in front of it: >
-				:sort /.*\ze\d/
+				:sort /.\{-}\ze\d/
+<			(Explanation: ".\{-}" matches any text, "\ze" sets the
-<			With [r] sorting is done on the matching {pattern}
+			end of the match and \d matches a digit.)
+			With [r] sorting is done on the matching {pattern}
 			instead of skipping past it as described above.
 			For example, to sort on only the first three letters
 			of each line: >
 				:sort /\a\a\a/ r

Mercurial > vim

comparison runtime/doc/change.txt @ 1621:82b5078be2dd