2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-07-08 13:55:37 +00:00

Remove trailing spaces in file xCAT-client/pods/man1/xdcp.1.pod

This commit is contained in:
GONG Jie
2017-12-31 23:59:59 +00:00
parent f31929b4b3
commit e2805aa282

View File

@ -6,12 +6,12 @@ B<xdcp> - Concurrently copies files to or from multiple nodes. In addition, prov
B<xdcp> I<noderange> [[B<-B> | B<--bypass>] [B<-f> I<fanout>] [B<-L>] [B<-l> I<userID>] [B<-o> I<node_options>] [B<-p>] [B<-P>] [B<-r> I<node_remote_shell>] [B<-R>] [B<-t> I<timeout>] [B<-T>] [B<-v>] [B<-q>] [B<-X> I<env_list>] I<sourcefile.... targetpath>
B<xdcp> I<noderange> [B<-F> I<rsync input file>]
B<xdcp> I<noderange> [B<-F> I<rsync input file>]
B<xdcp> I<computenoderange> [B<-s> B<-F> I<rsync input file>]
B<xdcp> I<computenoderange> [B<-s> B<-F> I<rsync input file>]
B<xdcp> [B<-i> I<path to install image>] [B<-F> I<rsync input file>]
B<xdcp> [B<-i> I<path to install image>] [B<-F> I<rsync input file>]
B<xdcp> [B<-h> | B<-V> | B<-q>]
@ -22,11 +22,11 @@ B<xdcp> [B<-h> | B<-V> | B<-q>]
The B<xdcp> command concurrently copies files to or from remote target
nodes. The command issues a remote copy command for each node or device specified. When files are pulled from a target, they are placed into the target_path with the name of the
remote node or device appended to the copied source_file name. The
/usr/bin/rcp command is the model for syntax and security.
/usr/bin/rcp command is the model for syntax and security.
If using hierarchy, then xdcp runs on the service node that is servicing the compute node. The file will first be copied to the path defined in the site table, SNsyncfiledir attribute, or the default path /var/xcat/syncfiles on the service node, if the attribute is not defined. The -P flag will not automatically copy
the files from the compute node to the Management node, hierarchically. There
is a two step process, see B<-P> flag.
If the Management Node is target node, it must be defined in the xCAT database with nodetype=mn. When the B<xdcp> command runs the Management Node as the target, it does not use remote commands but uses the local OS copy (B<cp>) command.
is a two step process, see B<-P> flag.
If the Management Node is target node, it must be defined in the xCAT database with nodetype=mn. When the B<xdcp> command runs the Management Node as the target, it does not use remote commands but uses the local OS copy (B<cp>) command.
B<REMOTE> B<USER>:
@ -86,7 +86,7 @@ file to on the target. If multiple source_file files, it specifies
the directory to copy the source_file files to on the target.
If the -P flag is specified, the target_path is the local host location
for the copied files. The remote file directory structure is recreated
under target_path and the remote target name is appended
under target_path and the remote target name is appended
to the copied source_file name in the target_path directory.
Note: the targetpath directory must exist.
@ -98,12 +98,12 @@ Runs in bypass mode, use if the xcatd daemon is hung.
Specifies a fanout value for the maximum number of concur-
rently executing remote shell processes. Serial execution
can be specified by indicating a fanout value of B<1>.
can be specified by indicating a fanout value of B<1>.
If B<-f> is not specified, a default fanout value of B<64> is used.
=item B<-F>|B<--File> I<rsync input file>
Specifies the path to the file that will be used to
Specifies the path to the file that will be used to
build the B<rsync> command.
The format of the input file is as follows, each line contains:
@ -131,16 +131,16 @@ For example:
B<Running postscripts after files are sync'd to the nodes>:
After you define the files to rsync, you can add an B<EXECUTE:> clause in the synclist file. The B<EXECUTE:> clause will list all the postscripts that you would like to run after the files are sync'd to the node.
After you define the files to rsync, you can add an B<EXECUTE:> clause in the synclist file. The B<EXECUTE:> clause will list all the postscripts that you would like to run after the files are sync'd to the node.
The postscript file must be of the form B<filename.post>, where the <filename>
is the <filename> is the from <filename>, reside in the same
directory as B<filename>, and be executable.
If the file B<filename> is rsync'd to the node, then the B<filename.post>
will automatically be run on the node.
If the file B<filename> is not updated on the node, the B<filename.post> will not be run.
If the file B<filename> is not updated on the node, the B<filename.post> will not be run.
Putting the B<filename.post> in the file list to rsync to the node is required
for hierarchical clusters. It is optional for non-hierarchical clusters.
for hierarchical clusters. It is optional for non-hierarchical clusters.
Another option is the B<EXECUTEALWAYS:> clause in the synclist file. The B<EXECUTEALWAYS:> will list all the postscripts that you would like to run after the files are sync'd to the nodes. These scripts will run whether or not any files are sync'd to the nodes. The scripts have no special format, but must contain the fully qualified path.
@ -160,11 +160,11 @@ For example, your rsynclist file may look like this:
EXECUTEALWAYS:
/tmp/myscript
If /tmp/file2 and /tmp/file3 update /tmp/file2 and /tmp/filex on the node, then the postscripts /tmp/file2.post and /tmp/file3.post are automatically run on
the node. /tmp/myscript will always be run on the node.
If /tmp/file2 and /tmp/file3 update /tmp/file2 and /tmp/filex on the node, then the postscripts /tmp/file2.post and /tmp/file3.post are automatically run on
the node. /tmp/myscript will always be run on the node.
Another option is the B<APPEND:> clause in the synclist file. The B<APPEND:> clause is used to append the contents of the input file to an existing file on the node. The file to append B<must> already exist on the node and not be part of the synclist that contains the B<APPEND:> clause.
Another option is the B<APPEND:> clause in the synclist file. The B<APPEND:> clause is used to append the contents of the input file to an existing file on the node. The file to append B<must> already exist on the node and not be part of the synclist that contains the B<APPEND:> clause.
For example, your rsynclist file may look like this:
@ -183,9 +183,9 @@ For example, your rsynclist file may look like this:
/etc/myappenddir/appendfile -> /etc/mysetup/setup
/etc/myappenddir/appendfile2 -> /etc/mysetup/setup2
When you use the append script, the file (left) of the arrow is appended to the file right of the arrow. In this example, /etc/myappenddir/appendfile is appended to /etc/mysetup/setup file, which must already exist on the node. The /opt/xcat/share/xcat/scripts/xdcpappend.sh is used to accomplish this.
When you use the append script, the file (left) of the arrow is appended to the file right of the arrow. In this example, /etc/myappenddir/appendfile is appended to /etc/mysetup/setup file, which must already exist on the node. The /opt/xcat/share/xcat/scripts/xdcpappend.sh is used to accomplish this.
Another option is the B<MERGE:> clause in the synclist file. The B<MERGE:> clause is used to append the contents of the input file to /etc/passwd, /etc/group, or /etc/shadow on a Linux node. It is only supported for those files and only on Linux. You must not use both the APPEND and MERGE funcion for these three files. The processing could end up not creating the file you desire. The MERGE function is the preferred method, becuase APPEND only adds to the file. MERGE will add to the file but also insure there are no duplicate entries.
Another option is the B<MERGE:> clause in the synclist file. The B<MERGE:> clause is used to append the contents of the input file to /etc/passwd, /etc/group, or /etc/shadow on a Linux node. It is only supported for those files and only on Linux. You must not use both the APPEND and MERGE funcion for these three files. The processing could end up not creating the file you desire. The MERGE function is the preferred method, becuase APPEND only adds to the file. MERGE will add to the file but also insure there are no duplicate entries.
For example, your rsynclist file may look like this:
/tmp/share/file2 -> /tmp/file2
@ -204,7 +204,7 @@ For example, your rsynclist file may look like this:
/custom/mygroups -> /etc/group
/custom/myshadow -> /etc/shadow
Note: no order can be assumed by the order that the EXECUTE,EXECUTEALWAYS and APPEND clause fall in the synclist file.
Note: no order can be assumed by the order that the EXECUTE,EXECUTEALWAYS and APPEND clause fall in the synclist file.
For more information on syncing files to node, read Sync-ing_Config_Files_to_Nodes
@ -243,8 +243,8 @@ them. When the B<-P> flag is used with the B<-R> flag, ._target is
appended to the directory. Only one file per invocation of the
xdcp pull command can be pulled from the specified targets.
Hierarchy is not automatically support yet. You must first pull
the file to the Service Node and then pull the file to the Management
node.
the file to the Service Node and then pull the file to the Management
node.
=item B<-q>|B<--show-config>
@ -275,13 +275,13 @@ parameter.
Will only sync the files listed in the synclist (B<-F>), to the service
nodes for the input compute node list. The files will be placed in the
directory defined by the site.SNsyncfiledir attribute, or the default
/var/xcat/syncfiles directory.
/var/xcat/syncfiles directory.
=item B<-t>|B<--timeout> I<timeout>
Specifies the time, in seconds, to wait for output from any
currently executing remote targets. If no output is
available from any target in the specified I<timeout>,
available from any target in the specified I<timeout>,
B<xdsh> displays an error and terminates execution for the remote
targets that failed to respond. If I<timeout> is not specified,
B<xdsh> waits indefinitely to continue processing output from
@ -298,7 +298,7 @@ messages to standard output during execution to each target.
Verifies each target before executing any remote commands
on the target. If a target is not responding, execution of
remote commands for the target is canceled.
remote commands for the target is canceled.
=item B<-V>|B<--version>
@ -380,7 +380,7 @@ get is bypassed.
The xdcp command exit code is 0, if the xdcp command executed without
errors and all remote copy commands finished with exit codes of 0. If
internal xdcp errors occur or the remote copy commands do not complete
successfully, the xdcp command exit value is greater than 0.
successfully, the xdcp command exit value is greater than 0.
@ -442,7 +442,7 @@ in the cluster, enter:
xdcp all /tmp/testdir/* /tmp/testdir
=item 6.
To copy all the files in /tmp/testdir and it's subdirectories
To copy all the files in /tmp/testdir and it's subdirectories
from the local host to node1 in the cluster, enter:
xdcp node1 -R /tmp/testdir /tmp/testdir
@ -454,7 +454,7 @@ To copy the /etc/hosts file from node1 and node2 to the
xdcp node1,node2 -P /etc/hosts /tmp/hosts.dir
=item 8.
To rsync the /etc/hosts file to your compute nodes:
To rsync the /etc/hosts file to your compute nodes:
Create a rsync file /tmp/myrsync, with this line:
@ -470,11 +470,11 @@ Run:
=item 9.
To rsync all the files in /home/mikev to the compute nodes:
To rsync all the files in /home/mikev to the compute nodes:
Create a rsync file /tmp/myrsync, with this line:
/home/mikev/* -> /home/mikev/ (last / is required)
/home/mikev/* -> /home/mikev/ (last / is required)
Run:
@ -483,13 +483,13 @@ Run:
=item 10.
To rsync to the compute nodes, using service nodes, the command will first
rsync the files to the /var/xcat/syncfiles directory on the service nodes and then rsync the files from that directory to the compute nodes. The /var/xcat/syncfiles default directory on the service nodes, can be changed by putting a directory value in the site table SNsyncfiledir attribute.
Create a rsync file /tmp/myrsync, with this line:
/etc/hosts /etc/passwd -> /etc
or
or
/etc/hosts /etc/passwd -> /etc/
@ -501,7 +501,7 @@ to update the Compute Nodes
=item 11.
To rsync to the service nodes in preparation for rsyncing the compute nodes
during an install from the service node.
during an install from the service node.
Create a rsync file /tmp/myrsync, with this line:
@ -511,10 +511,10 @@ Run:
xdcp compute -s -F /tmp/myrsync
to sync the service node for compute
to sync the service node for compute
=item 12.
To rsync the /etc/file1 and file2 to your compute nodes and rename to filex and filey:
To rsync the /etc/file1 and file2 to your compute nodes and rename to filex and filey:
Create a rsync file /tmp/myrsync, with these line:
@ -540,7 +540,7 @@ Run:
xdcp -i /install/netboot/fedora9/x86_64/compute/rootimg -F /tmp/myrsync
=item 14.
To define the Management Node in the database so you can use xdcp, run
To define the Management Node in the database so you can use xdcp, run
xcatconfig -m