xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-02 19:40:10 +00:00
Code Issues Releases Wiki Activity

Merge pull request #5907 from gurevichmark/lsdef_man

Browse Source 
lsdef man page improvements
This commit is contained in:
Victor Hu 2018-12-20 15:00:58 -05:00 committed by GitHub
commit 109e08f37b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/source/guides/admin-guides/references/man1/lsdef.1.rst
View File

@ -49,15 +49,15 @@ OPTIONS
Display all definitions.
For performance consideration, the auditlog and eventlog objects will not be listed.
To list auditlog or eventlog objects, use lsdef -t auditlog or lsdef -t eventlog instead.
To list auditlog or eventlog objects, use \ **lsdef -t auditlog**\ or \ **lsdef -t eventlog**\ instead.
\ **-c|-**\ **-compress**\
Display information in compressed mode, each output line has format "<object name>: <data>".
The output can be passed to command xcoll or xdshbak for formatted output.
The -c flag must be used with -i flag.
The output can be passed to command \ **xcoll**\ or \ **xdshbak**\ for formatted output.
The \ **-c**\ flag must be used with \ **-i**\ flag.
@ -136,13 +136,18 @@ OPTIONS
\ **-w**\ \ *attr==val*\ \ **-w**\ \ *attr=~val*\ ...
Use one or multiple -w flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. Use the help option to get a list of valid attributes for each object type.
Use one or multiple \ **-w**\ flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. Use the help option to get a list of valid attributes for each object type.
Operator descriptions:
== Select nodes where the attribute value is exactly this value.
!= Select nodes where the attribute value is not this specific value.
=~ Select nodes where the attribute value matches this regular expression.
!~ Select nodes where the attribute value does not match this regular expression.
.. code-block:: perl
== Select nodes where the attribute value is exactly this value.
!= Select nodes where the attribute value is not this specific value.
=~ Select nodes where the attribute value matches this regular expression.
!~ Select nodes where the attribute value does not match this regular expression.
Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attr<operator>val" needs to be quoted. If the operator is "!~", the "attr<operator>val" needs to be quoted using single quote.
@ -150,7 +155,7 @@ OPTIONS
\ **-z|-**\ **-stanza**\
Display output in stanza format. See the xcatstanzafile man page for details on using xCAT stanza files.
Display output in stanza format. See the "xcatstanzafile" man page for details on using xCAT stanza files.
@ -191,8 +196,6 @@ EXAMPLES
.. code-block:: perl
lsdef
OR
lsdef -a
@ -350,7 +353,7 @@ EXAMPLES
15.
To list the nodes status and use xcoll to format the output.
To list the nodes status and use \ **xcoll**\ to format the output.
.. code-block:: perl

15
xCAT-client/pods/man1/lsdef.1.pod
View File

@ -28,13 +28,13 @@ in the xCAT database and xCAT object definition templates shipped in xCAT.
Display all definitions.
For performance consideration, the auditlog and eventlog objects will not be listed.
To list auditlog or eventlog objects, use lsdef -t auditlog or lsdef -t eventlog instead.
To list auditlog or eventlog objects, use B<lsdef -t auditlog> or B<lsdef -t eventlog> instead.
=item B<-c|--compress>
Display information in compressed mode, each output line has format "<object name>: <data>".
The output can be passed to command xcoll or xdshbak for formatted output.
The -c flag must be used with -i flag.
The output can be passed to command B<xcoll> or B<xdshbak> for formatted output.
The B<-c> flag must be used with B<-i> flag.
=item B<-h|--help>
@ -87,9 +87,10 @@ Verbose mode.
=item B<-w> I<attr==val> B<-w> I<attr=~val> ...
Use one or multiple -w flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. Use the help option to get a list of valid attributes for each object type.
Use one or multiple B<-w> flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. Use the help option to get a list of valid attributes for each object type.
Operator descriptions:
== Select nodes where the attribute value is exactly this value.
!= Select nodes where the attribute value is not this specific value.
=~ Select nodes where the attribute value matches this regular expression.
@ -99,7 +100,7 @@ Note: if the "val" fields includes spaces or any other characters that will be p
=item B<-z|--stanza>
Display output in stanza format. See the xcatstanzafile man page for details on using xCAT stanza files.
Display output in stanza format. See the "xcatstanzafile" man page for details on using xCAT stanza files.
=back
@ -126,8 +127,6 @@ when defining an xCAT node.
To get a list of all the objects that have been defined.
lsdef
OR
lsdef -a
=item 3.
@ -211,7 +210,7 @@ The hidden nodes are FSP/BPAs.
=item 15.
To list the nodes status and use xcoll to format the output.
To list the nodes status and use B<xcoll> to format the output.
lsdef -t node -i status -c | xcoll