Fix typos in man pages

2026-09-21 08:33:23 +00:00 · 2026-07-02 21:14:26 +02:00
parent 77f2094ff5
commit cfc26f1e60
24 changed files with 60 additions and 60 deletions
@@ -42,7 +42,7 @@ commands.
 * `show` **ELEMENT**, `cat` **ELEMENT**:
  Display the result of reading a specific element (by full or relative path)
 * `unset` **ELEMENT** **ATTRIBUTE**
-  For an element with attributes, request to clear the value of the attribue
+  For an element with attributes, request to clear the value of the attribute
 * `set` **ELEMENT** **ATTRIBUTE**=**VALUE**
  Set the specified attribute to the given value
 * `start` **ELEMENT**
@@ -10,7 +10,7 @@ confluentdbutil(8) -- Backup or restore confluent database
 **confluentdbutil** is a utility to export/import the confluent attributes
 to/from json files.  The path is a directory that holds the json version.
 In order to perform restore, the confluent service must not be running.  It
-is required to indicate how to treat the usernames/passwords are treated in
+is required to indicate how the usernames/passwords are treated in
 the json files (password protected, removed from the files, or unprotected).

 ## OPTIONS
@@ -24,7 +24,7 @@ the json files (password protected, removed from the files, or unprotected).
  
 * `-r`, `--redact`:
  Indicates to replace usernames and passwords with a dummy string rather
-  than included.
+  than including them.
  
 * `-u`, `--unprotected`:
  The keys.json file will include the encryption keys without any protection.
@@ -35,10 +35,10 @@ the json files (password protected, removed from the files, or unprotected).
  suitable for an automated incremental backup, where an
  earlier password protected dump has a protected
  keys.json file, and only the protected data is needed.
-  keys do not change and as such they do not require
+  Keys do not change and as such they do not require
  incremental backup.
-  
-* `-y`, `--yaml
+
+* `-y`, `--yaml`:
  Use YAML instead of JSON as file format
  
  * `-h`, `--help`:
@@ -9,7 +9,7 @@ nodeapply(8) -- Execute command on many nodes in a noderange through ssh

 Provides shortcut access to a number of common operations against deployed
 nodes.  These operations include refreshing ssh certificates and configuration,
-rerunning syncflies, and executing specified postscripts.
+rerunning syncfiles, and executing specified postscripts.

 ## OPTIONS
  
@@ -42,7 +42,7 @@ For the `groups` attribute, it is possible to add a group by doing
 `groups,=<newgroup>` and to remove by doing `groups^=<oldgroup>`

 Note that `nodeattrib <group>` will likely not provide the expected behavior.
-See nodegroupattrib(8) command on how to manage attributes on a group level.  Running
+See the nodegroupattrib(8) command for how to manage attributes on a group level.  Running
 nodeattrib on a group will simply set node-specific attributes on each individual
 member of the group.

@@ -68,8 +68,8 @@ to a blank value will allow masking a group defined attribute with an empty valu
  or environment variables.

 * `-s`, `--set`:
-  Set attributes using a batch file rather than the command line. The attributes in the batch file 
-  can be specified as one line of key=value pairs simmilar to command line or each attribute can
+  Set attributes using a batch file rather than the command line. The attributes in the batch file
+  can be specified as one line of key=value pairs similar to command line or each attribute can
  be in its own line. Lines that start with # sign will be read as a comment. See EXAMPLES for batch
  file syntax.   
 
@@ -44,7 +44,7 @@ It is sometimes the case that the number must be formatted a different way,
 either specifying 0 padding or converting to hexadecimal. This can be done by a
 number of operators at the end to indicate formatting changes.

-`{n1:02x} - Zero pad to two decimal places, and convert to hexadecimal, as mightbe used for generating MAC addresses`  
+`{n1:02x} - Zero pad to two decimal places, and convert to hexadecimal, as might be used for generating MAC addresses`
 `{n1:x} - Hexadecimal without padding, as may be used in a generated IPv6 address`  
 `{n1:X} - Uppercase hexadecimal`  
 `{n1:02d} - Zero pad a normal numeric representation of the number.`  
@@ -20,9 +20,9 @@ nodebmcpassword(8) -- Change management controller password for a specified user

 ## EXAMPLES:

-* Reset the management controller for nodes n1 through n4:
-  `# nodebmcreset n1-n4`  
-  `n1: Password Change Successful`  
-  `n2: Password Change Successful`  
-  `n3: Password Change Successful`  
-  `n4: Password Change Successful`  
+* Change the management controller password for user USERID on nodes n1 through n4:
+  `# nodebmcpassword n1-n4 USERID newp4ssw0rd`
+  `n1: Password Change Successful`
+  `n2: Password Change Successful`
+  `n3: Password Change Successful`
+  `n4: Password Change Successful`
@@ -68,7 +68,7 @@ actually be in effect until a reboot.
    `s4: bmc.ipv4_method: DHCP`  
    `s4: bmc.ipv4_gateway: 172.30.0.6`  

