From bac37dfa8d7fd7494ab8276777211e310f2bb6cf Mon Sep 17 00:00:00 2001 From: Jarrod Johnson Date: Thu, 8 Feb 2018 11:32:05 -0500 Subject: [PATCH] Update man page content Provide documentation on the nodeconfig command, and fix a typo --- confluent_client/doc/man/nodeconfig.ronn | 21 +++++++++++++++++++-- confluent_client/doc/man/nodesetboot.ronn | 2 +- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/confluent_client/doc/man/nodeconfig.ronn b/confluent_client/doc/man/nodeconfig.ronn index 8c899b4f..edabdfcb 100644 --- a/confluent_client/doc/man/nodeconfig.ronn +++ b/confluent_client/doc/man/nodeconfig.ronn @@ -3,8 +3,8 @@ nodeconfig(8) -- Show or change node configuration ## SYNOPSIS -`nodeconfig [..]` -`nodeconfig [..]` +`nodeconfig [options] [..]` +`nodeconfig [options] [..]` ## DESCRIPTION @@ -14,6 +14,23 @@ running configuration on the node firmware. Calling without '=' will show the current value, and '=' will change the value. Network information can be given as a node expression, as documented in the man page for nodeattribexpressions(5). +## OPTIONS + +* `-c`, `--comparedefault`: + Take the given settings and compare against default value, if available. If + no configuration values are specified, it will show only those that differ. + If combined with `-x`, will show all differing values except those indicated + by `-x` + +* `-x`, `--exclude`: + Rather than listing only the specified configuration parameters, list all + attributes except for the specified ones + +* `-d`, `--detail`: + Provide detailed data as available. This can include help text and valid + values for a setting. + + ## EXAMPLES * Showing the current IP configuration of noderange BMC/IMM/XCC: `# nodeconfig s3,s4 bmc` diff --git a/confluent_client/doc/man/nodesetboot.ronn b/confluent_client/doc/man/nodesetboot.ronn index 349a9a47..0fc881e1 100644 --- a/confluent_client/doc/man/nodesetboot.ronn +++ b/confluent_client/doc/man/nodesetboot.ronn @@ -4,7 +4,7 @@ nodesetboot(8) -- Check or set next boot device for noderange ## SYNOPSIS `nodesetboot ` -`nodesetboot [options] [default|cd|network|setup|hd]` +`nodesetboot [options] [default|cd|network|setup|hd]` ## DESCRIPTION