xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-05 19:15:13 +00:00
Code Issues Releases Wiki Activity

Revise the man page of noderange. Describe the special characters need to be escaped more clear (#3651)

Browse Source
This commit is contained in:
Gᴏɴɢ Jie
2017-08-09 17:09:49 +08:00
committed by yangsong
parent b79d8cf473
commit 98f1e5c0a3
2 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/guides/admin-guides/references/man3/noderange.3.rst
View File

@@ -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**\
****************

11
xCAT-client/pods/man3/noderange.3.pod
View File

@@ -36,7 +36,11 @@ B<noderange> 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<noderange> should better be quoted with single quotes('') or double quotes("").
If you invoke xCAT B<noderange> from a shell you may need to quote the
B<noderange> if the shell would otherwise treat the punctuation marks in
the B<noderange> as control operators. The affected punctuation marks may
include Asterisk (`*'), Left Square Bracket (`[') , Right Square Bracket
(`]'), Circumflex Accent (`^'), and Overline (`~').
B<noderange> 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<Bugs>
The special characters used by xCAT B<noderange> are also special characters
to many shell programs. In particular, the characters `*', `[', `]', `^',
and `~' may have to be escaped from the shell.
=head1 B<SEE ALSO>