From f0edc952c6547dedd481946ebd4d1a1ecfb04f7d Mon Sep 17 00:00:00 2001 From: Sascha Wildner Date: Wed, 1 Mar 2006 08:08:45 +0000 Subject: [PATCH] RETURN VALUES is for function return values only. FreeBSD has an own EXIT STATUS section for exit codes returned to the shell. Until we do as well, stuff it into DIAGNOSTICS as mdoc(7) advises. --- bin/test/test.1 | 4 ++-- bin/varsym/varsym.1 | 4 ++-- sbin/ping/ping.8 | 4 ++-- sbin/ping6/ping6.8 | 12 ++++++------ usr.bin/gzip/zgrep.1 | 4 ++-- usr.sbin/faithd/faithd.8 | 22 +++++++++++----------- usr.sbin/gifconfig/gifconfig.8 | 6 +++--- usr.sbin/mld6query/mld6query.8 | 4 ++-- usr.sbin/ndp/ndp.8 | 4 ++-- usr.sbin/rrenumd/rrenumd.8 | 4 ++-- usr.sbin/setkey/setkey.8 | 8 ++++---- usr.sbin/traceroute6/traceroute6.8 | 4 ++-- 12 files changed, 40 insertions(+), 40 deletions(-) diff --git a/bin/test/test.1 b/bin/test/test.1 index a79c7993e5..bd855f884d 100644 --- a/bin/test/test.1 +++ b/bin/test/test.1 @@ -34,7 +34,7 @@ .\" .\" @(#)test.1 8.1 (Berkeley) 5/31/93 .\" $FreeBSD: src/bin/test/test.1,v 1.11.2.5 2001/12/14 14:22:09 ru Exp $ -.\" $DragonFly: src/bin/test/test.1,v 1.5 2005/08/01 01:49:16 swildner Exp $ +.\" $DragonFly: src/bin/test/test.1,v 1.6 2006/03/01 08:08:44 swildner Exp $ .\" .Dd May 31, 1993 .Dt TEST 1 @@ -310,7 +310,7 @@ section D11.2/4.62.4, standard are evaluated consistently according to the rules specified in the standards document. All other cases are subject to the ambiguity in the command semantics. -.Sh RETURN VALUES +.Sh DIAGNOSTICS The .Nm utility exits with one of the following values: diff --git a/bin/varsym/varsym.1 b/bin/varsym/varsym.1 index 358dac2d05..1861ed02a2 100644 --- a/bin/varsym/varsym.1 +++ b/bin/varsym/varsym.1 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $DragonFly: src/bin/varsym/varsym.1,v 1.4 2005/08/01 01:49:16 swildner Exp $ +.\" $DragonFly: src/bin/varsym/varsym.1,v 1.5 2006/03/01 08:08:44 swildner Exp $ .\" .Dd Nov 5, 2003 .Dt VARSYM 1 @@ -66,7 +66,7 @@ retrievals to process-specific variables. Note that since is run as its own process, using this option to set a variable will not affect your shell's namespace. .El -.Sh RETURN VALUES +.Sh DIAGNOSTICS The .Nm utility exits with one of the following values: diff --git a/sbin/ping/ping.8 b/sbin/ping/ping.8 index 3bd390a5e4..a91b27420f 100644 --- a/sbin/ping/ping.8 +++ b/sbin/ping/ping.8 @@ -31,7 +31,7 @@ .\" .\" @(#)ping.8 8.2 (Berkeley) 12/11/93 .\" $FreeBSD: src/sbin/ping/ping.8,v 1.25.2.11 2003/02/23 21:03:24 trhodes Exp $ -.\" $DragonFly: src/sbin/ping/ping.8,v 1.2 2003/06/17 04:27:34 dillon Exp $ +.\" $DragonFly: src/sbin/ping/ping.8,v 1.3 2006/03/01 08:08:44 swildner Exp $ .\" .Dd September 25, 2001 .Dt PING 8 @@ -441,7 +441,7 @@ packets that they use for packets, for example either 30 or 60. Others may use completely wild values. .El -.Sh RETURN VALUES +.Sh DIAGNOSTICS The .Nm command returns an exit status of zero if at least one response was diff --git a/sbin/ping6/ping6.8 b/sbin/ping6/ping6.8 index 337a6a2ce3..59d334d1de 100644 --- a/sbin/ping6/ping6.8 +++ b/sbin/ping6/ping6.8 @@ -28,7 +28,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD: src/sbin/ping6/ping6.8,v 1.3.2.12 2003/02/24 00:56:42 trhodes Exp $ -.\" $DragonFly: src/sbin/ping6/ping6.8,v 1.4 2006/02/17 19:33:33 swildner Exp $ +.\" $DragonFly: src/sbin/ping6/ping6.8,v 1.5 2006/03/01 08:08:44 swildner Exp $ .\" .Dd May 17, 1998 .Dt PING6 8 @@ -400,11 +400,6 @@ using the .Fl p option of .Nm . -.Sh RETURN VALUES -The -.Nm -utility returns 0 on success (the host is alive), -and non-zero if the arguments are incorrect or the host is not responding. .Sh EXAMPLES Normally, .Nm @@ -432,6 +427,11 @@ The following will probe addresses assigned to the destination node, .Bd -literal -offset indent ping6 -a agl dst.foo.com .Ed +.Sh DIAGNOSTICS +The +.Nm +utility returns 0 on success (the host is alive), +and non-zero if the arguments are incorrect or the host is not responding. .Sh SEE ALSO .Xr netstat 1 , .Xr icmp6 4 , diff --git a/usr.bin/gzip/zgrep.1 b/usr.bin/gzip/zgrep.1 index a839ea6357..1c677719a8 100644 --- a/usr.bin/gzip/zgrep.1 +++ b/usr.bin/gzip/zgrep.1 @@ -1,5 +1,5 @@ .\" $NetBSD: zgrep.1,v 1.1 2003/12/28 17:26:00 wiz Exp $ -.\" $DragonFly: src/usr.bin/gzip/zgrep.1,v 1.1 2004/10/26 11:19:31 joerg Exp $ +.\" $DragonFly: src/usr.bin/gzip/zgrep.1,v 1.2 2006/03/01 08:08:44 swildner Exp $ .\" .\" Copyright (c) 2003 Thomas Klausner. .\" @@ -83,7 +83,7 @@ while .Nm zfgrep calls .Xr fgrep 1 . -.Sh RETURN VALUES +.Sh DIAGNOSTICS In case of missing arguments or missing pattern, 1 will be returned, otherwise 0. .Sh SEE ALSO diff --git a/usr.sbin/faithd/faithd.8 b/usr.sbin/faithd/faithd.8 index 2b0f8ae3b7..8c1892ccff 100644 --- a/usr.sbin/faithd/faithd.8 +++ b/usr.sbin/faithd/faithd.8 @@ -28,7 +28,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD: src/usr.sbin/faithd/faithd.8,v 1.2.2.12 2003/03/12 22:08:14 trhodes Exp $ -.\" $DragonFly: src/usr.sbin/faithd/faithd.8,v 1.3 2006/02/17 19:40:14 swildner Exp $ +.\" $DragonFly: src/usr.sbin/faithd/faithd.8,v 1.4 2006/03/01 08:08:45 swildner Exp $ .\" .Dd May 17, 1998 .Dt FAITHD 8 @@ -281,16 +281,6 @@ the traffic will be denied. With inetd mode, traffic may be filtered by using access control functionality in .Xr inetd 8 . -.Sh RETURN VALUES -The -.Nm -utility exits with -.Dv EXIT_SUCCESS -.Pq 0 -on success, and -.Dv EXIT_FAILURE -.Pq 1 -on error. .Sh EXAMPLES Before invoking .Nm , @@ -381,6 +371,16 @@ setting. 3ffe:501:ffff::/48 deny 127.0.0.0/8 3ffe:501:ffff::/48 permit 0.0.0.0/0 .Ed +.Sh DIAGNOSTICS +The +.Nm +utility exits with +.Dv EXIT_SUCCESS +.Pq 0 +on success, and +.Dv EXIT_FAILURE +.Pq 1 +on error. .Sh SEE ALSO .Xr faith 4 , .Xr route 8 , diff --git a/usr.sbin/gifconfig/gifconfig.8 b/usr.sbin/gifconfig/gifconfig.8 index 911dd34bfb..eef2002ce8 100644 --- a/usr.sbin/gifconfig/gifconfig.8 +++ b/usr.sbin/gifconfig/gifconfig.8 @@ -1,5 +1,5 @@ .\" $FreeBSD: src/usr.sbin/gifconfig/gifconfig.8,v 1.1.2.11 2003/03/11 21:13:49 trhodes Exp $ -.\" $DragonFly: src/usr.sbin/gifconfig/gifconfig.8,v 1.3 2006/02/17 19:40:15 swildner Exp $ +.\" $DragonFly: src/usr.sbin/gifconfig/gifconfig.8,v 1.4 2006/03/01 08:08:45 swildner Exp $ .\" $KAME: gifconfig.8,v 1.6 2000/11/22 11:10:09 itojun Exp $ .\" .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. @@ -105,8 +105,6 @@ command or using the .Va gifconfig_ Ns Aq Ar interface variable in .Xr rc.conf 5 . -.Sh RETURN VALUES -The command exits with exit status of 1 on errors, 0 on success. .Sh EXAMPLES If you would like to configure IPv6 over IPv4 (aka IPv6 in IPv4) @@ -150,6 +148,8 @@ This is also possible to use IPv6 as outer proto, by replacing to .Li inet6 , and IPv4 addresses to some appropriate IPv6 addresses in above example. +.Sh DIAGNOSTICS +The command exits with exit status of 1 on errors, 0 on success. .Sh SEE ALSO .Xr gif 4 , .Xr ifconfig 8 diff --git a/usr.sbin/mld6query/mld6query.8 b/usr.sbin/mld6query/mld6query.8 index d705fcbae6..412ec80ba0 100644 --- a/usr.sbin/mld6query/mld6query.8 +++ b/usr.sbin/mld6query/mld6query.8 @@ -28,7 +28,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD: src/usr.sbin/mld6query/mld6query.8,v 1.1.1.1.2.5 2003/03/11 21:13:51 trhodes Exp $ -.\" $DragonFly: src/usr.sbin/mld6query/mld6query.8,v 1.2 2003/06/17 04:29:57 dillon Exp $ +.\" $DragonFly: src/usr.sbin/mld6query/mld6query.8,v 1.3 2006/03/01 08:08:45 swildner Exp $ .\" .Dd May 17, 1998 .Dt MLD6QUERY 8 @@ -76,7 +76,7 @@ similarly, MLD report packet will be transmitted. .Fl dr options are for debugging purposes only. .\" -.Sh RETURN VALUES +.Sh DIAGNOSTICS The program exits with 0 on success, non-zero on failures. .\" .\" .Sh SEE ALSO diff --git a/usr.sbin/ndp/ndp.8 b/usr.sbin/ndp/ndp.8 index 6a277bbef1..3b1628da4b 100644 --- a/usr.sbin/ndp/ndp.8 +++ b/usr.sbin/ndp/ndp.8 @@ -1,5 +1,5 @@ .\" $FreeBSD: src/usr.sbin/ndp/ndp.8,v 1.1.2.8 2003/08/12 16:27:57 ume Exp $ -.\" $DragonFly: src/usr.sbin/ndp/ndp.8,v 1.3 2004/12/30 02:44:10 hsu Exp $ +.\" $DragonFly: src/usr.sbin/ndp/ndp.8,v 1.4 2006/03/01 08:08:45 swildner Exp $ .\" $KAME: ndp.8,v 1.15 2001/02/08 07:17:03 itojun Exp $ .\" .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. @@ -177,7 +177,7 @@ Most useful when used with .Fl A . .El .\" -.Sh RETURN VALUES +.Sh DIAGNOSTICS The .Nm utility will exit with 0 on success, and non-zero on errors. diff --git a/usr.sbin/rrenumd/rrenumd.8 b/usr.sbin/rrenumd/rrenumd.8 index 13413639f5..d5d09901be 100644 --- a/usr.sbin/rrenumd/rrenumd.8 +++ b/usr.sbin/rrenumd/rrenumd.8 @@ -28,7 +28,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD: src/usr.sbin/rrenumd/rrenumd.8,v 1.2.2.5 2003/03/11 22:31:32 trhodes Exp $ -.\" $DragonFly: src/usr.sbin/rrenumd/rrenumd.8,v 1.2 2003/06/17 04:30:02 dillon Exp $ +.\" $DragonFly: src/usr.sbin/rrenumd/rrenumd.8,v 1.3 2006/03/01 08:08:45 swildner Exp $ .\" .Dd September 7, 1998 .Dt RRENUMD 8 @@ -83,7 +83,7 @@ Configuration information is obtained from standard input. .It Fl c Ar conf_file Specify a configuration file where configuration information is kept. .El -.Sh RETURN VALUES +.Sh DIAGNOSTICS The program exits with 0 on success, and non-zero on failures. .Sh SEE ALSO .Xr rrenumd.conf 5 , diff --git a/usr.sbin/setkey/setkey.8 b/usr.sbin/setkey/setkey.8 index 0f72eea3cc..68bd1059b5 100644 --- a/usr.sbin/setkey/setkey.8 +++ b/usr.sbin/setkey/setkey.8 @@ -1,6 +1,6 @@ .\" $KAME: setkey.8,v 1.49 2001/05/18 05:49:51 sakane Exp $ .\" $FreeBSD: src/usr.sbin/setkey/setkey.8,v 1.4.2.15 2003/03/12 22:08:15 trhodes Exp $ -.\" $DragonFly: src/usr.sbin/setkey/setkey.8,v 1.3 2006/02/17 19:40:26 swildner Exp $ +.\" $DragonFly: src/usr.sbin/setkey/setkey.8,v 1.4 2006/03/01 08:08:45 swildner Exp $ .\" .\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project. .\" All rights reserved. @@ -519,9 +519,6 @@ for detail. .El .Pp .\" -.Sh RETURN VALUES -The command exits with 0 on success, and non-zero on errors. -.\" .Sh ALGORITHMS The following list shows the supported algorithms. .Sy protocol @@ -612,6 +609,9 @@ spdadd 10.0.11.41/32[21] 10.0.11.33/32[any] any .Ed .\" +.Sh DIAGNOSTICS +The command exits with 0 on success, and non-zero on errors. +.\" .Sh SEE ALSO .Xr ipsec_set_policy 3 , .Xr racoon 8 , diff --git a/usr.sbin/traceroute6/traceroute6.8 b/usr.sbin/traceroute6/traceroute6.8 index c6a7da724e..727082b8b3 100644 --- a/usr.sbin/traceroute6/traceroute6.8 +++ b/usr.sbin/traceroute6/traceroute6.8 @@ -28,7 +28,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD: src/usr.sbin/traceroute6/traceroute6.8,v 1.1.2.8 2003/03/11 22:31:34 trhodes Exp $ -.\" $DragonFly: src/usr.sbin/traceroute6/traceroute6.8,v 1.2 2003/06/17 04:30:03 dillon Exp $ +.\" $DragonFly: src/usr.sbin/traceroute6/traceroute6.8,v 1.3 2006/03/01 08:08:45 swildner Exp $ .\" .Dd May 17, 1998 .Dt TRACEROUTE6 8 @@ -108,7 +108,7 @@ Be verbose. Specify the delay time between probes. .El .\" -.Sh RETURN VALUES +.Sh DIAGNOSTICS The .Nm utility will exit with 0 on success, and non-zero on errors. -- 2.41.0