Skip to content

Commit

Permalink
man: explicitly document default mark usage
Browse files Browse the repository at this point in the history
Marks use 'am and 'aM to mirror register usage for yank/put and allow a
default mark when one is not specified.  For anyone coming from vim and
used to ma and 'a usage, using a default mark when none is specified is
a foreign concept.  This leads to e.g. ''m and ''| when m and | would do.

Explain in the man page that the default mark is used when none is
specified for mark and selection set operations.

[0]: ad10da5 (vis: cleanup marks implementation)
  • Loading branch information
deepcube committed Jun 15, 2022
1 parent 22d4709 commit 230605d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions man/vis.1
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,11 @@ sets the mark
while
.Ic ' Ns Ar a Ns Ic M
restores it.
Use of
.Ic m
or
.Ic M
without specifying a mark uses the default mark.
.Pp
Available marks are:
.Bl -tag -width indent
Expand Down Expand Up @@ -1158,6 +1163,13 @@ align all selections by inserting spaces
Selections can be manipulated using set operations.
The first operand is the currently active selections while the second
can be specified as a mark.
For example,
.Ic ' Ns Ar a Ns Ic \&|
produces the union of the mark
.Ar a
and the current selection.
Use of set operations without specifying a mark use the default mark as
the first operand.
.Pp
.Bl -tag -width XXXXXXXXXX -compact
.It Ic \&|
Expand Down

0 comments on commit 230605d

Please sign in to comment.