Add time(1) manual page
This commit is contained in:
Petr Písař
parent
1910d5511f
commit
4b5d06c3ce
210
time-1.9-Add-time-1-manual-page.patch
Normal file
210
time-1.9-Add-time-1-manual-page.patch
Normal file
@ -0,0 +1,210 @@
|
||||
From 2bb554d5429e21c8e54cff7893525643654e0dcf Mon Sep 17 00:00:00 2001
|
||||
From: =?UTF-8?q?Petr=20P=C3=ADsa=C5=99?= <ppisar@redhat.com>
|
||||
Date: Mon, 6 Aug 2018 09:11:33 +0200
|
||||
Subject: [PATCH] Add time(1) manual page
|
||||
MIME-Version: 1.0
|
||||
Content-Type: text/plain; charset=UTF-8
|
||||
Content-Transfer-Encoding: 8bit
|
||||
|
||||
The text is based on time --help output and time info pages. The
|
||||
sesction about exit code is a new one.
|
||||
|
||||
Signed-off-by: Petr Písař <ppisar@redhat.com>
|
||||
---
|
||||
Makefile.am | 1 +
|
||||
doc/time.1 | 171 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
2 files changed, 172 insertions(+)
|
||||
create mode 100644 doc/time.1
|
||||
|
||||
diff --git a/Makefile.am b/Makefile.am
|
||||
index 861c3ae..4827489 100644
|
||||
--- a/Makefile.am
|
||||
+++ b/Makefile.am
|
||||
@@ -56,6 +56,7 @@ doc_time_TEXINFOS = \
|
||||
doc/fdl.texi \
|
||||
doc/version.texi
|
||||
|
||||
+man_MANS = doc/time.1
|
||||
|
||||
DISTCLEANFILES =
|
||||
|
||||
diff --git a/doc/time.1 b/doc/time.1
|
||||
new file mode 100644
|
||||
index 0000000..fa0b0bb
|
||||
--- /dev/null
|
||||
+++ b/doc/time.1
|
||||
@@ -0,0 +1,171 @@
|
||||
+.TH TIME "1" "August 2018" "GNU time" "User Commands"
|
||||
+.SH NAME
|
||||
+time \- print system resources used by a command
|
||||
+.SH SYNOPSIS
|
||||
+.B time
|
||||
+[\fIOPTIONS\fR] \fICOMMAND\fR [\fIARG\fI]...
|
||||
+.SH DESCRIPTION
|
||||
+.PP
|
||||
+Run \fBCOMMAND\fR, then print system resource usage.
|
||||
+.TP
|
||||
+\fB\-a\fR, \fB\-\-append\fR
|
||||
+With \fB\-o\fR \fIFILE\fR option, append instead of overwriting.
|
||||
+.TP
|
||||
+\fB\-f\fR, \fB\-\-format\fR=\fIFORMAT\fR
|
||||
+Use the specified \fIFORMAT\fR instead of the default.
|
||||
+.TP
|
||||
+\fB\-h\fR, \fB\-\-help\fR
|
||||
+Display this help text and exit.
|
||||
+.TP
|
||||
+\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
|
||||
+Write to \fIFILE\fR instead of standard error output.
|
||||
+.TP
|
||||
+\fB\-p\fR, \fB\-\-portability\fR
|
||||
+Print POSIX standard 1003.2 conformant string:
|
||||
+.P
|
||||
+.RS
|
||||
+.nf
|
||||
+.eo
|
||||
+ real %%e
|
||||
+ user %%U
|
||||
+ sys %%S
|
||||
+.ec
|
||||
+.fi
|
||||
+.RE
|
||||
+.TP
|
||||
+\fB\-q\fR, \fB\-\-quiet\fR
|
||||
+Do not print information about abnormal program termination (non-zero exit
|
||||
+codes or signals).
|
||||
+.TP
|
||||
+\fB\-v\fR, \fB\-\-verbose\fR
|
||||
+Print all resource usage information instead of the default format.
|
||||
+.TP
|
||||
+\fB\-V\fR, \fB\-\-version\fR
|
||||
+Output version information and exit.
|
||||
+.SH FORMAT SEQUENCES
|
||||
+Format sequences used for \fB\-f\fR/\fB\-\-format\fR option:
|
||||
+.P
|
||||
+.RS
|
||||
+.PD 0
|
||||
+.TP
|
||||
+.B \(rs\(rs
|
||||
+a literal backslash
|
||||
+.TP
|
||||
+.B \(rsn
|
||||
+a new-line character
|
||||
+.TP
|
||||
+.B \(rst
|
||||
+a tab character
|
||||
+.TP
|
||||
+.B %%
|
||||
+a literal \(oq%\(cq
|
||||
+.TP
|
||||
+.B %C
|
||||
+command line and arguments
|
||||
+.TP
|
||||
+.B %c
|
||||
+involuntary context switches
|
||||
+.TP
|
||||
+.B %D
|
||||
+average size of the unshared data area in KB
|
||||
+.TP
|
||||
+.B %E
|
||||
+elapsed real time (wall clock) in [hour:]min:sec
|
||||
+.TP
|
||||
+.B %e
|
||||
+elapsed real time (wall clock) in seconds
|
||||
+.TP
|
||||
+.B %F
|
||||
+major page faults
|
||||
+.TP
|
||||
+.B %I
|
||||
+number of file system inputs by the process
|
||||
+.TP
|
||||
+.B %K
|
||||
+average total (data + stack + text) memory use in KB
|
||||
+.TP
|
||||
+.B %k
|
||||
+number of delivered signals
|
||||
+.TP
|
||||
+.B %M
|
||||
+maximum resident set size in KB
|
||||
+.TP
|
||||
+.B %O
|
||||
+number of file system outputs
|
||||
+.TP
|
||||
+.B %P
|
||||
+percent of CPU this job got
|
||||
+.TP
|
||||
+.B %p
|
||||
+average size of the unshared stack in KB
|
||||
+.TP
|
||||
+.B %R
|
||||
+minor page faults
|
||||
+.TP
|
||||
+.B %r
|
||||
+number of received socket messages
|
||||
+.TP
|
||||
+.B %S
|
||||
+system (kernel) time in seconds
|
||||
+.TP
|
||||
+.B %s
|
||||
+number of sent socket messages
|
||||
+.TP
|
||||
+.B %t
|
||||
+average resident set size in KB
|
||||
+.TP
|
||||
+.B %U
|
||||
+user time in seconds
|
||||
+.TP
|
||||
+.B %W
|
||||
+number of times the process was swapped out of a main memory
|
||||
+.TP
|
||||
+.B %w
|
||||
+voluntary context switches
|
||||
+.TP
|
||||
+.B %X
|
||||
+average size of the shared text in KB
|
||||
+.TP
|
||||
+.B %x
|
||||
+exit status of the command
|
||||
+.TP
|
||||
+.B %Z
|
||||
+System's page size in B
|
||||
+.PD
|
||||
+.RE
|
||||
+.PP
|
||||
+Default output format:
|
||||
+.P
|
||||
+.RS
|
||||
+.nf
|
||||
+.eo
|
||||
+%Uuser %Ssystem %Eelapsed %PCPU (%Xavgtext+%Davgdata %Mmaxresident)k
|
||||
+%Iinputs+%Ooutputs (%Fmajor+%Rminor)pagefaults %Wswaps
|
||||
+.ec
|
||||
+.fi
|
||||
+.RE
|
||||
+.SH EXIT STATUS
|
||||
+The \fBCOMMAND\fR's exit code is returned by this \(oqtime\(cq tool. If the
|
||||
+\fBCOMMAND\fR exits with a non-zero status or is terminated by a signal,
|
||||
+\(oqtime\(cq displays a warning message and the exit status or signal number.
|
||||
+.SH NOTE
|
||||
+Your shell may have its own version of time, which usually supersedes
|
||||
+the version described here. Please refer to your shell's documentation
|
||||
+for details about the options it supports.
|
||||
+.SH REPORTING BUGS
|
||||
+E-mail bug reports to: <bug-time@gnu.org>
|
||||
+.SH COPYRIGHT
|
||||
+Copyright \(co 1991\(en2018 Free Software Foundation, Inc.
|
||||
+.br
|
||||
+Permission is granted to copy, distribute and/or modify this document
|
||||
+under the terms of the GNU Free Documentation License, Version 1.3 or
|
||||
+any later version published by the Free Software Foundation; with no
|
||||
+Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
||||
+Texts.
|
||||
+.SH "SEE ALSO"
|
||||
+GNU Time website: <https://www.gnu.org/software/time/>
|
||||
+.br
|
||||
+Full documentation at: <https://www.gnu.org/software/time/manual>
|
||||
+.br
|
||||
+or available locally via \fBinfo time\fR command.
|
||||
+
|
||||
--
|
||||
2.14.4
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
Summary: A GNU utility for monitoring a program's use of system resources
|
||||
Name: time
|
||||
Version: 1.9
|
||||
Release: 3%{?dist}
|
||||
Release: 4%{?dist}
|
||||
# src/time.c: GPLv3+
|
||||
# COPYING: GPLv3 text
|
||||
# doc/time.texi: GFDL
|
||||
@ -46,6 +46,8 @@ Source: ftp://ftp.gnu.org/gnu/%{name}/%{name}-%{version}.tar.gz
|
||||
Patch0: time-1.8-Prefer-clock_gettime-CLOCK_MONOTONIC.patch
|
||||
# Fix info directory entry
|
||||
Patch1: time-1.9-Improve-info-directory-index-entry-description.patch
|
||||
# Add time(1) manual page, bug #1612294
|
||||
Patch2: time-1.9-Add-time-1-manual-page.patch
|
||||
BuildRequires: autoconf
|
||||
BuildRequires: automake
|
||||
BuildRequires: bash
|
||||
@ -65,6 +67,7 @@ the results.
|
||||
%setup -q
|
||||
%patch0 -p1
|
||||
%patch1 -p1
|
||||
%patch2 -p1
|
||||
autoreconf -fi
|
||||
|
||||
%build
|
||||
@ -84,8 +87,12 @@ make %{?_smp_mflags} check
|
||||
%doc AUTHORS ChangeLog NEWS README
|
||||
%{_bindir}/time
|
||||
%{_infodir}/time.info*
|
||||
%{_mandir}/man1/time.*
|
||||
|
||||
%changelog
|
||||
* Mon Aug 06 2018 Petr Pisar <ppisar@redhat.com> - 1.9-4
|
||||
- Add time(1) manual page (bug #1612294)
|
||||
|
||||
* Sat Jul 14 2018 Fedora Release Engineering <releng@fedoraproject.org> - 1.9-3
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_29_Mass_Rebuild
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user