DOCS FOR COMMONLY USED nmstatectl SUBCOMMANDS

Added docs for a and s, providing shortcuts for apply and show respectively for simplified command invocation. Resolves: #2579 Signed-off-by: jona42-ui <[email protected]>
nmstate · Apr 16, 2024 · 2807c45 · 2807c45
1 parent 115bcc5
commit 2807c45
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/nmstatectl.8.in b/doc/nmstatectl.8.in
@@ -36,6 +36,7 @@ Query the current network state. \fIYAML\fR is the default output format. Use
 the \fB--json\fR argument to change the output format to \fIJSON\fR. To limit
 the output state to include certain interfaces only, please specify the
 interface name. Please be advised, global config like DNS will be included.
+\fBnmstatectl s\fR is an aliased command for \fBnmstatectl show\fR.
 .PP
 For multiple interface names, use comma to separate them. You can also use
 patterns for interface names:
@@ -65,6 +66,7 @@ Apply the network state from specified file in \fIYAML\fR or \fIJSON\fR format.
 By default, if the network state after state applied is not identical to the
 desired state, \fBnmstatectl\fR rollbacks to the state before \fBset\fR
 command. Use the \fB--no-verify\fR argument to skip the verification.
+\fBnmstatectl a\fR is an aliased command for \fBnmstatectl apply\fR.
 .RE
 .PP
 .B apply