diff --git a/docs/source/guides/admin-guides/references/man3/noderange.3.rst b/docs/source/guides/admin-guides/references/man3/noderange.3.rst index 2505ae4ae..c172e5218 100644 --- a/docs/source/guides/admin-guides/references/man3/noderange.3.rst +++ b/docs/source/guides/admin-guides/references/man3/noderange.3.rst @@ -59,7 +59,11 @@ Name conveniently specify a list of nodes. The result is that the command will be applied to a range of nodes, often in parallel. -To avoid shell expansion, \ **noderange**\ should better be quoted with single quotes('') or double quotes(""). +If you invoke xCAT \ **noderange**\ from a shell you may need to quote the +\ **noderange**\ if the shell would otherwise treat the punctuation marks in +the \ **noderange**\ as control operators. The affected punctuation marks may +include Asterisk (\`*'), Left Square Bracket (\`[') , Right Square Bracket +(\`]'), Circumflex Accent (\`^'), and Overline (\`~'). \ **noderange**\ is a comma-separated list. Each token (text between commas) in the list can be any of the forms listed below: @@ -359,6 +363,14 @@ Example of \ **xCAT Node Name Format**\ node/group names: +************ +\ **Bugs**\ +************ + +The special characters used by xCAT \ **noderange**\ are also special characters +to many shell programs. In particular, the characters \`*', \`[', \`]', \`^', +and \`~' may have to be escaped from the shell. + **************** \ **SEE ALSO**\ **************** diff --git a/xCAT-client/pods/man3/noderange.3.pod b/xCAT-client/pods/man3/noderange.3.pod index ea2d4bf47..fad826bca 100644 --- a/xCAT-client/pods/man3/noderange.3.pod +++ b/xCAT-client/pods/man3/noderange.3.pod @@ -36,7 +36,11 @@ B is a syntax that can be used in most xCAT commands to conveniently specify a list of nodes. The result is that the command will be applied to a range of nodes, often in parallel. -To avoid shell expansion, B should better be quoted with single quotes('') or double quotes(""). +If you invoke xCAT B from a shell you may need to quote the +B if the shell would otherwise treat the punctuation marks in +the B as control operators. The affected punctuation marks may +include Asterisk (`*'), Left Square Bracket (`[') , Right Square Bracket +(`]'), Circumflex Accent (`^'), and Overline (`~'). B is a comma-separated list. Each token (text between commas) in the list can be any of the forms listed below: @@ -233,6 +237,11 @@ Generate a list of nodes in the 1st two frames: =back +=head1 B + +The special characters used by xCAT B are also special characters +to many shell programs. In particular, the characters `*', `[', `]', `^', +and `~' may have to be escaped from the shell. =head1 B