Bug 161088

Summary: [patch] grammar and markup in script.1
Product: Documentation Reporter: Ben Kaduk <kaduk>
Component: Books & ArticlesAssignee: Glen Barber <gjb>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Ben Kaduk 2011-09-28 03:00:19 UTC
There are grammar errors in script.1.  This patch fixes them.

Fix: Patch attached with submission follows:
Comment 1 dfilter service freebsd_committer freebsd_triage 2011-09-29 03:29:41 UTC
Author: gjb (doc committer)
Date: Thu Sep 29 02:29:32 2011
New Revision: 225857
URL: http://svn.freebsd.org/changeset/base/225857

Log:
  Fix a few grammar and mdoc nits in script.1
  
  PR:		161088
  Submitted by:	Ben Kaduk ( kaduk % mit ! edu )
  MFC after:	1 week
  Need-MFC:	225809

Modified:
  head/usr.bin/script/script.1

Modified: head/usr.bin/script/script.1
==============================================================================
--- head/usr.bin/script/script.1	Thu Sep 29 00:44:34 2011	(r225856)
+++ head/usr.bin/script/script.1	Thu Sep 29 02:29:32 2011	(r225857)
@@ -28,7 +28,7 @@
 .\"	@(#)script.1	8.1 (Berkeley) 6/6/93
 .\" $FreeBSD$
 .\"
-.Dd January 22, 2004
+.Dd September 28, 2011
 .Dt SCRIPT 1
 .Os
 .Sh NAME
@@ -73,15 +73,16 @@ or
 .Pa typescript ,
 retaining the prior contents.
 .It Fl k
-Log keys sent to program as well as output.
+Log keys sent to the program as well as output.
 .It Fl q
 Run in quiet mode, omit the start and stop status messages.
 .It Fl t Ar time
-Specify time interval between flushing script output file.
+Specify the interval at which the script output file will be flushed
+to disk, in seconds.
 A value of 0
 causes
 .Nm
-to flush for every character I/O event.
+to flush after every character I/O event.
 The default interval is
 30 seconds.
 .El
@@ -136,13 +137,15 @@ If
 .Ev SHELL
 is not set, the Bourne shell
 is assumed.
-(Most shells set this variable automatically).
+.Pq Most shells set this variable automatically .
 .El
 .Sh SEE ALSO
 .Xr csh 1
-(for the
+.Po
+for the
 .Em history
-mechanism).
+mechanism
+.Pc .
 .Sh HISTORY
 The
 .Nm
@@ -165,13 +168,15 @@ mode, echo cancelling is far from ideal.
 The slave terminal mode is checked
 for ECHO mode to check when to avoid manual echo logging.
 This does not
-work when in a raw mode where the program being run is doing manual echo.
+work when the terminal is in a raw mode where
+the program being run is doing manual echo.
 .Pp
-If the
+If
 .Nm
-reads zero bytes from the terminal it switches to a mode when it probes read
-only once a second until it gets some data.
-This prevents the
+reads zero bytes from the terminal, it switches to a mode when it
+only attempts to read
+once a second until there is data to read.
+This prevents
 .Nm
-spinning on zero-byte reads, but might cause a 1-second delay in
-processing of the user input.
+from spinning on zero-byte reads, but might cause a 1-second delay in
+processing of user input.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 2 Glen Barber freebsd_committer freebsd_triage 2011-09-29 03:29:46 UTC
State Changed
From-To: open->patched

Patched in HEAD.  MFC in 1 week (pending MFC of 225809). 



Comment 3 Glen Barber freebsd_committer freebsd_triage 2011-09-29 03:29:46 UTC
Responsible Changed
From-To: freebsd-doc->gjb

Over to me.
Comment 4 dfilter service freebsd_committer freebsd_triage 2011-10-10 12:06:12 UTC
Author: gjb (doc committer)
Date: Mon Oct 10 11:05:58 2011
New Revision: 226187
URL: http://svn.freebsd.org/changeset/base/226187

Log:
  MFC r225857:
   - Fix a few grammar and mdoc nits in script.1
  
  PR:		161088
  Approved by:	re (kib)

Modified:
  stable/9/usr.bin/script/script.1
Directory Properties:
  stable/9/usr.bin/script/   (props changed)

