Module Name: src
Committed By: wiz
Date: Sat Aug 2 06:20:56 UTC 2014
Modified Files:
src/usr.bin/timeout: timeout.1
Log Message:
Punctuation, markup, whitespace improvements.
To generate a diff of this commit:
cvs rdiff -u -r1.2 -r1.3 src/usr.bin/timeout/timeout.1
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/timeout/timeout.1
diff -u src/usr.bin/timeout/timeout.1:1.2 src/usr.bin/timeout/timeout.1:1.3
--- src/usr.bin/timeout/timeout.1:1.2 Fri Aug 1 14:01:30 2014
+++ src/usr.bin/timeout/timeout.1 Sat Aug 2 06:20:56 2014
@@ -1,4 +1,4 @@
-.\" $NetBSD: timeout.1,v 1.2 2014/08/01 14:01:30 christos Exp $
+.\" $NetBSD: timeout.1,v 1.3 2014/08/02 06:20:56 wiz Exp $
.\"
.\" Copyright (c) 2014 Baptiste Daroussin <b...@freebsd.org>
.\" All rights reserved.
@@ -34,10 +34,10 @@
.Nd run a command with a time limit
.Sh SYNOPSIS
.Nm
-.Op Fl -signal Ar sig | Fl s Ar sig
-.Op Fl -preserve-status
-.Op Fl -kill-after Ar time | Fl k Ar time
-.Op Fl -foreground
+.Op Fl Fl signal Ar sig | Fl s Ar sig
+.Op Fl Fl preserve-status
+.Op Fl Fl kill-after Ar time | Fl k Ar time
+.Op Fl Fl foreground
.Ao Ar duration Ac
.Ao Ar command Ac
.Ao Ar args ... Ac
@@ -46,30 +46,30 @@
starts the
.Ar command
with its
-.Ar args.
+.Ar args .
If
.Ar command
is still running after
.Ar duration ,
it is killed.
By default,
-.Ar SIGTERM.
+.Dv SIGTERM .
is sent.
.Bl -tag -width "-k time, --kill-after time"
-.It Fl -preserve-status
+.It Fl Fl preserve-status
Always exits with the same status as
.Ar command
even if it times out.
-.It Fl -foreground
+.It Fl Fl foreground
Do not propagate timeout to the
.Ar command
children.
-.It Fl s Ar sig , Fl -signal Ar sig
+.It Fl s Ar sig , Fl Fl signal Ar sig
Specify the signal to send on timeout.
By default,
-.Ar SIGTERM .
+.Dv SIGTERM .
is sent.
-.It Fl k Ar time , Fl -kill-after Ar time
+.It Fl k Ar time , Fl Fl kill-after Ar time
Send a second kill signal if
.Ar command
is still running after
@@ -100,12 +100,12 @@ If the timeout was not reached, the exit
is returned.
.Pp
If the timeout was reached and
-.Fl -preserve-status
+.Fl Fl preserve-status
is set, the exit status of
.Ar command
is returned.
If
-.Fl -preserve-status
+.Fl Fl preserve-status
is not set, an exit status of 124 is returned.
.Pp
If
@@ -124,7 +124,10 @@ and was imported into
The
.Fx
work is compatible with GNU
-.Xr timeout 1
-by Padraig Brady, from GNU Coreutils 8.21. The
-.Xr timeout 1
+.Nm
+by
+.An Padraig Brady ,
+from GNU Coreutils 8.21.
+The
+.Nm
utility first appeared in GNU Coreutils 7.0.
