From 9e8c6015072c36e1a7594337c4e80adb0312dcab Mon Sep 17 00:00:00 2001 From: Joachim Wiberg Date: Mon, 14 Nov 2022 07:28:59 +0100 Subject: [PATCH] man: rewrite status command description Signed-off-by: Joachim Wiberg --- man/initctl.8 | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/man/initctl.8 b/man/initctl.8 index 41feabb5..f7cbaaa9 100644 --- a/man/initctl.8 +++ b/man/initctl.8 @@ -203,24 +203,24 @@ Restart (stop/start) service by name Show service status, by name. If only .Cm NAME is given and multiple instances exits, a summary of all matching -instances are shown. Only an exact match displays the detailed status -for a particular instance +instances are shown. Only an exact match displays detailed status +for a given instance. .Pp -When the +With the .Fl q -option is used with this command, and the selection only matches one -run/task/service, nothing is output and the return code of +option this command is silent, provided the +.Ar NAME[:ID] +selection matches a single run/task/service. The exit code of .Nm is non-zero if there is a problem. Zero is returned if a run/task has -run (at least) once in the current runlevel, and also when a service -is running (as expected). For more detailed status, see the +run (at least) once in the current runlevel, and when a service is running +(as expected). See the .Fl j -option for detailed JSON output. +option for detailed JSON output suitable for machine parsing. .Pp .Sy Tip: -the .Xr jq 1 -is a very useful tool in combination with the JSON output. +is a useful scripting tool in combination with JSON output. .It Nm Ar status Show status of all services, default command. Also supports the .Fl j