Modified: stable/9/usr.bin/script/script.1
==============================================================================
--- stable/9/usr.bin/script/script.1	Mon Oct 10 09:33:07 2011	(r226186)
+++ stable/9/usr.bin/script/script.1	Mon Oct 10 11:05:58 2011	(r226187)
@@ -28,7 +28,7 @@
 .\"	@(#)script.1	8.1 (Berkeley) 6/6/93
 .\" $FreeBSD$
 .\"
-.Dd January 22, 2004
+.Dd September 28, 2011
 .Dt SCRIPT 1
 .Os
 .Sh NAME
@@ -73,15 +73,16 @@ or
 .Pa typescript ,
 retaining the prior contents.
 .It Fl k
-Log keys sent to program as well as output.
+Log keys sent to the program as well as output.
 .It Fl q
 Run in quiet mode, omit the start and stop status messages.
 .It Fl t Ar time
-Specify time interval between flushing script output file.
+Specify the interval at which the script output file will be flushed
+to disk, in seconds.
 A value of 0
 causes
 .Nm
-to flush for every character I/O event.
+to flush after every character I/O event.
 The default interval is
 30 seconds.
 .El
@@ -136,13 +137,15 @@ If
 .Ev SHELL
 is not set, the Bourne shell
 is assumed.
-(Most shells set this variable automatically).
+.Pq Most shells set this variable automatically .
 .El
 .Sh SEE ALSO
 .Xr csh 1
-(for the
+.Po
+for the
 .Em history
-mechanism).
+mechanism
+.Pc .
 .Sh HISTORY
 The
 .Nm
@@ -165,13 +168,15 @@ mode, echo cancelling is far from ideal.
 The slave terminal mode is checked
 for ECHO mode to check when to avoid manual echo logging.
 This does not
-work when in a raw mode where the program being run is doing manual echo.
+work when the terminal is in a raw mode where
+the program being run is doing manual echo.
 .Pp
-If the
+If
 .Nm
-reads zero bytes from the terminal it switches to a mode when it probes read
-only once a second until it gets some data.
-This prevents the
+reads zero bytes from the terminal, it switches to a mode when it
+only attempts to read
+once a second until there is data to read.
+This prevents
 .Nm
-spinning on zero-byte reads, but might cause a 1-second delay in
-processing of the user input.
+from spinning on zero-byte reads, but might cause a 1-second delay in
+processing of user input.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 5 dfilter service freebsd_committer freebsd_triage 2011-10-10 12:07:07 UTC
Author: gjb (doc committer)
Date: Mon Oct 10 11:06:48 2011
New Revision: 226188
URL: http://svn.freebsd.org/changeset/base/226188

Log:
  MFC r225857:
   - Fix a few grammar and mdoc nits in script.1
  
  PR:		161088

Modified:
  stable/8/usr.bin/script/script.1
Directory Properties:
  stable/8/usr.bin/script/   (props changed)

Modified: stable/8/usr.bin/script/script.1
==============================================================================
--- stable/8/usr.bin/script/script.1	Mon Oct 10 11:05:58 2011	(r226187)
+++ stable/8/usr.bin/script/script.1	Mon Oct 10 11:06:48 2011	(r226188)
@@ -32,7 +32,7 @@
 .\"	@(#)script.1	8.1 (Berkeley) 6/6/93
 .\" $FreeBSD$
 .\"
-.Dd January 22, 2004
+.Dd September 28, 2011
 .Dt SCRIPT 1
 .Os
 .Sh NAME
@@ -77,15 +77,16 @@ or
 .Pa typescript ,
 retaining the prior contents.
 .It Fl k
-Log keys sent to program as well as output.
+Log keys sent to the program as well as output.
 .It Fl q
 Run in quiet mode, omit the start and stop status messages.
 .It Fl t Ar time
-Specify time interval between flushing script output file.
+Specify the interval at which the script output file will be flushed
+to disk, in seconds.
 A value of 0
 causes
 .Nm
-to flush for every character I/O event.
+to flush after every character I/O event.
 The default interval is
 30 seconds.
 .El
@@ -140,13 +141,15 @@ If
 .Ev SHELL
 is not set, the Bourne shell
 is assumed.
