From: Jan Engelhardt Date: Wed, 25 Dec 2024 11:30:47 +0000 (+0100) Subject: man: grammar fixes for varlinkctl(1) X-Git-Tag: v258-rc1~1773^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=84d3266de142566b551fa38b346c793a1bc88b5a;p=thirdparty%2Fsystemd.git man: grammar fixes for varlinkctl(1) Fix some missing commas, missing conjunction words, wrong inflections, and trim excess parenthesizing. --- diff --git a/man/varlinkctl.xml b/man/varlinkctl.xml index eb23e5099d1..41d911c5115 100644 --- a/man/varlinkctl.xml +++ b/man/varlinkctl.xml @@ -90,7 +90,7 @@ A Varlink service reference starting with the ssh-unix: string, followed by an SSH host specification, followed by :, followed by an absolute AF_UNIX socket path. (This requires OpenSSH 9.4 or newer on the server side, - abstract namespace sockets are not supported.) + and abstract namespace sockets are not supported.) A Varlink service reference starting with the ssh-exec: string, followed by an SSH host specification, followed by :, followed by a command line. In @@ -119,7 +119,7 @@ info ADDRESS - Show brief information about the specified service, including vendor name and list of + Shows brief information about the specified service, including vendor name and list of implemented interfaces. Expects a service address in one of the formats described above. @@ -128,7 +128,7 @@ list-interfaces ADDRESS - Show list of interfaces implemented by the specified service. Expects a service + Shows a list of interfaces implemented by the specified service. Expects a service address in one of the formats described above. @@ -137,7 +137,7 @@ list-methods ADDRESS [INTERFACE…] - Show list of methods implemented by the specified service. Expects a service address + Shows a list of methods implemented by the specified service. Expects a service address in one of the formats described above as well as one or more interface names. If no interface name is specified, lists all methods of all interfaces implemented by the service, otherwise just the methods in the specified interfaces. @@ -148,7 +148,7 @@ introspect ADDRESS [INTERFACE…] - Show the interface definitions of the specified interfaces provided by the specified + Shows the interface definitions of the specified interfaces provided by the specified service. Expects a service address in one of the formats described above and optionally one or more Varlink interface names. If no interface names are specified, shows all provided interfaces by the service. @@ -159,12 +159,12 @@ call ADDRESS METHOD [ARGUMENTS] - Call the specified method of the specified service. Expects a service address in the + Calls the specified method of the specified service. Expects a service address in the format described above, a fully qualified Varlink method name, and a JSON arguments object. If the arguments object is not specified, it is read from STDIN instead. To pass an empty list of parameters, specify the empty object {}. - The reply parameters are written as JSON object to STDOUT. + The reply parameters are written as JSON objects to STDOUT. @@ -183,7 +183,7 @@ help - Show command syntax help. + Shows command syntax help. @@ -200,20 +200,20 @@ When used with call: expect multiple method replies. If this flag - is set the method call is sent with the more flag set, which tells the service + is set, the method call is sent with the more flag set, which tells the service to generate multiple replies, if needed. The command remains running until the service sends a reply message that indicates it is the last in the series (or if the configured timeout is reached, see below). This flag should be set only for method calls that support this mechanism. - If this mode is enabled output is automatically switched to JSON-SEQ mode, so that individual + If this mode is enabled, output is automatically switched to JSON-SEQ mode, so that individual reply objects can be easily discerned. - This switch has no effect on the method call timeout applied by default: regardless of + This switch has no effect on the method call timeout applied by default. Regardless of whether is specified or not, the default timeout will be 45s. Use (see below) to change or disable the timeout. When invoking a method - call that continuously returns updates it is typically desirable to disable the timeout with + call that continuously returns updates, it is typically desirable to disable the timeout with . On the other hand, when invoking a - method call for the purpose of enumerating objects (which likely will complete quickly) it is + method call for the purpose of enumerating objects (which likely will complete quickly), it is typically beneficial to leave the timeout logic enabled, for robustness reasons. @@ -231,8 +231,8 @@ - This is similar to but collects all responses in a JSON - array, and prints it, rather than in JSON_SEQ mode. + This is similar to , but collects all responses in a JSON + array, and prints it, rather than in JSON-SEQ mode. @@ -241,7 +241,7 @@ When used with call: do not expect a method reply. If this flag - is set the method call is sent with the oneway flag set (the command exits + is set, the method call is sent with the oneway flag set (the command exits immediately after), which tells the service not to generate a reply. @@ -251,9 +251,9 @@ - Selects the JSON output formatting, one of pretty (for nicely indented, - colorized output) or short (for terse output with minimal whitespace and no - newlines), defaults to short. + Selects the JSON output formatting, either pretty for nicely indented, + colorized output, or short for terse output with minimal whitespace and no + newlines. Defaults to short. @@ -263,8 +263,8 @@ - Equivalent to when invoked interactively from a terminal. Otherwise - equivalent to , in particular when the output is piped to some other + Equivalent to when invoked interactively from a terminal. Otherwise, + it is equivalent to , in particular when the output is piped to some other program. @@ -286,9 +286,9 @@ - Takes a qualified Varlink error name (i.e. an interface name, suffixed by an error name, - separated by a dot; e.g. org.varlink.service.InvalidParameter). Ensures that if - a method call fails with the specified error this will be treated as success, i.e. will cause the + Takes a qualified Varlink error name, i.e. an interface name, suffixed by an error name, + separated by a dot, e.g. org.varlink.service.InvalidParameter. Ensures that, if + a method call fails with the specified error, this will be treated as success, i.e. will cause the varlinkctl invocation to exit with a zero exit status. This option may be used more than once in order to treat multiple different errors as successes. @@ -301,7 +301,7 @@ Expects a timeout in seconds as parameter. By default, a timeout of 45s is enforced. To turn - off the timeout specify infinity or an empty string. + off the timeout, specify infinity or an empty string.