-* Changing nodes `s3` and `s4` to have the ip addressess 10.1.2.3 and 10.1.2.4 with a 16 bit subnet mask:
+* Changing nodes `s3` and `s4` to have the IP addresses 10.1.2.3 and 10.1.2.4 with a 16 bit subnet mask:
    `# nodeconfig s3,s4 bmc.ipv4_address=10.1.2.{n1}/16`  

 ## SEE ALSO
@@ -37,7 +37,7 @@ console process which will result in the console window closing.
  manager at this time.

  * `-T`, `--Timestamp`:
- Dump the log with Timpstamps on the current, local log in /var/log/confluent/consoles.
+ Dump the log with Timestamps on the current, local log in /var/log/confluent/consoles.
  If in collective mode, this only makes sense to use on the current collective
  manager at this time.

@@ -65,9 +65,9 @@ console process which will result in the console window closing.
  environment, to open a set of consoles for a range of
  nodes in separate Windows Terminal windows, with the
  title set for each node, set **NODECONSOLE_WINDOWED_COMMAND**
-  to `wt.exe wsl.exe -d AlmaLinux-8 --shell-type login.  If the
+  to `wt.exe wsl.exe -d AlmaLinux-8 --shell-type login`.  If the
  NODECONSOLE_WINDOWED_COMMAND environment variable isn't set,
-  xterm will be used bydefault.
+  xterm will be used by default.

 ## ESCAPE SEQUENCE COMMANDS

@@ -102,7 +102,7 @@ keystroke will be interpreted as a command.  The following commands are availabl
  Request immediate boot to network
 * `r`:
  [send Resize]
-  This queries the current terminal and sends stty commands to advertise the user termineal
+  This queries the current terminal and sends stty commands to advertise the user terminal
  size to the remote console
 * `?`:
  Get a list of supported commands
@@ -112,10 +112,10 @@ keystroke will be interpreted as a command.  The following commands are availabl

 ## PASSTHROUGH OPTIONS

-While opening a windowed console with xterm or any other console of choice. The 
-nodeconsole command gives capality to specify passthrough options targeted at 
-the console. All options after the -- will be parsed the console program. For 
-example, opening a windowed console using xterm with a black background. 
-`nodeconconsole -w n1 -- -bg black`  
+While opening a windowed console with xterm or any other console of choice. The
+nodeconsole command gives capability to specify passthrough options targeted at
+the console. All options after the -- will be passed to the console program. For
+example, opening a windowed console using xterm with a black background.
+`nodeconsole -w n1 -- -bg black`


@@ -3,7 +3,7 @@ nodedefine(8) -- Define new confluent nodes

 ## SYNOPSIS

-`nodedefine <noderange> [nodeattribute1=value1> <nodeattribute2=value2> ...]`  
+`nodedefine <noderange> [<nodeattribute1=value1> <nodeattribute2=value2> ...]`

 ## DESCRIPTION

@@ -26,4 +26,4 @@ that `nodeattrib(8)` will error if a node does not exist.

 ## SEE ALSO

-noderange(5), nodeattribexpressions(8)
+noderange(5), nodeattribexpressions(5)
@@ -27,14 +27,14 @@ deployment status.
  Prepare the network services for deployment, but do not interact with BMCs. This is intended for scenarios where
  the boot device control and server restart will be handled outside of confluent.
  
-* `-m MAXNODES`, `--maxnodes=MAXNODES`: 
-  Specifiy a maximum nodes to be deployed.
+* `-m MAXNODES`, `--maxnodes=MAXNODES`:
+  Specify a maximum number of nodes to be deployed.
  
 * `-h`, `--help`:
  Show help message and exit  

 ## EXAMPLES
-* Begin the instalalation of a profile of CentOS 8.2:  
+* Begin the installation of a profile of CentOS 8.2:
   `# nodedeploy d4 -n centos-8.2-x86_64-default`  
   `d4: network`  
   `d4: reset`  
