Subject: bin/11975: time(1) manpage not clear - patch included
To: None <gnats-bugs@gnats.netbsd.org>
From: Jeremy C. Reed <reed@reedmedia.net>
List: netbsd-bugs
Date: 01/16/2001 15:01:30
>Number:         11975
>Category:       bin
>Synopsis:       time.1 manual not clear, missing information
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bin-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Tue Jan 16 15:01:00 PST 2001
>Closed-Date:
>Last-Modified:
>Originator:     Jeremy C. Reed
>Release:        1.5.1_ALPHA
>Organization:
	
>Environment:
	
System: NetBSD rainier 1.5.1_ALPHA NetBSD 1.5.1_ALPHA (JCR-1.5-20010108) #0: Mon Jan 8 09:25:45 PST 2001 reed@rainier:/usr/src/sys/arch/i386/compile/JCR-1.5-20010108 i386


>Description:
 I was trying to figure out how I can see the I/O information reported by
time. Then I noticed that this is a default csh "time" feature. So I tried
the "-l" switch but it didn't work -- because time is also a built-in
feature of other shells such as in the NetBSD-included ksh. This should be
documented. Also the rusage information is unclear -- and not useful for
a newbie. And the manpage had to grammatical/spelling problems.
>How-To-Repeat:
man 1 time
>Fix:
Patch fixes spelling, grammar, adds ksh, adds rusage information.

--- /usr/src/usr.bin/time/time.1	Sat Jun  5 12:19:19 1999
+++ time.1	Tue Jan 16 14:49:32 2001
@@ -65,26 +65,61 @@
 Available options:
 .Bl -tag -width Ds
 .It Fl l
+Lists the resource utilization information.
 The contents of the
 .Ar utility
 process'
 .Em rusage
-structure are printed.
+structure is printed. (See below.)
 .It Fl p
 The output is formatted as specified by
 .St -p1003.2-92 .
 .El
 .Pp
-The
+Some shells, such as
 .Xr csh 1
-has its own and syntactically different builtin version of
+and
+.Xr ksh 1 "" ,
+have their own and syntactically different built-in version of
 .Nm "" .
 The utility described here
 is available as
 .Pa /usr/bin/time
-to
-.Xr csh
-users.
+to these users.
+.Ss Resource Utilization
+If the
+.Fl l
+option is given, the following information is also displayed:
+.Bl -item -offset indent -compact
+.It
+maximum resident set size
+.It
+average shared memory size
+.It
+average unshared data size
+.It
+average unshared stack size
+.It
+page reclaims
+.It
+page faults
+.It
+swaps
+.It
+block input operations
+.It
+block output operations
+.It
+messages sent
+.It
+messages received
+.It
+signals received
+.It
+voluntary context switches
+.It
+involuntary context switches
+.El
 .Sh DIAGNOSTICS
 The
 .Nm
@@ -110,7 +145,8 @@
 .Ar utility .
 .Sh SEE ALSO
 .Xr csh 1 ,
-.Xr getrusage 2
+.Xr getrusage 2 ,
+.Xr ksh 1
 .Sh FILES
 .Bl -tag -width <sys/resource.h> -compact
 .It <sys/resource.h>


>Release-Note:
>Audit-Trail:
>Unformatted: