From 119644093f79b22d43d023ae5f147740aaebce82 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Fri, 13 Jan 2023 15:46:20 +0000 Subject: Doc clarification Signed-off-by: Laurent Bercot --- doc/s6-svc.html | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/s6-svc.html b/doc/s6-svc.html index 4668a45..24b139d 100644 --- a/doc/s6-svc.html +++ b/doc/s6-svc.html @@ -60,12 +60,15 @@ receive the signal aimed to kill them) and do not restart it. The SIGTERM default can be changed by editing the ./down-signal file in the service directory.
  • -D : down, and create a ./down file so the -service does not restart automatically if the supervisor dies.
    • +service does not restart automatically if the supervisor dies. This +option is mostly used by automated systems working on top of s6; as a +human user, you probably don't need it.
  • -u : up. If the supervised process is down, start it. Automatically restart it when it dies.
  • -U : up, and remove any ./down file that may exist, in order to make sure the service is automatically restarted even -if the supervisor dies.
    • +if the supervisor dies. This option is mostly used by automated systems +working on top of s6; as a human user, you probably don't need it.
  • -x : exit. When the service is asked to be down and the supervised process dies, s6-supervise will exit too. This command should normally never be used on a working system. Note that if this command is @@ -171,6 +174,15 @@ they do nothing, and in particular they do not instruct s6-supervise to bring th service up. Consequently, s6-svc -rwr servicedir may wait forever for the service to be up, if it is currently wanted down. To avoid that, make sure your service is wanted up by using s6-svc -ruwr servicedir instead.
    • +
  • The U and D letters, which convey the same idea as u +and d (up and down) but with added emphasis, do not have the +same meaning in the -U/-D and -wU/-wD options. +In the -U/-D case, they mean "change the external service configuration +to match what the supervisor has been instructed that the starting state of the service +should be". In the -wU/-wD case, they mean "wait until the service +has reached the wanted state and also is ready" (or "ready to be started again" +for -wD). The thing to remember is "it's up/down, with something more", but +the "something" isn't the same.
    • -- cgit v1.2.3