diff --git a/docs/source/guides/admin-guides/references/man1/lsdef.1.rst b/docs/source/guides/admin-guides/references/man1/lsdef.1.rst index e5585d61b..ef225afe2 100644 --- a/docs/source/guides/admin-guides/references/man1/lsdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsdef.1.rst @@ -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 ": ". - 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 "attrval" needs to be quoted. If the operator is "!~", the "attrval" 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 diff --git a/xCAT-client/pods/man1/lsdef.1.pod b/xCAT-client/pods/man1/lsdef.1.pod index ac677d0f1..92eecf203 100644 --- a/xCAT-client/pods/man1/lsdef.1.pod +++ b/xCAT-client/pods/man1/lsdef.1.pod @@ -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 or B instead. =item B<-c|--compress> Display information in compressed mode, each output line has format ": ". -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 or B 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 B<-w> I ... -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 to format the output. lsdef -t node -i status -c | xcoll