[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[shepherd] 31/32: doc: Clarify which instance 'herd' talks to.
From: |
Ludovic Courtès |
Subject: |
[shepherd] 31/32: doc: Clarify which instance 'herd' talks to. |
Date: |
Wed, 30 Mar 2022 11:01:35 -0400 (EDT) |
civodul pushed a commit to branch master
in repository shepherd.
commit 09e1b6b8869527bc0650331049edf77caa5a5d66
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Wed Mar 30 14:11:09 2022 +0200
doc: Clarify which instance 'herd' talks to.
* doc/shepherd.texi (Invoking herd): Clarify which instance 'herd' talks to.
---
doc/shepherd.texi | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/doc/shepherd.texi b/doc/shepherd.texi
index 4867ceb..849909f 100644
--- a/doc/shepherd.texi
+++ b/doc/shepherd.texi
@@ -474,8 +474,25 @@ Synonym for @code{--silent}.
@cindex herd
The @command{herd} command is a generic client program to control a
-running instance of @command{shepherd} (@pxref{Invoking shepherd}). It has the
-following synopsis:
+running instance of @command{shepherd} (@pxref{Invoking shepherd}).
+When running as root, it communicates with the @dfn{system
+instance}---the process with PID@tie{}1; when running as a normal user,
+it communicates with the @dfn{user's instance}, which is a regular,
+unprivileged process managing the user's own services. For example, the
+following command displays the status of all the @dfn{system services}:
+
+@example
+sudo herd status
+@end example
+
+Conversely, the command below displays the status of @dfn{user
+services}, assuming a user @command{shepherd} is running:
+
+@example
+herd status
+@end example
+
+The command has the following synopsis:
@example
herd [@var{option}@dots{}] @var{action} [@var{service} [@var{arg}@dots{}]]
- [shepherd] 02/32: README: Mention copyright year ranges., (continued)
- [shepherd] 02/32: README: Mention copyright year ranges., Ludovic Courtès, 2022/03/30
- [shepherd] 03/32: Remove 'QUESTIONS' file., Ludovic Courtès, 2022/03/30
- [shepherd] 07/32: Use Fibers., Ludovic Courtès, 2022/03/30
- [shepherd] 13/32: shepherd: Encode log as UTF-8 unconditionally., Ludovic Courtès, 2022/03/30
- [shepherd] 14/32: service: 'make-forkexec-constructor' spawns a logging fiber., Ludovic Courtès, 2022/03/30
- [shepherd] 08/32: README: Update requirements., Ludovic Courtès, 2022/03/30
- [shepherd] 21/32: service: Add systemd constructor and destructor., Ludovic Courtès, 2022/03/30
- [shepherd] 22/32: service: Add 'start-in-the-background'., Ludovic Courtès, 2022/03/30
- [shepherd] 25/32: service: Add #:handle-termination slot., Ludovic Courtès, 2022/03/30
- [shepherd] 28/32: shepherd: Do not change to the client directory when executing a command., Ludovic Courtès, 2022/03/30
- [shepherd] 31/32: doc: Clarify which instance 'herd' talks to.,
Ludovic Courtès <=
- [shepherd] 09/32: build: Capture the source and object directories of Fibers., Ludovic Courtès, 2022/03/30
- [shepherd] 11/32: service: 'read-pid-file' no longer blocks., Ludovic Courtès, 2022/03/30
- [shepherd] 10/32: shepherd: Use one fiber for signal handling, and one for clients., Ludovic Courtès, 2022/03/30
- [shepherd] 15/32: doc: Fix inetutils cross-reference., Ludovic Courtès, 2022/03/30
- [shepherd] 12/32: service: 'read-pid-file' uses (@ (guile) sleep) when it's not suspendable., Ludovic Courtès, 2022/03/30
- [shepherd] 18/32: service: Add the #:transient? slot., Ludovic Courtès, 2022/03/30
- [shepherd] 17/32: service: Remove unused 'make-init.d-service'., Ludovic Courtès, 2022/03/30
- [shepherd] 24/32: shepherd: "shepherd -s -" replies to the current output port., Ludovic Courtès, 2022/03/30
- [shepherd] 26/32: service: Add #:max-connections to 'make-inetd-constructor'., Ludovic Courtès, 2022/03/30
- [shepherd] 16/32: support: 'l10n' accepts plural forms., Ludovic Courtès, 2022/03/30