dash.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* Small cleanup to src/dash.1 - Command Line Editing
@ 2017-06-17 14:53 Larry Hynes
  2017-06-23 14:41 ` Jilles Tjoelker
  0 siblings, 1 reply; 3+ messages in thread
From: Larry Hynes @ 2017-06-17 14:53 UTC (permalink / raw)
  To: dash

Hi

src/dash.1, under Command Line Editing, states:

	It's similar to vi: typing <ESC> will throw you into command
	VI command mode.

- There appears to be no need for both occurrences of 'command'
- I can't see a reason for VI to be capitalised
- 'will throw you into' seems a little... enthusiastic

Following diff changes it to

	It's similar to vi: typing <ESC> enters vi command mode.

diff --git a/src/dash.1 b/src/dash.1
index 8b8026d..f35d89d 100644
--- a/src/dash.1
+++ b/src/dash.1
@@ -2232,7 +2232,7 @@ enabled, sh can be switched between insert mode and command mode.
 The editor is not described in full here, but will be in a later document.
 It's similar to vi: typing
 .Aq ESC
-will throw you into command VI command mode.
+enters vi command mode.
 Hitting
 .Aq return
 while in command mode will pass the line to the shell.


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Small cleanup to src/dash.1 - Command Line Editing
  2017-06-17 14:53 Small cleanup to src/dash.1 - Command Line Editing Larry Hynes
@ 2017-06-23 14:41 ` Jilles Tjoelker
  2017-06-23 16:42   ` Larry Hynes
  0 siblings, 1 reply; 3+ messages in thread
From: Jilles Tjoelker @ 2017-06-23 14:41 UTC (permalink / raw)
  To: Larry Hynes; +Cc: dash

On Sat, Jun 17, 2017 at 03:53:26PM +0100, Larry Hynes wrote:
> src/dash.1, under Command Line Editing, states:

> 	It's similar to vi: typing <ESC> will throw you into command
> 	VI command mode.

> - There appears to be no need for both occurrences of 'command'
> - I can't see a reason for VI to be capitalised
> - 'will throw you into' seems a little... enthusiastic

> Following diff changes it to

> 	It's similar to vi: typing <ESC> enters vi command mode.

> diff --git a/src/dash.1 b/src/dash.1
> index 8b8026d..f35d89d 100644
> --- a/src/dash.1
> +++ b/src/dash.1
> @@ -2232,7 +2232,7 @@ enabled, sh can be switched between insert mode and command mode.
>  The editor is not described in full here, but will be in a later document.
>  It's similar to vi: typing
>  .Aq ESC
> -will throw you into command VI command mode.
> +enters vi command mode.
>  Hitting
>  .Aq return
>  while in command mode will pass the line to the shell.

I agree. If you're changing things here anyway, I suggest getting rid of
the contraction as well (changing It's to It is). The fairly formal
style of man pages avoids contractions, just like it avoids "you".

The reference to the "later document" can probably be removed as well,
since said document does not exist yet after many years.

-- 
Jilles Tjoelker

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Small cleanup to src/dash.1 - Command Line Editing
  2017-06-23 14:41 ` Jilles Tjoelker
@ 2017-06-23 16:42   ` Larry Hynes
  0 siblings, 0 replies; 3+ messages in thread
From: Larry Hynes @ 2017-06-23 16:42 UTC (permalink / raw)
  To: dash

Jilles Tjoelker <jilles@stack.nl> wrote:
> On Sat, Jun 17, 2017 at 03:53:26PM +0100, Larry Hynes wrote:
>> src/dash.1, under Command Line Editing, states:

>>       It's similar to vi: typing <ESC> will throw you into command
>>       VI command mode.

>> - There appears to be no need for both occurrences of 'command'
>> - I can't see a reason for VI to be capitalised
>> - 'will throw you into' seems a little... enthusiastic

>> Following diff changes it to

>>       It's similar to vi: typing <ESC> enters vi command mode.

>> diff --git a/src/dash.1 b/src/dash.1
>> index 8b8026d..f35d89d 100644
>> --- a/src/dash.1
>> +++ b/src/dash.1
>> @@ -2232,7 +2232,7 @@ enabled, sh can be switched between insert mode and command mode.
>>  The editor is not described in full here, but will be in a later document.
>>  It's similar to vi: typing
>>  .Aq ESC
>> -will throw you into command VI command mode.
>> +enters vi command mode.
>>  Hitting
>>  .Aq return
>>  while in command mode will pass the line to the shell.

> I agree. If you're changing things here anyway, I suggest getting rid of
> the contraction as well (changing It's to It is). The fairly formal
> style of man pages avoids contractions, just like it avoids "you".

> The reference to the "later document" can probably be removed as well,
> since said document does not exist yet after many years.

Hi

Revised diff, below, expands the contraction, deletes reference to
'later document' and changes 'place' to 'places' in the following:

	The command ‘set -o vi’ enables vi-mode editing and place sh
	into vi insert mode.

diff --git a/src/dash.1 b/src/dash.1
index 8b8026d..1056285 100644
--- a/src/dash.1
+++ b/src/dash.1
@@ -2226,13 +2226,12 @@ This mode uses commands, described below,
 similar to a subset of those described in the vi man page.
 The command
 .Ql set -o vi
-enables vi-mode editing and place sh into vi insert mode.
+enables vi-mode editing and places sh into vi insert mode.
 With vi-mode
 enabled, sh can be switched between insert mode and command mode.
-The editor is not described in full here, but will be in a later document.
-It's similar to vi: typing
+It is similar to vi: typing
 .Aq ESC
-will throw you into command VI command mode.
+enters vi command mode.
 Hitting
 .Aq return
 while in command mode will pass the line to the shell.


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2017-06-23 17:00 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-06-17 14:53 Small cleanup to src/dash.1 - Command Line Editing Larry Hynes
2017-06-23 14:41 ` Jilles Tjoelker
2017-06-23 16:42   ` Larry Hynes

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).