@@ -35,8 +35,8 @@ devices.  Generally every effort is made to passively detect devices as they
 become available (as they boot or are plugged in), however sometimes an active
 scan is the best approach to catch something that appears to be missing.

-**nodedsicover clear** requests the server forget about a selection of
-detected device.  It takes the same arguments as **nodediscover list**.
+**nodediscover clear** requests the server to forget about a selection of
+detected devices.  It takes the same arguments as **nodediscover list**.

 **nodediscover subscribe** and **unsubscribe** instructs confluent to subscribe to or
 unsubscribe from the designated switch running affluent with system discovery support.
@@ -20,9 +20,9 @@ noderange.
    return the last <n> entries for each node in the eventlog. 

 * `-t TIMEFRAME`, `--timeframe=TIMEFRAME`:
-   return entries within a specified timeframe for each node's event log. 
-   This will return entries from the last <n> hours or days. 1h would be 
-   entries from with the last one hour. 
+   return entries within a specified timeframe for each node's event log.
+   This will return entries from the last <n> hours or days. 1h would be
+   entries from within the last one hour.
                           
  
 * `-h`, `--help`:
@@ -36,8 +36,8 @@ the out of band facilities.  Firmware updates can end in one of three states:
  When updating, prompt if more than the specified number of servers will 
  be affected  

-* `-p PARAMETERFILE`, `--paramaterfile=PARAMETERFILE`:
-  For updating, a parameter file to provife along with the update payload
+* `-p PARAMETERFILE`, `--parameterfile=PARAMETERFILE`:
+  For updating, a parameter file to provide along with the update payload

 * `-h`, `--help`:
  Show help message and exit    
@@ -3,7 +3,7 @@ nodegroupdefine(8) -- Define new confluent node group

 ## SYNOPSIS

-`nodegroupdefine <groupname> [nodeattribute1=value1> <nodeattribute2=value2> ...]`  
+`nodegroupdefine <groupname> [<nodeattribute1=value1> <nodeattribute2=value2> ...]`

 ## DESCRIPTION

@@ -21,4 +21,4 @@ that `nodegroupattrib(8)` will error if a node group does not exist.

 ## SEE ALSO

-nodeattribexpressions(8), nodegroupattrib(8), nodegroupremove(8)
+nodeattribexpressions(5), nodegroupattrib(8), nodegroupremove(8)
@@ -3,11 +3,11 @@ nodeidentify(8) -- Control the identify LED of confluent nodes

 ## SYNOPSIS

-`nodidentify <noderange> [on|off|blink]`  
+`nodeidentify <noderange> [on|off|blink]`

 ## DESCRIPTION