-(Most shells set this variable automatically).
+.Pq Most shells set this variable automatically .
 .El
 .Sh SEE ALSO
 .Xr csh 1
-(for the
+.Po
+for the
 .Em history
-mechanism).
+mechanism
+.Pc .
 .Sh HISTORY
 The
 .Nm
@@ -169,13 +172,15 @@ mode, echo cancelling is far from ideal.
 The slave terminal mode is checked
 for ECHO mode to check when to avoid manual echo logging.
 This does not
-work when in a raw mode where the program being run is doing manual echo.
+work when the terminal is in a raw mode where
+the program being run is doing manual echo.
 .Pp
-If the
+If
 .Nm
-reads zero bytes from the terminal it switches to a mode when it probes read
-only once a second until it gets some data.
-This prevents the
+reads zero bytes from the terminal, it switches to a mode when it
+only attempts to read
+once a second until there is data to read.
+This prevents
 .Nm
-spinning on zero-byte reads, but might cause a 1-second delay in
-processing of the user input.
+from spinning on zero-byte reads, but might cause a 1-second delay in
+processing of user input.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 6 Glen Barber freebsd_committer freebsd_triage 2011-10-10 12:07:45 UTC
State Changed
From-To: patched->closed

MFC'd to 9-STABLE, 8-STABLE, 7-STABLE.  Thanks!
Comment 7 dfilter service freebsd_committer freebsd_triage 2011-10-10 12:11:15 UTC
Author: gjb (doc committer)
Date: Mon Oct 10 11:07:36 2011
New Revision: 226189
URL: http://svn.freebsd.org/changeset/base/226189

Log:
  MFC r225857:
   - Fix a few grammar and mdoc nits in script.1
  
  PR:		161088

Modified:
  stable/7/usr.bin/script/script.1
Directory Properties:
  stable/7/usr.bin/script/   (props changed)

Modified: stable/7/usr.bin/script/script.1
==============================================================================
--- stable/7/usr.bin/script/script.1	Mon Oct 10 11:06:48 2011	(r226188)
+++ stable/7/usr.bin/script/script.1	Mon Oct 10 11:07:36 2011	(r226189)
@@ -32,7 +32,7 @@
 .\"	@(#)script.1	8.1 (Berkeley) 6/6/93
 .\" $FreeBSD$
 .\"
-.Dd January 22, 2004
+.Dd September 28, 2011
 .Dt SCRIPT 1
 .Os
 .Sh NAME
@@ -77,15 +77,16 @@ or
 .Pa typescript ,
 retaining the prior contents.
 .It Fl k
-Log keys sent to program as well as output.
+Log keys sent to the program as well as output.
 .It Fl q
 Run in quiet mode, omit the start and stop status messages.
 .It Fl t Ar time
-Specify time interval between flushing script output file.
+Specify the interval at which the script output file will be flushed
+to disk, in seconds.
 A value of 0
 causes
 .Nm
-to flush for every character I/O event.
+to flush after every character I/O event.
 The default interval is
 30 seconds.
 .El
@@ -140,13 +141,15 @@ If
 .Ev SHELL
 is not set, the Bourne shell
 is assumed.
-(Most shells set this variable automatically).
+.Pq Most shells set this variable automatically .
 .El
 .Sh SEE ALSO
 .Xr csh 1
-(for the
+.Po
+for the
 .Em history
-mechanism).
+mechanism
+.Pc .
 .Sh HISTORY
 The
 .Nm
@@ -169,13 +172,15 @@ mode, echo cancelling is far from ideal.
 The slave terminal mode is checked
 for ECHO mode to check when to avoid manual echo logging.
 This does not
-work when in a raw mode where the program being run is doing manual echo.
+work when the terminal is in a raw mode where
+the program being run is doing manual echo.
 .Pp
-If the
+If
 .Nm
-reads zero bytes from the terminal it switches to a mode when it probes read
-only once a second until it gets some data.
-This prevents the
+reads zero bytes from the terminal, it switches to a mode when it
+only attempts to read
+once a second until there is data to read.
+This prevents
 .Nm
-spinning on zero-byte reads, but might cause a 1-second delay in
-processing of the user input.
+from spinning on zero-byte reads, but might cause a 1-second delay in
+processing of user input.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"