NetBSD Problem Report #58825

From paul@whooppee.com  Mon Nov 11 11:55:01 2024
Return-Path: <paul@whooppee.com>
Received: from mail.netbsd.org (mail.netbsd.org [199.233.217.200])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
	 key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256
	 client-signature RSA-PSS (2048 bits) client-digest SHA256)
	(Client CN "mail.NetBSD.org", Issuer "mail.NetBSD.org CA" (not verified))
	by mollari.NetBSD.org (Postfix) with ESMTPS id 5BE531A9238
	for <gnats-bugs@gnats.NetBSD.org>; Mon, 11 Nov 2024 11:55:01 +0000 (UTC)
Message-Id: <20241111115420.952FC5E33C5@speedy.whooppee.com>
Date: Mon, 11 Nov 2024 03:54:20 -0800 (PST)
From: paul@whooppee.com
Reply-To: paul@whooppee.com
To: gnats-bugs@NetBSD.org
Subject: service(8) man page doesn't describe possible actions
X-Send-Pr-Version: 3.95

>Number:         58825
>Category:       bin
>Synopsis:       service(8) man page doesn't describe possible actions
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bin-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Mon Nov 11 12:00:01 +0000 2024
>Originator:     Paul Goyette
>Release:        NetBSD 10.99.12
>Organization:
+---------------------+--------------------------+----------------------+
| Paul Goyette (.sig) | PGP Key fingerprint:     | E-mail addresses:    |
| (Retired)           | 1B11 1849 721C 56C8 F63A | paul@whooppee.com    |
| Software Developer  | 6E2E 05FD 15CE 9F2D 5102 | pgoyette@netbsd.org  |
| & Network Engineer  |                          | pgoyette99@gmail.com |
+---------------------+--------------------------+----------------------+
>Environment:


System: NetBSD speedy.whooppee.com 10.99.12 NetBSD 10.99.12 (SPEEDY 2024-09-29 10:16:33 UTC) #0: Sun Sep 29 12:40:54 UTC 2024 paul@speedy.whooppee.com:/build/netbsd-local/obj/amd64/sys/arch/amd64/compile/SPEEDY amd64
Architecture: x86_64
Machine: amd64
>Description:
The man page for service(8) shows usage/synopsis for

		service [-v] rc_script_name action

But there is no further detail for what actions might be available.
When service program is invoked with an invalid value for action,
the usage() error message shows a list of common actions:

	#  service ntpd help
	/etc/rc.d/ntpd: unknown directive 'help'.
	Usage: /etc/rc.d/ntpd [fast|force|one](start stop restart rcvar status poll)
	#


>How-To-Repeat:

>Fix:

Include additional text for both the man page and the program's usage():

	...
	 service [-v] rc_script_name action
		Run rc_script_name to perform the action specified.  Possible
		actions may include 
		    [fast|force|one](start stop restart rcvar status poll)
	...

>Unformatted:

NetBSD Home
NetBSD PR Database Search

(Contact us) $NetBSD: query-full-pr,v 1.47 2022/09/11 19:34:41 kim Exp $
$NetBSD: gnats_config.sh,v 1.9 2014/08/02 14:16:04 spz Exp $
Copyright © 1994-2024 The NetBSD Foundation, Inc. ALL RIGHTS RESERVED.