-`nodeidentify` allows you to turn on or off the location LED of conflueunt nodes,
+`nodeidentify` allows you to turn on or off the location LED of confluent nodes,
 making it easier to determine the physical location of the nodes.  The following
 options are supported:

@@ -24,7 +24,7 @@ options are supported:
  `n3: on`  
  `n4: on`  

-* Turn off the identify LED on nodes n1 thorugh n4:
+* Turn off the identify LED on nodes n1 through n4:
  `# nodeidentify n1-n4 off`  
  `n1: off`  
  `n2: off`  
@@ -9,7 +9,7 @@ nodeinventory(8) -- Get hardware inventory of confluent node

 `nodeinventory` pulls information about hardware of a node.  This includes 
 information such as adapters, serial numbers, processors, and memory modules,
-as supported by the platforms hardware management implementation.  It accepts
+as supported by the platform's hardware management implementation.  It accepts
 arguments such as serial or model or others as listed above to filter
 output to specific data.

@@ -1,10 +1,10 @@
-nodel2traceroute(8) -- returns the layer 2 route through an Ethernet network managed by confluent given 2 end points.
+nodel2traceroute(8) -- Returns the layer 2 route through an Ethernet network managed by confluent given 2 end points.
 ==============================
 ## SYNOPSIS
 `nodel2traceroute [options] <start_node> <end_noderange>`  

 ## DESCRIPTION  
-**nodel2traceroute** is a command that returns the layer 2 route for the configered interfaces in nodeattrib.
+**nodel2traceroute** is a command that returns the layer 2 route for the configured interfaces in nodeattrib.
 It can also be used with the -i and -e options to check against specific interfaces on the endpoints. If the 
 --interface or --eface option are not used then the command will check for routes against all the defined 
 interfaces in nodeattrib (net.*.switch) for the nodes.
@@ -17,7 +17,7 @@ interfaces in nodeattrib (net.*.switch) for the nodes.

 ## OPTIONS
 * ` -e` EFACE, --eface=INTERFACE
-   interface to check against for the second end point or end points if using checking against multiple nodes 
+   interface to check against for the second end point or end points if checking against multiple nodes
 * ` -i` INTERFACE, --interface=INTERFACE
   interface to check against for the first end point  
 * ` -c` CUMULUS, --cumulus=CUMULUS
@@ -8,7 +8,7 @@ nodelicense(8) -- Manage license keys on BMC
 ## DESCRIPTION

 `nodelicense` manages license keys on supported BMCs. Without an argument, the command
-lists currently installed license.  Using `delete` will remove the specified license name
+lists currently installed licenses.  Using `delete` will remove the specified license name
 from the BMC.  The `save` subcommand will take the passed directory (which may be in the form
 of /path/to/{node}/ to have the node name substituted for each node) and back up installed licenses
 to that directory. The `install` command will take the specified filename and install.  The filename
@@ -15,7 +15,7 @@ matching nodes, one line at a time.
 If a list of node attribute names are given, the value of those are also
 displayed.  If `-b` is specified, it will also display information on
 how inherited and expression based attributes are defined.  There is more
-information on node attributes in nodeattributes(5) man page.
+information on node attributes in the nodeattrib(8) man page.

 Attributes may be specified by wildcard, for example `net.*switch` will report
 all attributes that begin with `net.` and end with `switch`.
@@ -25,7 +25,7 @@ all attributes that begin with `net.` and end with `switch`.
 * `-b`, `--blame`:
  Annotate inherited and expression based attributes to show their base value.
 * `-d`, `--delim`:
-  Choose a delimiter to separat the values. Default - ENTER.
+  Choose a delimiter to separate the values. Default - ENTER.
 ## EXAMPLES
 * Listing matching nodes of a simple noderange:
  `# nodelist n1-n4`  
@@ -40,7 +40,7 @@ all attributes that begin with `net.` and end with `switch`.
  `n2: hardwaremanagement.manager: 172.30.3.2`  

 * Getting a group of attributes while determining what group defines them:
-  `# nodelist n1,n2 hardwaremanegement --blame`  
+  `# nodelist n1,n2 hardwaremanagement --blame`
  `n1: hardwaremanagement.manager: 172.30.3.1`  
  `n1: hardwaremanagement.method: ipmi (inherited from group everything)`  
  `n1: hardwaremanagement.switch: r8e1`  
@@ -14,8 +14,8 @@ It can also be used with the `-s` flag to change the ping location to something
 * `-h`, `--help`:  
  Show help message and exit      
 * `-s` SUBSTITUTENAME, --substitutename=SUBSTITUTENAME  
-  Use a different name other than the nodename for ping. This may be a 
-  expression, such as {bmc} or, if no { character is present, it is treated as a suffix.  -s -eth1 would make n1 become n1-eth1, for example. 
+  Use a different name other than the nodename for ping. This may be an
+  expression, such as {bmc} or, if no { character is present, it is treated as a suffix.  -s -eth1 would make n1 become n1-eth1, for example.

   
 ## EXAMPLES
@@ -24,7 +24,7 @@ interval of 1 second is used.
  the results, which may have a different ordering than non-CSV usage of nodesensors.

 * `-i`, `--interval`=**SECONDS**:
-  Repeat data gathering waiting, waiting the specified time between samples.  Unless `-n` is
+  Repeat data gathering, waiting the specified time between samples.  Unless `-n` is
  specified, indefinite retrieval is assumed.

 * `-n`, `--numreadings`=**SAMPLES**:
@@ -10,7 +10,7 @@ nodesetboot(8) -- Check or set next boot device for noderange
 Requests that the next boot occur from the specified device.  Unless otherwise
 specified, this is a one time boot option, and does not change the normal boot
 behavior of the system.  This is useful for taking a system that normally boots
-to the hard drive and startking a network install, or to go into the firmware
+to the hard drive and starting a network install, or to go into the firmware
 setup menu without having to hit a keystroke at the correct time on the console.

 Generally, it's a bit more convenient and direct to use the nodeboot(8) command,
@@ -30,7 +30,7 @@ as stderr, unlike psh which combines all stdout and stderr into stdout.
 * `-p PORT`, `--port=PORT`
  Specify a custom port for ssh

-* `-s SUBSTITUTION`, `--substitutename=SUBSTITITUTION`
+* `-s SUBSTITUTION`, `--substitutename=SUBSTITUTION`
  Specify a substitution name instead of the nodename.  If no {} are in the substitution,
  it is considered to be an append.  For example, '-s -ib' would produce 'node1-ib' from 'node1'.
  Full expression syntax is supported, in which case the substitution is considered to be the entire
@@ -3,7 +3,7 @@ stats(8) -- Common basic statistics on typical numeric data in output

 ## SYNOPSIS

-`<other command> | stats [-c N] [-d D] [-x|-g|-t|-o image.png] [-s N] [-v] [-b N]
+`<other command> | stats [-c N] [-d D] [-x|-g|-t|-o image.png] [-s N] [-v] [-b N]`

 ## DESCRIPTION

@@ -11,11 +11,11 @@ The **stats** command helps analyze common numerical data such as performance nu
 or temperatures or any other numerical value.

 By default it looks for the last numerical output on the first line to identify the numerical column
-and analyze that number. This can be overriden by **-c COLUMN** to indicate a column. By default,
+and analyze that number. This can be overridden by **-c COLUMN** to indicate a column. By default,
 whitespace and commas are treated to delimit columns, and **-d DELIMITER** can be used to override.

 By default it outputs basic statistics, but a histogram is available either text or through X11 output
-or sixel or output to an image file depending on whether **-x**, **-g**, **-t*, or **-o image.png** is
+or sixel or output to an image file depending on whether **-x**, **-g**, **-t**, or **-o image.png** is
 used.

 ## OPTIONS