man: rewrite status command description

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
This commit is contained in:
Joachim Wiberg committed 2022-11-14 07:28:59 +01:00
1 parent b26104466a
commit 9e8c601507
1 file changed
+10 -10
+10 -10
View File
@@ -203,24 +203,24 @@ Restart (stop/start) service by name
Show service status, by name. If only Show service status, by name. If only
.Cm NAME .Cm NAME
is given and multiple instances exits, a summary of all matching is given and multiple instances exits, a summary of all matching
instances are shown. Only an exact match displays the detailed status instances are shown. Only an exact match displays detailed status
for a particular instance for a given instance.
.Pp .Pp
When the With the
.Fl q .Fl q
option is used with this command, and the selection only matches one option this command is silent, provided the
run/task/service, nothing is output and the return code of .Ar NAME[:ID]
selection matches a single run/task/service. The exit code of
.Nm .Nm
is non-zero if there is a problem. Zero is returned if a run/task has 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 run (at least) once in the current runlevel, and when a service is running
is running (as expected). For more detailed status, see the (as expected). See the
.Fl j .Fl j
option for detailed JSON output. option for detailed JSON output suitable for machine parsing.
.Pp .Pp
.Sy Tip: .Sy Tip:
the
.Xr jq 1 .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 .It Nm Ar status
Show status of all services, default command. Also supports the Show status of all services, default command. Also supports the
.Fl j .Fl j