Discussion:
vi.1: pull in some changes from nvi2
Michael Reed
2016-02-11 18:09:27 UTC
Permalink
nvi2[1]'s man page has diverged a bit from our own. I think many of the
changes are for the better, although not all; because of that I'll be sending
a patch to nvi2 after this.

To ease review, this patch only includes the low hanging fruit--primarily typo
fixes and using correct macros.

[1]: https://github.com/lichray/nvi2



Index: vi.1
===================================================================
RCS file: /cvs/src/usr.bin/vi/docs/USD.doc/vi.man/vi.1,v
retrieving revision 1.64
diff -u -p -r1.64 vi.1
--- vi.1 9 Feb 2016 07:41:12 -0000 1.64
+++ vi.1 11 Feb 2016 18:01:20 -0000
@@ -189,7 +189,7 @@ to give information to you.
The other fact that you need to understand is that
.Nm vi
is a modeful editor,
-i.e. you are either entering text or you are executing commands,
+i.e., you are either entering text or you are executing commands,
and you have to be in the right mode to do one or the other.
You will be in command mode when you first start editing a file.
There are commands that switch you into input mode.
@@ -198,7 +198,7 @@ and that is the
.Aq escape
key.
.Pp
-Key names are written using angle brackets, e.g.\&
+Key names are written using angle brackets, e.g.,
.Aq escape
means the
.Dq escape
@@ -315,7 +315,7 @@ and long lines can take up more than a s
The above commands work on
.Dq physical
characters and lines,
-i.e. they affect the entire line no matter how many screen lines it takes up
+i.e., they affect the entire line no matter how many screen lines it takes up
and the entire character no matter how many screen columns it takes up.
.Sh REGULAR EXPRESSIONS
.Nm ex Ns / Ns Nm vi
@@ -478,7 +478,7 @@ It is specified using a line-oriented mo
.It
It is specified using one of the following motion commands:
.Aq Cm control-A ,
-.Cm ` Ns Aq Cm character ,
+.Cm ` Ns Aq Ar character ,
.Cm n ,
.Cm N ,
.Cm % ,
@@ -879,7 +879,7 @@ are treated as a single sentence.
.Cm ,\&
.Xc
Reverse find character
-(i.e. the last
+(i.e., the last
.Cm F ,
.Cm f ,
.Cm T
@@ -988,7 +988,7 @@ command.
.Cm ;\&
.Xc
Repeat the last character find
-(i.e. the last
+(i.e., the last
.Cm F ,
.Cm f ,
.Cm T
@@ -1520,7 +1520,7 @@ If
is given,
display the screen before the screen before
.Ar count1
-.Pq i.e. 2 screens before .
+.Pq i.e., 2 screens before .
Otherwise, display the screen before the current screen.
.El
.Pp
@@ -2059,10 +2059,11 @@ If this is the entire
pattern, the replacement part of the previous
.Cm substitute
command.
-.It Sq \e#
+.It Sq Pf \e Ar #
Where
-.Sq #
-is an integer from 1 to 9, the text matched by the #'th subexpression in
+.Sq Ar #
+is an integer from 1 to 9, the text matched by the
+.Ar # Ns 'th subexpression in
.Ar pattern .
.It Sq \eL
Causes the characters up to the end of the line of the next occurrence of
@@ -2247,7 +2248,7 @@ default values.
In each entry below, the first part of the tag line is the full name
of the option, followed by any equivalent abbreviations.
The part in square brackets is the default value of the option.
-Most of the options are boolean, i.e. they are either on or off,
+Most of the options are boolean, i.e., they are either on or off,
and do not have an associated value.
.Pp
Options apply to both
@@ -2391,7 +2392,7 @@ commands are disallowed.
.Nm vi
only.
Optimize text throughput to dumb terminals.
-This option is not yet implemented
+This option is not yet implemented.
.It Cm paragraphs , para Bq "IPLPPPQPP LIpplpipbp"
.Nm vi
only.
@@ -2482,7 +2483,7 @@ This option will never be implemented.
This option sets tab widths for the editor display.
.It Cm taglength , tl Bq 0
Set the number of significant characters in tag names.
-.It Cm tags, tag Bq tags
+.It Cm tags , tag Bq tags
Set the list of tags files.
.It Xo
.Cm term , ttytype , tty
@@ -2591,8 +2592,7 @@ and
.Pa $HOME/.exrc
files.
This value is also used as the default directory for the
-.Nm vi
-.Cm cd
+.Ic cd
command.
.It Ev LINES
The number of rows on the screen.
@@ -2629,7 +2629,7 @@ option is explicitly reset by the user,
.Nm ex Ns / Ns Nm vi
enters the value into the environment.
.It Ev TMPDIR
-The location used to stored temporary files (see also the
+The location used to store temporary files (see also the
.Cm directory
edit option).
.El
Jason McIntyre
2016-02-11 18:24:19 UTC
Permalink
Post by Michael Reed
nvi2[1]'s man page has diverged a bit from our own. I think many of the
changes are for the better, although not all; because of that I'll be sending
a patch to nvi2 after this.
To ease review, this patch only includes the low hanging fruit--primarily typo
fixes and using correct macros.
[1]: https://github.com/lichray/nvi2
Index: vi.1
===================================================================
RCS file: /cvs/src/usr.bin/vi/docs/USD.doc/vi.man/vi.1,v
retrieving revision 1.64
diff -u -p -r1.64 vi.1
--- vi.1 9 Feb 2016 07:41:12 -0000 1.64
+++ vi.1 11 Feb 2016 18:01:20 -0000
@@ -189,7 +189,7 @@ to give information to you.
The other fact that you need to understand is that
.Nm vi
is a modeful editor,
-i.e. you are either entering text or you are executing commands,
+i.e., you are either entering text or you are executing commands,
without reading any further, please do not submit diffs for adding
commas after i.e. and e.g. it is an abhorrence.

it is, however, correct as far as some folks are concerned, so for that
reason i haven;t nuked the ones we have.

if the author spells that way, it stays.
if there are inconsistencies in the page, we can change one way or the
other.

but no new ones, please! if you have any kind of heart, you'll be
requesting the nvi2 folks remove them.

jmc
Post by Michael Reed
and you have to be in the right mode to do one or the other.
You will be in command mode when you first start editing a file.
There are commands that switch you into input mode.
@@ -198,7 +198,7 @@ and that is the
.Aq escape
key.
.Pp
-Key names are written using angle brackets, e.g.\&
+Key names are written using angle brackets, e.g.,
.Aq escape
means the
.Dq escape
@@ -315,7 +315,7 @@ and long lines can take up more than a s
The above commands work on
.Dq physical
characters and lines,
-i.e. they affect the entire line no matter how many screen lines it takes up
+i.e., they affect the entire line no matter how many screen lines it takes up
and the entire character no matter how many screen columns it takes up.
.Sh REGULAR EXPRESSIONS
.Nm ex Ns / Ns Nm vi
@@ -478,7 +478,7 @@ It is specified using a line-oriented mo
.It
.Aq Cm control-A ,
-.Cm ` Ns Aq Cm character ,
+.Cm ` Ns Aq Ar character ,
.Cm n ,
.Cm N ,
.Cm % ,
@@ -879,7 +879,7 @@ are treated as a single sentence.
.Cm ,\&
.Xc
Reverse find character
-(i.e. the last
+(i.e., the last
.Cm F ,
.Cm f ,
.Cm T
@@ -988,7 +988,7 @@ command.
.Cm ;\&
.Xc
Repeat the last character find
-(i.e. the last
+(i.e., the last
.Cm F ,
.Cm f ,
.Cm T
@@ -1520,7 +1520,7 @@ If
is given,
display the screen before the screen before
.Ar count1
-.Pq i.e. 2 screens before .
+.Pq i.e., 2 screens before .
Otherwise, display the screen before the current screen.
.El
.Pp
@@ -2059,10 +2059,11 @@ If this is the entire
pattern, the replacement part of the previous
.Cm substitute
command.
-.It Sq \e#
+.It Sq Pf \e Ar #
Where
-.Sq #
-is an integer from 1 to 9, the text matched by the #'th subexpression in
+.Sq Ar #
+is an integer from 1 to 9, the text matched by the
+.Ar # Ns 'th subexpression in
.Ar pattern .
.It Sq \eL
Causes the characters up to the end of the line of the next occurrence of
@@ -2247,7 +2248,7 @@ default values.
In each entry below, the first part of the tag line is the full name
of the option, followed by any equivalent abbreviations.
The part in square brackets is the default value of the option.
-Most of the options are boolean, i.e. they are either on or off,
+Most of the options are boolean, i.e., they are either on or off,
and do not have an associated value.
.Pp
Options apply to both
@@ -2391,7 +2392,7 @@ commands are disallowed.
.Nm vi
only.
Optimize text throughput to dumb terminals.
-This option is not yet implemented
+This option is not yet implemented.
.It Cm paragraphs , para Bq "IPLPPPQPP LIpplpipbp"
.Nm vi
only.
@@ -2482,7 +2483,7 @@ This option will never be implemented.
This option sets tab widths for the editor display.
.It Cm taglength , tl Bq 0
Set the number of significant characters in tag names.
-.It Cm tags, tag Bq tags
+.It Cm tags , tag Bq tags
Set the list of tags files.
.It Xo
.Cm term , ttytype , tty
@@ -2591,8 +2592,7 @@ and
.Pa $HOME/.exrc
files.
This value is also used as the default directory for the
-.Nm vi
-.Cm cd
+.Ic cd
command.
.It Ev LINES
The number of rows on the screen.
@@ -2629,7 +2629,7 @@ option is explicitly reset by the user,
.Nm ex Ns / Ns Nm vi
enters the value into the environment.
.It Ev TMPDIR
-The location used to stored temporary files (see also the
+The location used to store temporary files (see also the
.Cm directory
edit option).
.El
Loading...